github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_teams.yaml (about)

     1  openapi: 3.0.0
     2  info:
     3    description: ""
     4    version: "1.0"
     5    title: Engage Digital API
     6    termsOfService: https://developer.ringcentral.com
     7  tags:
     8    - name: Teams
     9  paths:
    10    /teams:
    11      get:
    12        tags:
    13          - Teams
    14        summary: Getting all teams
    15        operationId: getAllTeams
    16        description: This method renders teams ordered by creation date (ascending).
    17        parameters:
    18          - name: offset
    19            in: query
    20            description: The record index to start. Default value is 0.
    21            required: false
    22            schema:
    23              type: integer
    24              format: int32
    25          - name: limit
    26            in: query
    27            description: The max number of records to return. Default value is 30, max value
    28              is 150.
    29            required: false
    30            schema:
    31              type: string
    32              format: int32
    33        responses:
    34          "200":
    35            description: Success
    36            content:
    37              application/json:
    38                schema:
    39                  $ref: "#/components/schemas/GetAllTeamsResponse"
    40      post:
    41        tags:
    42          - Teams
    43        summary: Creating a team
    44        operationId: createTeam
    45        description: This method creates a new team. In case of success it renders the
    46          created tag, otherwise, it renders an error (422 HTTP code).
    47        parameters:
    48          - name: name
    49            description: Team name.
    50            in: query
    51            required: false
    52            schema:
    53              type: string
    54          - name: leader_ids[]
    55            description: List of user id as leaders
    56            in: query
    57            required: false
    58            explode: true
    59            schema:
    60              type: array
    61              items:
    62                type: string
    63          - name: user_ids[]
    64            description: List of user id as team members.
    65            in: query
    66            required: false
    67            explode: true
    68            schema:
    69              type: array
    70              items:
    71                type: string
    72        responses:
    73          "200":
    74            description: Success
    75            content:
    76              application/json:
    77                schema:
    78                  $ref: "#/components/schemas/Team"
    79    "/teams/{teamId}":
    80      get:
    81        tags:
    82          - Teams
    83        summary: Getting a team from its id
    84        operationId: getTeam
    85        description: This method renders a team from given id.
    86        parameters:
    87          - name: teamId
    88            in: path
    89            required: true
    90            schema:
    91              type: string
    92        responses:
    93          "200":
    94            description: Success
    95            content:
    96              application/json:
    97                schema:
    98                  $ref: "#/components/schemas/Team"
    99      put:
   100        tags:
   101          - Teams
   102        summary: Updating a team
   103        operationId: updateTeam
   104        description: This method updates an existing team from given attributes and renders
   105          it in case of success.
   106        parameters:
   107          - name: teamId
   108            in: path
   109            required: true
   110            schema:
   111              type: string
   112          - name: name
   113            description: Team name.
   114            in: query
   115            required: false
   116            schema:
   117              type: string
   118          - name: leader_ids[]
   119            description: List of user id as leaders
   120            in: query
   121            required: false
   122            explode: true
   123            schema:
   124              type: array
   125              items:
   126                type: string
   127          - name: user_ids[]
   128            description: List of user id as team members.
   129            in: query
   130            required: false
   131            explode: true
   132            schema:
   133              type: array
   134              items:
   135                type: string
   136        responses:
   137          "200":
   138            description: Success
   139            content:
   140              application/json:
   141                schema:
   142                  $ref: "#/components/schemas/Team"
   143      delete:
   144        tags:
   145          - Teams
   146        summary: Deleting a team
   147        operationId: deleteTeam
   148        description: This method destroys an existing team. It renders the team itself. It
   149          renders a 404 if id is invalid.
   150        parameters:
   151          - name: teamId
   152            in: path
   153            required: true
   154            schema:
   155              type: string
   156          - name: take_over_category_id
   157            in: query
   158            required: false
   159            description: ID of a category to recategorize (optional).
   160            schema:
   161              type: string
   162        responses:
   163          "200":
   164            description: Success
   165            content:
   166              application/json:
   167                schema:
   168                  $ref: "#/components/schemas/Team"
   169  servers:
   170    - url: https://DOMAIN.api.engagement.dimelo.com/1.0
   171  components:
   172    schemas:
   173      GetAllTeamsResponse:
   174        properties:
   175          count:
   176            type: integer
   177            format: int32
   178          limit:
   179            type: integer
   180            format: int32
   181          offset:
   182            type: integer
   183            format: int32
   184          records:
   185            type: array
   186            items:
   187              $ref: "#/components/schemas/Team"
   188      Team:
   189        required:
   190          - id
   191        properties:
   192          id:
   193            type: string
   194          created_at:
   195            type: string
   196            format: date-time
   197          updated_at:
   198            type: string
   199            format: date-time
   200          name:
   201            type: string
   202          leader_ids:
   203            type: array
   204            items:
   205              type: string
   206          user_ids:
   207            type: array
   208            items:
   209              type: string