# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Account Brands API
  version: 1.0.0
extends: openapi/docusign-accountbrands-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 13
- target: $.paths['/v2/accounts/{accountId}/brands'].get
  update:
    x-apievangelist-phrasing:
      intent: List brand profiles
      effect: read
      questions:
      - Which brand profiles are set up on my account?
      - Can I list brands without the distributor brand and include logos?
      instructions:
      - text: List the brand profiles for account {account}.
        slots:
          account: path.accountId
      - text: 'List brands for account {account} including logos: {include_logos}.'
        slots:
          account: path.accountId
          include_logos: query.include_logos
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a brand profile
      effect: write
      questions:
      - How do I create a new brand profile with my company name and colors?
      - Can I make a new brand the default for signing?
      instructions:
      - text: Create brand {brandName} for company {brandCompany} in account {account}.
        slots:
          brandName: requestBody.brandName
          brandCompany: requestBody.brandCompany
          account: path.accountId
      - text: Create a brand {brandName} in account {account} as the default sending brand.
        slots:
          brandName: requestBody.brandName
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several brand profiles at once
      effect: destructive
      questions:
      - How do I remove multiple brand profiles in one request?
      - Can I bulk delete old brands from my account?
      instructions:
      - text: Delete brands {brands} from account {account}.
        slots:
          brands: requestBody.brands
          account: path.accountId
      - text: Bulk remove the brand profiles {brands} in one request.
        slots:
          brands: requestBody.brands
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one brand profile
      effect: read
      questions:
      - What colors, logos and landing pages does a specific brand use?
      - Can I see the external references for a single brand?
      instructions:
      - text: Get brand {brand} in account {account}.
        slots:
          brand: path.brandId
          account: path.accountId
      - text: Show brand {brand} with external references {include_external_references}.
        slots:
          brand: path.brandId
          include_external_references: query.include_external_references
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a brand profile
      effect: write
      questions:
      - How do I rename an existing brand or change its colors?
      - Can I change the email content of a brand I already set up?
      instructions:
      - text: Rename brand {brand} in account {account} to {brandName}.
        slots:
          brand: path.brandId
          account: path.accountId
          brandName: requestBody.brandName
      - text: Update the colors of brand {brand} to {colors}.
        slots:
          brand: path.brandId
          colors: requestBody.colors
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one brand profile
      effect: destructive
      questions:
      - How do I delete a single brand by its ID?
      - What happens when I remove a brand from my account?
      instructions:
      - text: Delete brand {brand} from account {account}.
        slots:
          brand: path.brandId
          account: path.accountId
      - text: Remove the single brand {brand}.
        slots:
          brand: path.brandId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}/file'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a brand to a file
      effect: read
      questions:
      - Can I export a brand's configuration as a file?
      - How do I back up a brand so I can import it elsewhere?
      instructions:
      - text: Export brand {brand} from account {account}.
        slots:
          brand: path.brandId
          account: path.accountId
      - text: Download the export file for brand {brand}.
        slots:
          brand: path.brandId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand logo image
      effect: read
      questions:
      - How do I download the primary or email logo of a brand?
      - Which logo image is a brand using for a given logo type?
      instructions:
      - text: Get the {logoType} logo for brand {brand} in account {account}.
        slots:
          logoType: path.logoType
          brand: path.brandId
          account: path.accountId
      - text: Show me the {logoType} logo image of brand {brand}.
        slots:
          logoType: path.logoType
          brand: path.brandId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a brand logo
      effect: write
      questions:
      - Can I replace a brand's logo with a new image?
      - How do I upload a secondary logo for my brand?
      instructions:
      - text: Upload a new {logoType} logo to brand {brand} in account {account}.
        slots:
          logoType: path.logoType
          brand: path.brandId
          account: path.accountId
      - text: Replace brand {brand}'s {logoType} logo with my new image.
        slots:
          brand: path.brandId
          logoType: path.logoType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a brand logo
      effect: destructive
      questions:
      - How do I remove a logo from a brand?
      - Can I delete just the email logo and keep the others?
      instructions:
      - text: Delete the {logoType} logo from brand {brand} in account {account}.
        slots:
          logoType: path.logoType
          brand: path.brandId
          account: path.accountId
      - text: Strip the {logoType} logo off brand {brand}.
        slots:
          logoType: path.logoType
          brand: path.brandId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List a brand's resource files
      effect: read
      questions:
      - What branding resource files exist for a brand?
      - Can I see metadata for all resources attached to a brand?
      instructions:
      - text: List the branding resources for brand {brand} in account {account}.
        slots:
          brand: path.brandId
          account: path.accountId
      - text: Show resource file metadata for brand {brand}.
        slots:
          brand: path.brandId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a brand resource file
      effect: read
      questions:
      - How do I download the signing resource file for a brand?
      - Can I get a brand resource file in a specific language?
      instructions:
      - text: Download the {resourceContentType} resource file for brand {brand} in account {account}.
        slots:
          resourceContentType: path.resourceContentType
          brand: path.brandId
          account: path.accountId
      - text: Get brand {brand}'s {resourceContentType} resource in language {langcode}.
        slots:
          brand: path.brandId
          resourceContentType: path.resourceContentType
          langcode: query.langcode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a brand resource file
      effect: write
      questions:
      - Can I upload a custom XML resource file to change a brand's email text?
      - How do I replace a brand's sending resource file?
      instructions:
      - text: Upload XML resource file {file} as the {resourceContentType} resource of brand {brand} in account {account}.
        slots:
          file: requestBody.file.xml
          resourceContentType: path.resourceContentType
          brand: path.brandId
          account: path.accountId
      - text: Replace brand {brand}'s {resourceContentType} resource with XML file {file}.
        slots:
          brand: path.brandId
          resourceContentType: path.resourceContentType
          file: requestBody.file.xml
      method: generated
      generated: '2026-10-01'