Phrase Strings API Reference — Invitations

naftiko: 1.0.0-alpha2
info:
  label: Phrase Strings API Reference — Invitations
  description: 'Phrase Strings API Reference — Invitations. 7 operations. Lead operation: List invitations. Self-contained
    Naftiko capability covering one Phrase business surface.'
  tags:
  - Phrase
  - Invitations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PHRASE_API_KEY: PHRASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: strings-invitations
    baseUri: https://api.phrase.com/v2
    description: Phrase Strings API Reference — Invitations business capability. Self-contained, no shared references.
    resources:
    - name: accounts-account_id-invitations
      path: /accounts/{account_id}/invitations
      operations:
      - name: invitationslist
        method: GET
        description: List invitations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: invitationcreate
        method: POST
        description: Create a new invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: accounts-account_id-invitations-id
      path: /accounts/{account_id}/invitations/{id}
      operations:
      - name: invitationshow
        method: GET
        description: Get a single invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: invitationupdate
        method: PATCH
        description: Update an invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: invitationdelete
        method: DELETE
        description: Delete an invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accounts-account_id-invitations-id-resend
      path: /accounts/{account_id}/invitations/{id}/resend
      operations:
      - name: invitationresend
        method: POST
        description: Resend an invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects-project_id-invitations-id
      path: /projects/{project_id}/invitations/{id}
      operations:
      - name: invitationupdatesettings
        method: PATCH
        description: Update a member's invitation access
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.PHRASE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: strings-invitations-rest
    port: 8080
    description: REST adapter for Phrase Strings API Reference — Invitations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/accounts/{account-id}/invitations
      name: accounts-account-id-invitations
      description: REST surface for accounts-account_id-invitations.
      operations:
      - method: GET
        name: invitationslist
        description: List invitations
        call: strings-invitations.invitationslist
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: invitationcreate
        description: Create a new invitation
        call: strings-invitations.invitationcreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/accounts/{account-id}/invitations/{id}
      name: accounts-account-id-invitations-id
      description: REST surface for accounts-account_id-invitations-id.
      operations:
      - method: GET
        name: invitationshow
        description: Get a single invitation
        call: strings-invitations.invitationshow
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: invitationupdate
        description: Update an invitation
        call: strings-invitations.invitationupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: invitationdelete
        description: Delete an invitation
        call: strings-invitations.invitationdelete
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/accounts/{account-id}/invitations/{id}/resend
      name: accounts-account-id-invitations-id-resend
      description: REST surface for accounts-account_id-invitations-id-resend.
      operations:
      - method: POST
        name: invitationresend
        description: Resend an invitation
        call: strings-invitations.invitationresend
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/invitations/{id}
      name: projects-project-id-invitations-id
      description: REST surface for projects-project_id-invitations-id.
      operations:
      - method: PATCH
        name: invitationupdatesettings
        description: Update a member's invitation access
        call: strings-invitations.invitationupdatesettings
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: strings-invitations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Phrase Strings API Reference — Invitations. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-invitations
      description: List invitations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-invitations.invitationslist
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-invitation
      description: Create a new invitation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-invitations.invitationcreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-invitation
      description: Get a single invitation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-invitations.invitationshow
      outputParameters:
      - type: object
        mapping: $.
    - name: update-invitation
      description: Update an invitation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-invitations.invitationupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-invitation
      description: Delete an invitation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: strings-invitations.invitationdelete
      outputParameters:
      - type: object
        mapping: $.
    - name: resend-invitation
      description: Resend an invitation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-invitations.invitationresend
      outputParameters:
      - type: object
        mapping: $.
    - name: update-member-s-invitation-access
      description: Update a member's invitation access
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-invitations.invitationupdatesettings
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.