API Endpoints — subpackage_memberships

naftiko: 1.0.0-alpha2
info:
  label: API Endpoints — subpackage_memberships
  description: 'API Endpoints — subpackage_memberships. 5 operations. Lead operation: Create a membership. Self-contained
    Naftiko capability covering one Close business surface.'
  tags:
  - Close
  - subpackage_memberships
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CLOSE_API_KEY: CLOSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: close-subpackage-memberships
    baseUri: https://api.close.com/api/v1
    description: API Endpoints — subpackage_memberships business capability. Self-contained, no shared references.
    resources:
    - name: membership
      path: /membership/
      operations:
      - name: create
        method: POST
        description: Create a membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: bulkupdate
        method: PUT
        description: Bulk update memberships
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: membership-id
      path: /membership/{id}/
      operations:
      - name: update
        method: PUT
        description: Update a membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: membership-id-pinned_views
      path: /membership/{id}/pinned_views/
      operations:
      - name: getpinnedviews
        method: GET
        description: Get pinned views for a membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
      - name: updatepinnedviews
        method: PUT
        description: Update pinned views for a membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.CLOSE_API_KEY}}'
  exposes:
  - type: rest
    namespace: close-subpackage-memberships-rest
    port: 8080
    description: REST adapter for API Endpoints — subpackage_memberships. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/membership
      name: membership
      description: REST surface for membership.
      operations:
      - method: POST
        name: create
        description: Create a membership
        call: close-subpackage-memberships.create
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: bulkupdate
        description: Bulk update memberships
        call: close-subpackage-memberships.bulkupdate
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/membership/{id}
      name: membership-id
      description: REST surface for membership-id.
      operations:
      - method: PUT
        name: update
        description: Update a membership
        call: close-subpackage-memberships.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/membership/{id}/pinned-views
      name: membership-id-pinned-views
      description: REST surface for membership-id-pinned_views.
      operations:
      - method: GET
        name: getpinnedviews
        description: Get pinned views for a membership
        call: close-subpackage-memberships.getpinnedviews
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatepinnedviews
        description: Update pinned views for a membership
        call: close-subpackage-memberships.updatepinnedviews
        with:
          id: rest.id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: close-subpackage-memberships-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Endpoints — subpackage_memberships. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-membership
      description: Create a membership
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: close-subpackage-memberships.create
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bulk-update-memberships
      description: Bulk update memberships
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: close-subpackage-memberships.bulkupdate
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-membership
      description: Update a membership
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: close-subpackage-memberships.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-pinned-views-membership
      description: Get pinned views for a membership
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: close-subpackage-memberships.getpinnedviews
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-pinned-views-membership
      description: Update pinned views for a membership
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: close-subpackage-memberships.updatepinnedviews
      with:
        id: tools.id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.