# 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 Carrier Packages API
  version: 1.0.0
extends: openapi/optimizely-carrier-packages-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: 11
- target: $.paths['/api/v1/admin/CarrierPackages'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier package types
      effect: read
      questions:
      - How do I list the shipping package sizes defined for my carriers in Optimizely Configured Commerce?
      - Can I filter carrier packages to active ones and sort them by name?
      instructions:
      - text: List all carrier packages.
      - text: List carrier packages matching {filter} ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierPackages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a carrier package
      effect: write
      questions:
      - What dimensions and weight can I set on a new carrier package?
      - Can I tie a new shipping package to a specific carrier?
      instructions:
      - text: Create carrier package {name} for carrier {carrierId}.
        slots:
          name: requestBody.name
          carrierId: requestBody.carrierId
      - text: Add package {name} measuring {length} x {width} x {height} with weight {weight}.
        slots:
          name: requestBody.name
          length: requestBody.length
          width: requestBody.width
          height: requestBody.height
          weight: requestBody.weight
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierPackages({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one carrier package
      effect: read
      questions:
      - How can I see the dimensions of a single carrier package?
      - Which fields can I select when fetching one carrier package?
      instructions:
      - text: Show carrier package {id}.
        slots:
          id: path.id
      - text: Get carrier package {id} returning only {select}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierPackages({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a carrier package
      effect: write
      questions:
      - Can I overwrite a carrier package with a full new set of dimensions?
      - What's the call to replace a whole carrier package record?
      instructions:
      - text: Replace carrier package {id} with name {name} and weight {weight}.
        slots:
          id: path.id
          name: requestBody.name
          weight: requestBody.weight
      - text: Overwrite every field of carrier package {id}, naming it {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierPackages({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier package
      effect: destructive
      questions:
      - How do I delete one carrier package by ID?
      - Can I delete a carrier package only if it hasn't changed since I read it?
      instructions:
      - text: Delete carrier package {id}.
        slots:
          id: path.id
      - text: Delete carrier package {id} if its ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierPackages({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a carrier package's fields
      effect: write
      questions:
      - Can I deactivate a carrier package without resending its dimensions?
      - How do I change just the height of an existing package?
      instructions:
      - text: Patch carrier package {id} to set active to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      - text: Update carrier package {id} height to {height}.
        slots:
          id: path.id
          height: requestBody.height
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierPackages/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a carrier package
      effect: read
      questions:
      - What defaults are pre-filled for a carrier package before I create it?
      - Is there a blank carrier package template?
      instructions:
      - text: Get the default carrier package template.
      - text: Show pre-filled values for a new carrier package.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierPackages/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive carrier packages (OData action)
      effect: write
      questions:
      - Can I archive old carrier packages with the Default.archive POST action?
      - How do I archive packages instead of deleting them using a POST?
      instructions:
      - text: Archive carrier packages {ids} with the Default.archive action.
        slots:
          ids: query.ids
      - text: POST to the carrier package archive action for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/carrierpackages/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive carrier packages (DELETE route)
      effect: destructive
      questions:
      - Is there a DELETE carrierpackages/archive route for archiving packages?
      - Which endpoint archives carrier packages with the DELETE verb?
      instructions:
      - text: Archive carrier packages {ids} through the DELETE archive route.
        slots:
          ids: query.ids
      - text: Send a DELETE to carrierpackages/archive for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/carrierpackages/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several carrier packages
      effect: destructive
      questions:
      - Can I bulk delete carrier packages in one request?
      - How do I permanently remove a list of packages rather than archive them?
      instructions:
      - text: Bulk delete carrier packages {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove the carrier packages in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/carrierpackages({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a carrier package
      effect: read
      questions:
      - Can I read a custom property stored on a carrier package?
      - Where are extra custom attributes of a shipping package kept?
      instructions:
      - text: Get custom property {custompropertyKey} on carrier package {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show carrier package {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'