# 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 Budgets API
  version: 1.0.0
extends: openapi/optimizely-customer-budgets-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/CustomerBudgets'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer budgets
      effect: read
      questions:
      - How do I list the spending budgets set for B2B customers?
      - Can I filter customer budgets to a single fiscal year?
      instructions:
      - text: List all customer budgets.
      - text: List customer budgets matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerBudgets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a budget for a customer
      effect: write
      questions:
      - How do I set up a fiscal-year budget for a customer account?
      - Can a budget be assigned to a specific ship-to or user profile?
      instructions:
      - text: Create a {fiscalYear} budget for customer {customerId}.
        slots:
          fiscalYear: requestBody.fiscalYear
          customerId: requestBody.customerId
      - text: Create a budget for customer {customerId} with period 1 budget {period1Budget}.
        slots:
          customerId: requestBody.customerId
          period1Budget: requestBody.period1Budget
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerBudgets({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one customer budget
      effect: read
      questions:
      - How do I see a customer's budget versus actual spending by period?
      - Can I fetch one customer budget record by its id?
      instructions:
      - text: Get customer budget {id}.
        slots:
          id: path.id
      - text: Show budget and actual amounts for customer budget {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerBudgets({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a customer budget
      effect: write
      questions:
      - How do I overwrite an entire customer budget with new period figures?
      - Is there a full replace for a customer budget record?
      instructions:
      - text: Replace customer budget {id} for fiscal year {fiscalYear}.
        slots:
          id: path.id
          fiscalYear: requestBody.fiscalYear
      - text: Overwrite the whole customer budget record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerBudgets({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer budget
      effect: destructive
      questions:
      - How do I delete a single customer budget?
      - Can I delete a customer budget only if its ETag matches?
      instructions:
      - text: Delete customer budget {id}.
        slots:
          id: path.id
      - text: Delete customer budget {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/CustomerBudgets({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update selected periods of a customer budget
      effect: write
      questions:
      - How do I change the budget for just one period of a customer's year?
      - Can I record an actual spend amount on a customer budget without resending it all?
      instructions:
      - text: Set period 3 budget to {period3Budget} on customer budget {id}.
        slots:
          period3Budget: requestBody.period3Budget
          id: path.id
      - text: Record {period1Actual} as the period 1 actual on customer budget {id}.
        slots:
          period1Actual: requestBody.period1Actual
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerBudgets/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default customer budget record
      effect: read
      questions:
      - What does an empty customer budget look like before I fill it in?
      - Can I get the default values for a new customer budget?
      instructions:
      - text: Get the default customer budget record.
      - text: Show the template for a new customer budget.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerbudgets/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete customer budgets
      effect: destructive
      questions:
      - How do I delete several customer budgets at once?
      - Can I bulk remove customer budgets by ids?
      instructions:
      - text: Bulk delete customer budgets {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these customer budgets in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerbudgets({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a customer budget
      effect: read
      questions:
      - How do I read a custom property stored on a customer budget?
      - Can I fetch one extension property of a customer budget?
      instructions:
      - text: Get custom property {custompropertyKey} on customer budget {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom property {custompropertyKey} for customer budget {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'