Sonetel User API

openapi: 3.2.0
info:
  title: Sonetel User API
  version: '2.0'
  contact:
    name: Sonetel Developer Support
    email: dev.support@sonetel.com
    url: https://developer.sonetel.com
  termsOfService: https://sonetel.com/en/help/help-topics/terms-conditions/terms-conditions/
  description: 'Operations tagged User across 2 of this provider''s published API definitions: 7_users.yaml, sonetel-users-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://public-api.sonetel.com
  description: Production
security:
- Production: []
tags:
- name: User
paths:
  /user/{userid}/settings/data-mgr:
    get:
      summary: Fetch Users Data settings
      description: Fetch a user's data management settings.
      operationId: get-user-userid-ai-settings
      parameters:
      - name: data_categories
        in: query
        description: List of data categories that must be fetched. You may specific one or more using a comma separated list. If nothing is specified, all data categories are fetched
        schema:
          type: string
          examples:
          - meeting-minutes, call-summary
      - name: userid
        in: path
        description: The unique Id of the user
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/Get-user-data-settings'
      security:
      - Production: []
      servers:
      - url: https://public-api.sonetel.com
        description: Production
      x-internal: true
      tags:
      - User
    put:
      summary: Update User Data settings
      description: Update a user's data management settings
      operationId: put-user-userid-ai-settings
      parameters:
      - name: userid
        in: path
        description: The unique Id of the user
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Put-user-data-settings'
      responses:
        '200':
          $ref: '#/components/responses/Get-user-data-settings'
      security:
      - Production: []
      servers:
      - url: https://public-api.sonetel.com
        description: Production
      tags:
      - User
    servers:
    - url: https://public-api.sonetel.com
      description: Production
components:
  schemas:
    User-Data-settings:
      type: object
      title: User-Data-settings
      description: A user's Data settings
      properties:
        meeting-minutes:
          type: object
          description: 'Meeting minutes data settings.


            This includes the uploaded voice files used for generating AI meeting minutes and the Sonetel AI generated meeting minutes.'
          properties:
            auto_delete:
              type: string
              enum:
              - none
              - all
              - voice-files
              description: Specifies if `all` data or just `voice-files` must be automatically deleted
              default: none
            auto_delete_time:
              type: string
              enum:
              - immediate
              - 1m
              - 3m
              - 1y
              description: 'Specifies the time after which data must be deleted


                `immediate`: Delete immediately after the service data is generated


                `1m`: Delete 1 months after the service data is generated


                `3m`: Delete 3 months after the service data is generated


                `1y`: Delete 1 year after the service data is generated'
        call_summary:
          type: object
          description: 'Call recording data settings.


            This includes the voice call recordings generated by Sonetel telephony systems and the Sonetel AI generated call summaries, analysis and associated data.'
          properties:
            auto_delete:
              type: string
              enum:
              - none
              - all
              - voice-files
              - summary
              description: Specifies if `all` data or just `voice-files` or just `summary` must be automatically deleted
            auto_delete_time:
              type: string
              enum:
              - immediate
              - 1m
              - 3m
              - 1y
              description: 'Specifies the time after which data must be deleted


                `immediate`: Delete immediately after the service data is generated


                `1m`: Delete 1 months after the service data is generated


                `3m`: Delete 3 months after the service data is generated


                `1y`: Delete 1 year after the service data is generated'
      x-internal: true
  responses:
    Get-user-data-settings:
      description: User's Data management settings
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/User-Data-settings'
  requestBodies:
    Put-user-data-settings:
      description: 'User AI settings. Only the changes to settings can be sent

        `meeting-minutes`: If `auto_delete` is set to a value other than `none`, the `auto_delete_time` must be specified'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/User-Data-settings'
  securitySchemes:
    Production:
      type: oauth2
      flows:
        password:
          refreshUrl: https://api.sonetel.com/SonetelAuth/beta/oauth/token
          tokenUrl: https://api.sonetel.com/SonetelAuth/beta/oauth/token
          scopes: {}
x-refined-from:
- 7_users.yaml
- sonetel-users-openapi.yml