# 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 Carriers API
  version: 1.0.0
extends: openapi/optimizely-customer-carriers-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/CustomerCarriers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer shipping carrier assignments
      effect: read
      questions:
      - Which shipping carriers are assigned to which customers?
      - Can I filter customer carrier assignments to a single customer?
      - How many customer-to-carrier links do we have?
      instructions:
      - text: List all customer carrier assignments.
      - text: List customer carriers matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} customer carrier assignments with a total count.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerCarriers'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a shipping carrier to a customer
      effect: write
      questions:
      - How do I restrict a customer to ship with a particular carrier?
      - Can I link a carrier to a customer account through the admin API?
      instructions:
      - text: Assign carrier {carrierId} to customer {customerId}.
        slots:
          carrierId: requestBody.carrierId
          customerId: requestBody.customerId
      - text: Let customer {customerId} ship using carrier {carrierId}.
        slots:
          customerId: requestBody.customerId
          carrierId: requestBody.carrierId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerCarriers({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer carrier assignment
      effect: read
      questions:
      - Can I look up a single customer carrier link by its id?
      - Which customer and carrier does a given assignment connect?
      instructions:
      - text: Get customer carrier assignment {id}.
        slots:
          id: path.id
      - text: Show the customer and carrier on assignment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerCarriers({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a customer carrier assignment
      effect: write
      questions:
      - Can I fully rewrite a customer carrier assignment in one request?
      - Does replacing a customer carrier record clear omitted fields?
      instructions:
      - text: Replace customer carrier assignment {id} with customer {customerId} and carrier {carrierId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
          carrierId: requestBody.carrierId
      - text: Overwrite the complete customer carrier record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerCarriers({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a carrier from a customer
      effect: destructive
      questions:
      - How do I stop a customer from using a carrier they were assigned?
      - Can I make the customer carrier delete conditional on an ETag?
      instructions:
      - text: Delete customer carrier assignment {id}.
        slots:
          id: path.id
      - text: Remove customer carrier link {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerCarriers({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the carrier on a customer assignment
      effect: write
      questions:
      - Can I swap the carrier on an existing customer assignment without recreating it?
      - Is a partial update allowed on customer carrier records?
      instructions:
      - text: Change the carrier on assignment {id} to {carrierId}.
        slots:
          id: path.id
          carrierId: requestBody.carrierId
      - text: Patch customer carrier {id} to belong to customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerCarriers/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the customer carriers Default function
      effect: read
      questions:
      - What does the Default function on customer carriers return?
      - Is there a default customer carrier entry to fetch?
      instructions:
      - text: Call the Default function on customer carriers.
      - text: Fetch the default customer carrier result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customercarriers/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete customer carrier assignments
      effect: destructive
      questions:
      - Can I drop several customer carrier assignments at once?
      - Is there a bulk delete by id list for customer carriers?
      instructions:
      - text: Delete customer carrier assignments {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove the customer carrier links {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customercarriers({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a customer carrier
      effect: read
      questions:
      - Can I read a custom property stored on a customer carrier assignment?
      - Where do custom values for a customer's carrier link live?
      instructions:
      - text: Get custom property {custompropertyKey} of customer carrier {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom value {custompropertyKey} on customer carrier assignment {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'