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

     1  {
     2    "openapi": "3.0.0",
     3    "info": {
     4      "description": "",
     5      "version": "1.0",
     6      "title": "Engage Digital API",
     7      "termsOfService": "https://developer.ringcentral.com"
     8    },
     9    "tags": [
    10      {
    11        "name": "Teams"
    12      }
    13    ],
    14    "paths": {
    15      "/teams": {
    16        "get": {
    17          "tags": [
    18            "Teams"
    19          ],
    20          "summary": "Getting all teams",
    21          "operationId": "getAllTeams",
    22          "description": "This method renders teams ordered by creation date (ascending).",
    23          "parameters": [
    24            {
    25              "name": "offset",
    26              "in": "query",
    27              "description": "The record index to start. Default value is 0.",
    28              "required": false,
    29              "schema": {
    30                "type": "integer",
    31                "format": "int32"
    32              }
    33            },
    34            {
    35              "name": "limit",
    36              "in": "query",
    37              "description": "The max number of records to return. Default value is 30, max value is 150.",
    38              "required": false,
    39              "schema": {
    40                "type": "integer",
    41                "format": "int32"
    42              }
    43            }
    44          ],
    45          "responses": {
    46            "200": {
    47              "description": "Success",
    48              "content": {
    49                "application/json": {
    50                  "schema": {
    51                    "$ref": "#/components/schemas/GetAllTeamsResponse"
    52                  }
    53                }
    54              }
    55            }
    56          }
    57        },
    58        "post": {
    59          "tags": [
    60            "Teams"
    61          ],
    62          "summary": "Creating a team",
    63          "operationId": "createTeam",
    64          "description": "This method creates a new team. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).",
    65          "parameters": [
    66            {
    67              "name": "name",
    68              "description": "Team name.",
    69              "in": "query",
    70              "required": false,
    71              "schema": {
    72                "type": "string"
    73              }
    74            },
    75            {
    76              "name": "leader_ids[]",
    77              "description": "List of user id as leaders",
    78              "in": "query",
    79              "required": false,
    80              "explode": true,
    81              "schema": {
    82                "type": "array",
    83                "items": {
    84                  "type": "string"
    85                }
    86              }
    87            },
    88            {
    89              "name": "user_ids[]",
    90              "description": "List of user id as team members.",
    91              "in": "query",
    92              "required": false,
    93              "explode": true,
    94              "schema": {
    95                "type": "array",
    96                "items": {
    97                  "type": "string"
    98                }
    99              }
   100            }
   101          ],
   102          "responses": {
   103            "200": {
   104              "description": "Success",
   105              "content": {
   106                "application/json": {
   107                  "schema": {
   108                    "$ref": "#/components/schemas/Team"
   109                  }
   110                }
   111              }
   112            }
   113          }
   114        }
   115      },
   116      "/teams/{teamId}": {
   117        "get": {
   118          "tags": [
   119            "Teams"
   120          ],
   121          "summary": "Getting a team from its id",
   122          "operationId": "getTeam",
   123          "description": "This method renders a team from given id.",
   124          "parameters": [
   125            {
   126              "name": "teamId",
   127              "in": "path",
   128              "required": true,
   129              "schema": {
   130                "type": "string"
   131              }
   132            }
   133          ],
   134          "responses": {
   135            "200": {
   136              "description": "Success",
   137              "content": {
   138                "application/json": {
   139                  "schema": {
   140                    "$ref": "#/components/schemas/Team"
   141                  }
   142                }
   143              }
   144            }
   145          }
   146        },
   147        "put": {
   148          "tags": [
   149            "Teams"
   150          ],
   151          "summary": "Updating a team",
   152          "operationId": "updateTeam",
   153          "description": "This method updates an existing team from given attributes and renders it in case of success.",
   154          "parameters": [
   155            {
   156              "name": "teamId",
   157              "in": "path",
   158              "required": true,
   159              "schema": {
   160                "type": "string"
   161              }
   162            },
   163            {
   164              "name": "name",
   165              "description": "Team name.",
   166              "in": "query",
   167              "required": false,
   168              "schema": {
   169                "type": "string"
   170              }
   171            },
   172            {
   173              "name": "leader_ids[]",
   174              "description": "List of user id as leaders",
   175              "in": "query",
   176              "required": false,
   177              "explode": true,
   178              "schema": {
   179                "type": "array",
   180                "items": {
   181                  "type": "string"
   182                }
   183              }
   184            },
   185            {
   186              "name": "user_ids[]",
   187              "description": "List of user id as team members.",
   188              "in": "query",
   189              "required": false,
   190              "explode": true,
   191              "schema": {
   192                "type": "array",
   193                "items": {
   194                  "type": "string"
   195                }
   196              }
   197            }
   198          ],
   199          "responses": {
   200            "200": {
   201              "description": "Success",
   202              "content": {
   203                "application/json": {
   204                  "schema": {
   205                    "$ref": "#/components/schemas/Team"
   206                  }
   207                }
   208              }
   209            }
   210          }
   211        },
   212        "delete": {
   213          "tags": [
   214            "Teams"
   215          ],
   216          "summary": "Deleting a team",
   217          "operationId": "deleteTeam",
   218          "description": "This method destroys an existing team. It renders the team itself. It renders a 404 if id is invalid.",
   219          "parameters": [
   220            {
   221              "name": "teamId",
   222              "in": "path",
   223              "required": true,
   224              "schema": {
   225                "type": "string"
   226              }
   227            },
   228            {
   229              "name": "take_over_category_id",
   230              "in": "query",
   231              "required": false,
   232              "description": "ID of a category to recategorize (optional).",
   233              "schema": {
   234                "type": "string"
   235              }
   236            }
   237          ],
   238          "responses": {
   239            "200": {
   240              "description": "Success",
   241              "content": {
   242                "application/json": {
   243                  "schema": {
   244                    "$ref": "#/components/schemas/Team"
   245                  }
   246                }
   247              }
   248            }
   249          }
   250        }
   251      }
   252    },
   253    "servers": [
   254      {
   255        "url": "https://DOMAIN.api.engagement.dimelo.com/1.0"
   256      }
   257    ],
   258    "components": {
   259      "schemas": {
   260        "GetAllTeamsResponse": {
   261          "properties": {
   262            "count": {
   263              "type": "integer",
   264              "format": "int32"
   265            },
   266            "limit": {
   267              "type": "integer",
   268              "format": "int32"
   269            },
   270            "offset": {
   271              "type": "integer",
   272              "format": "int32"
   273            },
   274            "records": {
   275              "type": "array",
   276              "items": {
   277                "$ref": "#/components/schemas/Team"
   278              }
   279            }
   280          }
   281        },
   282        "Team": {
   283          "required": [
   284            "id"
   285          ],
   286          "properties": {
   287            "id": {
   288              "type": "string"
   289            },
   290            "created_at": {
   291              "type": "string",
   292              "format": "date-time"
   293            },
   294            "updated_at": {
   295              "type": "string",
   296              "format": "date-time"
   297            },
   298            "name": {
   299              "type": "string"
   300            },
   301            "leader_ids": {
   302              "type": "array",
   303              "items": {
   304                "type": "string"
   305              }
   306            },
   307            "user_ids": {
   308              "type": "array",
   309              "items": {
   310                "type": "string"
   311              }
   312            }
   313          }
   314        }
   315      }
   316    }
   317  }