github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_categories.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":"Categories"
    12        }
    13      ],
    14      "paths":{
    15        "/categories":{
    16          "get":{
    17            "tags":[
    18              "Categories"
    19            ],
    20            "summary":"Getting all categories",
    21            "operationId":"getAllCategories",
    22            "description":"This method renders categories ordered by creation date (ascending).",
    23            "parameters":[
    24              {
    25                "name":"parent_id",
    26                "in":"query",
    27                "description":"To filter categories on given category parent id.",
    28                "required":false,
    29                "schema":{
    30                  "type":"string"
    31                }
    32              },
    33              {
    34                "name":"offset",
    35                "in":"query",
    36                "description":"The record index to start. Default value is 0.",
    37                "required":false,
    38                "schema":{
    39                  "type":"integer",
    40                  "format":"int32"
    41                }
    42              },
    43              {
    44                "name":"limit",
    45                "in":"query",
    46                "description":"The max number of records to return. Default value is 30, max value is 150.",
    47                "required":false,
    48                "schema":{
    49                  "type":"integer",
    50                  "format":"int32"
    51                }
    52              }
    53            ],
    54            "responses":{
    55              "200":{
    56                "description":"Success",
    57                "content":{
    58                  "application/json":{
    59                    "schema":{
    60                      "$ref":"#/components/schemas/GetAllCategoriesResponse"
    61                    }
    62                  }
    63                }
    64              }
    65            }
    66          },
    67          "post":{
    68            "tags":[
    69              "Categories"
    70            ],
    71            "summary":"Creating a category",
    72            "operationId":"createCategory",
    73            "description":"This method creates a new team. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).\n\nNote: The fields ​`mandatory`,​ `​multiple`,​ ​`post_qualification​`, `s​ource_ids`​ and `u​nselectable​` are accounted for only if the Category has no parent.\n\nAuthorization​: only users that can manage teams.",
    74            "parameters":[
    75              {
    76                "name":"name",
    77                "in":"query",
    78                "required":false,
    79                "description":"Category name.",
    80                "schema":{
    81                  "type":"string"
    82                }
    83              },
    84              {
    85                "name":"parent_id",
    86                "in":"query",
    87                "required":false,
    88                "description":"ID of parent category.",
    89                "schema":{
    90                  "type":"string"
    91                }
    92              },
    93              {
    94                "name":"color",
    95                "in":"query",
    96                "required":false,
    97                "description":"displayed color for the category, see Category colors. ",
    98                "schema":{
    99                  "type":"integer",
   100                  "enum":[
   101                    0,
   102                    1,
   103                    2,
   104                    3,
   105                    4,
   106                    5,
   107                    6
   108                  ]
   109                }
   110              },
   111              {
   112                "name":"mandatory",
   113                "in":"query",
   114                "required":false,
   115                "description":"mandatory categorization (Boolean).",
   116                "schema":{
   117                  "type":"boolean"
   118                }
   119              },
   120              {
   121                "name":"multiple",
   122                "in":"query",
   123                "required":false,
   124                "description":"allow to assign multiple child categories (Boolean).",
   125                "schema":{
   126                  "type":"boolean"
   127                }
   128              },
   129              {
   130                "name":"post_qualification",
   131                "in":"query",
   132                "required":false,
   133                "description":"post qualification (Boolean).",
   134                "schema":{
   135                  "type":"boolean"
   136                }
   137              },
   138              {
   139                "name":"unselectable",
   140                "in":"query",
   141                "required":false,
   142                "description":"root category is unselectable (Boolean).",
   143                "schema":{
   144                  "type":"boolean"
   145                }
   146              },
   147              {
   148                "name":"source_ids[]",
   149                "in":"query",
   150                "required":false,
   151                "description":"List of source id.",
   152                "schema":{
   153                  "type":"array",
   154                  "items":{
   155                    "type":"string"
   156                  }
   157                }
   158              }
   159            ],
   160            "responses":{
   161              "200":{
   162                "description":"Success",
   163                "content":{
   164                  "application/json":{
   165                    "schema":{
   166                      "$ref":"#/components/schemas/Category"
   167                    }
   168                  }
   169                }
   170              }
   171            }
   172          }
   173        },
   174        "/categories/{categoryId}":{
   175          "get":{
   176            "tags":[
   177              "Categories"
   178            ],
   179            "summary":"Getting a category from its id",
   180            "operationId":"getCategory",
   181            "description":"This method renders a category from given id.",
   182            "parameters":[
   183              {
   184                "name":"categoryId",
   185                "in":"path",
   186                "required":true,
   187                "schema":{
   188                  "type":"string"
   189                }
   190              }
   191            ],
   192            "responses":{
   193              "200":{
   194                "description":"Success",
   195                "content":{
   196                  "application/json":{
   197                    "schema":{
   198                      "$ref":"#/components/schemas/Category"
   199                    }
   200                  }
   201                }
   202              }
   203            }
   204          },
   205          "put":{
   206            "tags":[
   207              "Categories"
   208            ],
   209            "summary":"Updating a category",
   210            "operationId":"updateCategory",
   211            "description":"This method creates a new team. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).\n\nNote: The fields ​`mandatory`,​ ​`multiple`,​ ​`post_qualification​`, `s​ource_ids​` and `u​nselectable​` are accounted for only if the Category has no parent.\n\nAuthorization​: only users that can manage teams.",
   212            "parameters":[
   213              {
   214                "name":"categoryId",
   215                "in":"path",
   216                "required":true,
   217                "schema":{
   218                  "type":"string"
   219                }
   220              },
   221              {
   222                "name":"name",
   223                "in":"query",
   224                "required":false,
   225                "description":"Category name.",
   226                "schema":{
   227                  "type":"string"
   228                }
   229              },
   230              {
   231                "name":"parent_id",
   232                "in":"query",
   233                "required":false,
   234                "description":"ID of parent category.",
   235                "schema":{
   236                  "type":"string"
   237                }
   238              },
   239              {
   240                "name":"color",
   241                "in":"query",
   242                "required":false,
   243                "description":"displayed color for the category, see Category colors. ",
   244                "schema":{
   245                  "type":"integer"
   246                }
   247              },
   248              {
   249                "name":"mandatory",
   250                "in":"query",
   251                "required":false,
   252                "description":"mandatory categorization (Boolean).",
   253                "schema":{
   254                  "type":"boolean"
   255                }
   256              },
   257              {
   258                "name":"multiple",
   259                "in":"query",
   260                "required":false,
   261                "description":"allow to assign multiple child categories (Boolean).",
   262                "schema":{
   263                  "type":"boolean"
   264                }
   265              },
   266              {
   267                "name":"post_qualification",
   268                "in":"query",
   269                "required":false,
   270                "description":"post qualification (Boolean).",
   271                "schema":{
   272                  "type":"boolean"
   273                }
   274              },
   275              {
   276                "name":"unselectable",
   277                "in":"query",
   278                "required":false,
   279                "description":"root category is unselectable (Boolean).",
   280                "schema":{
   281                  "type":"boolean"
   282                }
   283              },
   284              {
   285                "name":"source_ids[]",
   286                "in":"query",
   287                "required":false,
   288                "description":"List of source id.",
   289                "schema":{
   290                  "type":"array",
   291                  "items":{
   292                    "type":"string"
   293                  }
   294                }
   295              }
   296            ],
   297            "responses":{
   298              "200":{
   299                "description":"Success",
   300                "content":{
   301                  "application/json":{
   302                    "schema":{
   303                      "$ref":"#/components/schemas/Category"
   304                    }
   305                  }
   306                }
   307              }
   308            }
   309          },
   310          "delete":{
   311            "tags":[
   312              "Categories"
   313            ],
   314            "summary":"Deleting a category",
   315            "operationId":"deleteCategory",
   316            "description":"This method destroys an existing category. It renders the category itself. It renders a 404 if id is invalid.",
   317            "parameters":[
   318              {
   319                "name":"categoryId",
   320                "in":"path",
   321                "required":true,
   322                "schema":{
   323                  "type":"string"
   324                }
   325              },
   326              {
   327                "name":"take_over_category_id",
   328                "description":"ID of a category to recategorize (optional).",
   329                "in":"query",
   330                "required":false,
   331                "schema":{
   332                  "type":"string"
   333                }
   334              }
   335            ],
   336            "responses":{
   337              "200":{
   338                "description":"Success",
   339                "content":{
   340                  "application/json":{
   341                    "schema":{
   342                      "$ref":"#/components/schemas/Category"
   343                    }
   344                  }
   345                }
   346              }
   347            }
   348          }
   349        }
   350      },
   351      "servers":[
   352        {
   353          "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   354        }
   355      ],
   356      "components":{
   357        "schemas":{
   358          "GetAllCategoriesResponse":{
   359            "properties":{
   360              "count":{
   361                "type":"integer",
   362                "format":"int32"
   363              },
   364              "limit":{
   365                "type":"integer",
   366                "format":"int32"
   367              },
   368              "offset":{
   369                "type":"integer",
   370                "format":"int32"
   371              },
   372              "records":{
   373                "type":"array",
   374                "items":{
   375                  "$ref":"#/components/schemas/Category"
   376                }
   377              }
   378            }
   379          },
   380          "Category":{
   381            "required":[
   382              "id"
   383            ],
   384            "properties":{
   385              "id":{
   386                "type":"string"
   387              },
   388              "parent_id":{
   389                "type":"string"
   390              },
   391              "name":{
   392                "type":"string"
   393              },
   394              "created_at":{
   395                "type":"string",
   396                "format":"date-time"
   397              },
   398              "updated_at":{
   399                "type":"string",
   400                "format":"date-time"
   401              },
   402              "color":{
   403                "type":"integer"
   404              },
   405              "mandatory":{
   406                "type":"boolean"
   407              },
   408              "multiple":{
   409                "type":"boolean"
   410              },
   411              "post_qualification":{
   412                "type":"boolean"
   413              },
   414              "source_ids":{
   415                "type":"array",
   416                "items":{
   417                  "type":"string"
   418                }
   419              },
   420              "unselectable":{
   421                "type":"boolean"
   422              }
   423            }
   424          }
   425        }
   426      }
   427    }