github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_folders.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": "Folders"
    12        }
    13      ],
    14      "paths": {
    15        "/folders": {
    16          "get": {
    17            "tags": [
    18              "Folders"
    19            ],
    20            "summary": "Getting all folders",
    21            "operationId": "getAllFolders",
    22            "description": "This method renders folders.",
    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/GetAllFoldersResponse"
    52                    }
    53                  }
    54                }
    55              }
    56            }
    57          },
    58          "post": {
    59            "tags": [
    60              "Folders"
    61            ],
    62            "summary": "Creating a folder",
    63            "operationId": "createFolder",
    64            "description": "This method creates a new folder. In case of success it renders the created folder, otherwise an error (422 HTTP code).",
    65            "parameters": [
    66              {
    67                "name": "label",
    68                "description": "Folder’s label (mandatory).",
    69                "in": "query",
    70                "required": false,
    71                "schema": {
    72                  "type": "string"
    73                }
    74              },
    75              {
    76                "name": "parent_id",
    77                "description": "ID of the parent folder.",
    78                "in": "query",
    79                "required": false,
    80                "schema": {
    81                  "type": "string"
    82                }
    83              },
    84              {
    85                "name": "position",
    86                "description": "position of the folder. ",
    87                "in": "query",
    88                "required": false,
    89                "schema": {
    90                  "type": "integer"
    91                }
    92              },
    93              {
    94                "name": "query",
    95                "description": "query of the folder as described in ​Search API documentation.​\\n\\nExample: “​active_and_assigned_to_me:true”",
    96                "in": "query",
    97                "required": false,
    98                "schema": {
    99                  "type": "string"
   100                }
   101              },
   102              {
   103                "name": "render_threads_count",
   104                "description": "boolean describing display of the number of threads. ",
   105                "in": "query",
   106                "required": false,
   107                "schema": {
   108                  "type": "boolean"
   109                }
   110              },
   111              {
   112                "name": "role_restriction[only][]",
   113                "description": "list of roles allowed to see this folder. This parameter has to be a hash otherwise it will raise a 400 error. The key should be \"only\". For example: `&role_restriction[only][]=4e5596cdae70f677b5000002`",
   114                "in": "query",
   115                "required": false,
   116                "schema": {
   117                  "type": "array",
   118                  "items": {
   119                    "type": "string"
   120                  }
   121                }
   122              },
   123              {
   124                "name": "team_restriction[only][]",
   125                "description": "list of teams allowed to see this folder. Same thing as role_restriction: team_restriction parameter has to be a hash with the key \"only\".",
   126                "in": "query",
   127                "required": false,
   128                "schema": {
   129                  "type": "array",
   130                  "items": {
   131                    "type": "string"
   132                  }
   133                }
   134              }
   135            ],
   136            "responses": {
   137              "200": {
   138                "description": "Success",
   139                "content": {
   140                  "application/json": {
   141                    "schema": {
   142                      "$ref": "#/components/schemas/Folder"
   143                    }
   144                  }
   145                }
   146              }
   147            }
   148          }
   149        },
   150        "/folders/{folderId}": {
   151          "get": {
   152            "tags": [
   153              "Folders"
   154            ],
   155            "summary": "Getting a folder from its id",
   156            "operationId": "getFolder",
   157            "description": "This method renders a folder from given id.",
   158            "parameters": [
   159              {
   160                "name": "folderId",
   161                "in": "path",
   162                "required": true,
   163                "schema": {
   164                  "type": "string"
   165                }
   166              }
   167            ],
   168            "responses": {
   169              "200": {
   170                "description": "Success",
   171                "content": {
   172                  "application/json": {
   173                    "schema": {
   174                      "$ref": "#/components/schemas/Folder"
   175                    }
   176                  }
   177                }
   178              }
   179            }
   180          },
   181          "put": {
   182            "tags": [
   183              "Folders"
   184            ],
   185            "summary": "Updating a folder",
   186            "operationId": "updateFolder",
   187            "description": "This method updates an existing folder from given attributes and renders it in case of success.",
   188            "parameters": [
   189              {
   190                "name": "folderId",
   191                "in": "path",
   192                "required": true,
   193                "schema": {
   194                  "type": "string"
   195                }
   196              },
   197              {
   198                "name": "label",
   199                "description": "Folder’s label (mandatory).",
   200                "in": "query",
   201                "required": false,
   202                "schema": {
   203                  "type": "string"
   204                }
   205              },
   206              {
   207                "name": "parent_id",
   208                "description": "ID of the parent folder.",
   209                "in": "query",
   210                "required": false,
   211                "schema": {
   212                  "type": "string"
   213                }
   214              },
   215              {
   216                "name": "position",
   217                "description": "position of the folder. ",
   218                "in": "query",
   219                "required": false,
   220                "schema": {
   221                  "type": "integer"
   222                }
   223              },
   224              {
   225                "name": "query",
   226                "description": "query of the folder as described in ​Search API documentation.​\\n\\nExample: “​active_and_assigned_to_me:true”",
   227                "in": "query",
   228                "required": false,
   229                "schema": {
   230                  "type": "string"
   231                }
   232              },
   233              {
   234                "name": "render_threads_count",
   235                "description": "boolean describing display of the number of threads. ",
   236                "in": "query",
   237                "required": false,
   238                "schema": {
   239                  "type": "boolean"
   240                }
   241              },
   242              {
   243                "name": "role_restriction[only][]",
   244                "description": "list of roles allowed to see this folder. This parameter has to be a hash otherwise it will raise a 400 error. The key should be \"only\". For example: `&role_restriction[only][]=4e5596cdae70f677b5000002`",
   245                "in": "query",
   246                "required": false,
   247                "schema": {
   248                  "type": "array",
   249                  "items": {
   250                    "type": "string"
   251                  }
   252                }
   253              },
   254              {
   255                "name": "team_restriction[only][]",
   256                "description": "list of teams allowed to see this folder. Same thing as role_restriction: team_restriction parameter has to be a hash with the key \"only\".",
   257                "in": "query",
   258                "required": false,
   259                "schema": {
   260                  "type": "array",
   261                  "items": {
   262                    "type": "string"
   263                  }
   264                }
   265              }
   266            ],
   267            "responses": {
   268              "200": {
   269                "description": "Success",
   270                "content": {
   271                  "application/json": {
   272                    "schema": {
   273                      "$ref": "#/components/schemas/Folder"
   274                    }
   275                  }
   276                }
   277              }
   278            }
   279          },
   280          "delete": {
   281            "tags": [
   282              "Folders"
   283            ],
   284            "summary": "Deleting a folder",
   285            "operationId": "deleteFolder",
   286            "description": "This method destroys an existing folder. It renders the folder itself. It renders a 404 if id is invalid.",
   287            "parameters": [
   288              {
   289                "name": "folderId",
   290                "in": "path",
   291                "required": true,
   292                "schema": {
   293                  "type": "string"
   294                }
   295              }
   296            ],
   297            "responses": {
   298              "200": {
   299                "description": "Success",
   300                "content": {
   301                  "application/json": {
   302                    "schema": {
   303                      "$ref": "#/components/schemas/Folder"
   304                    }
   305                  }
   306                }
   307              }
   308            }
   309          }
   310        }
   311      },
   312      "servers": [
   313        {
   314          "url": "https://DOMAIN.api.engagement.dimelo.com/1.0"
   315        }
   316      ],
   317      "components": {
   318        "schemas": {
   319          "GetAllFoldersResponse": {
   320            "properties": {
   321              "count": {
   322                "type": "integer",
   323                "format": "int32"
   324              },
   325              "limit": {
   326                "type": "integer",
   327                "format": "int32"
   328              },
   329              "offset": {
   330                "type": "integer",
   331                "format": "int32"
   332              },
   333              "records": {
   334                "type": "array",
   335                "items": {
   336                  "$ref": "#/components/schemas/Folder"
   337                }
   338              }
   339            }
   340          },
   341          "Folder": {
   342            "required": [
   343              "id"
   344            ],
   345            "properties": {
   346              "id": {
   347                "type": "string"
   348              },
   349              "created_at": {
   350                "type": "string",
   351                "format": "date-time"
   352              },
   353              "updated_at": {
   354                "type": "string",
   355                "format": "date-time"
   356              },
   357              "label": {
   358                "type": "string"
   359              },
   360              "parent_id": {
   361                "type": "string"
   362              },
   363              "position": {
   364                "type": "integer"
   365              },
   366              "query": {
   367                "type": "string"
   368              },
   369              "render_threads_count": {
   370                "type": "boolean"
   371              },
   372              "role_restriction": {
   373                "$ref": "#/components/schemas/Restriction"
   374              }
   375            }
   376          },
   377          "Restriction": {
   378            "properties": {
   379              "only": {
   380                "type": "array",
   381                "items": {
   382                  "type": "string"
   383                }
   384              }
   385            }
   386          }
   387        }
   388      }
   389    }