github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_reply-assistant-groups.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":"Reply Assistant Groups"
    12        }
    13      ],
    14      "paths":{
    15        "/reply_assistant/groups":{
    16          "get":{
    17            "tags":[
    18              "Reply Assistant Groups"
    19            ],
    20            "summary":"Getting​ a​ll​ reply assistant groups",
    21            "operationId":"getAllReplyAssistantGroups",
    22            "description":"This method renders all groups ordered by creation date (ascending).\n\nAuthorization​: only users that have the right to manage reply assistant.",
    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/GetAllReplyAssistantGroupsResponse"
    52                    }
    53                  }
    54                }
    55              }
    56            }
    57          },
    58          "post":{
    59            "tags":[
    60              "Reply Assistant Groups"
    61            ],
    62            "summary":"Creating a reply assistant group",
    63            "operationId":"createReplyAssistantGroup",
    64            "description":"This method creates an entry group. In case of success it renders the group, otherwise, it renders an error (422 HTTP code).\n\nAuthorization​: only users that have the right to manage reply assistant.",
    65            "parameters":[
    66              {
    67                "name":"name",
    68                "description":"The name of the group.",
    69                "in":"query",
    70                "required":true,
    71                "schema":{
    72                  "type":"string"
    73                }
    74              },
    75              {
    76                "name":"entry_ids[]",
    77                "description":"List of the reply assistant entries in this group.",
    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":"autocomplete",
    90                "description":"Used for autocompletion in chat.",
    91                "in":"query",
    92                "required":false,
    93                "schema":{
    94                  "type":"boolean"
    95                }
    96              },
    97              {
    98                "name":"position",
    99                "description":"Used to determine the order of the groups in the interface, in ascending order.",
   100                "in":"query",
   101                "required":false,
   102                "schema":{
   103                  "type":"integer"
   104                }
   105              }
   106            ],
   107            "responses":{
   108              "200":{
   109                "description":"Success",
   110                "content":{
   111                  "application/json":{
   112                    "schema":{
   113                      "$ref":"#/components/schemas/ReplyAssistantGroup"
   114                    }
   115                  }
   116                }
   117              }
   118            }
   119          }
   120        },
   121        "/reply_assistant/groups/{replyAssistantGroupId}":{
   122          "get":{
   123            "tags":[
   124              "Reply Assistant Groups"
   125            ],
   126            "summary":"Getting a reply assistant group from its id",
   127            "operationId":"getReplyAssistantGroup",
   128            "description":"This method renders an entry group from given id.\n\nAuthorization​: only users that have the right to manage reply assistant.",
   129            "parameters":[
   130              {
   131                "name":"replyAssistantGroupId",
   132                "in":"path",
   133                "required":true,
   134                "schema":{
   135                  "type":"string"
   136                }
   137              }
   138            ],
   139            "responses":{
   140              "200":{
   141                "description":"Success",
   142                "content":{
   143                  "application/json":{
   144                    "schema":{
   145                      "$ref":"#/components/schemas/ReplyAssistantGroup"
   146                    }
   147                  }
   148                }
   149              }
   150            }
   151          },
   152          "put":{
   153            "tags":[
   154              "Reply Assistant Groups"
   155            ],
   156            "summary":"Updating a reply assistant group",
   157            "operationId":"updateReplyAssistantGroup",
   158            "description":"This method updates an existing group from given attributes and renders it in case of success.\n\nAuthorization​: only users that have the right to manage reply assistant.",
   159            "parameters":[
   160              {
   161                "name":"replyAssistantGroupId",
   162                "in":"path",
   163                "required":true,
   164                "schema":{
   165                  "type":"string"
   166                }
   167              },
   168              {
   169                "name":"name",
   170                "description":"The name of the group.",
   171                "in":"query",
   172                "required":false,
   173                "schema":{
   174                  "type":"string"
   175                }
   176              },
   177              {
   178                "name":"entry_ids[]",
   179                "description":"List of the reply assistant entries in this group.",
   180                "in":"query",
   181                "required":false,
   182                "explode":true,
   183                "schema":{
   184                  "type":"array",
   185                  "items":{
   186                    "type":"string"
   187                  }
   188                }
   189              },
   190              {
   191                "name":"autocomplete",
   192                "description":"Used for autocompletion in chat.",
   193                "in":"query",
   194                "required":false,
   195                "schema":{
   196                  "type":"boolean"
   197                }
   198              },
   199              {
   200                "name":"position",
   201                "description":"Used to determine the order of the groups in the interface, in ascending order.",
   202                "in":"query",
   203                "required":false,
   204                "schema":{
   205                  "type":"integer"
   206                }
   207              }
   208            ],
   209            "responses":{
   210              "200":{
   211                "description":"Success",
   212                "content":{
   213                  "application/json":{
   214                    "schema":{
   215                      "$ref":"#/components/schemas/ReplyAssistantGroup"
   216                    }
   217                  }
   218                }
   219              }
   220            }
   221          },
   222          "delete":{
   223            "tags":[
   224              "Reply Assistant Groups"
   225            ],
   226            "summary":"Deleting a reply assistant group",
   227            "operationId":"deleteReplyAssistantGroup",
   228            "description":"This method destroys an existing group. It renders the group itself. It renders a 404 if id is invalid.\n\nAuthorization​: only users that have the right to manage reply assistant.",
   229            "parameters":[
   230              {
   231                "name":"replyAssistantGroupId",
   232                "in":"path",
   233                "required":true,
   234                "schema":{
   235                  "type":"string"
   236                }
   237              }
   238            ],
   239            "responses":{
   240              "200":{
   241                "description":"Success",
   242                "content":{
   243                  "application/json":{
   244                    "schema":{
   245                      "$ref":"#/components/schemas/ReplyAssistantGroup"
   246                    }
   247                  }
   248                }
   249              }
   250            }
   251          }
   252        }
   253      },
   254      "servers":[
   255        {
   256          "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   257        }
   258      ],
   259      "components":{
   260        "schemas":{
   261          "GetAllReplyAssistantGroupsResponse":{
   262            "properties":{
   263              "count":{
   264                "type":"integer",
   265                "format":"int32"
   266              },
   267              "limit":{
   268                "type":"integer",
   269                "format":"int32"
   270              },
   271              "offset":{
   272                "type":"integer",
   273                "format":"int32"
   274              },
   275              "records":{
   276                "type":"array",
   277                "items":{
   278                  "$ref":"#/components/schemas/ReplyAssistantGroup"
   279                }
   280              }
   281            }
   282          },
   283          "ReplyAssistantGroup":{
   284            "required":[
   285              "id"
   286            ],
   287            "properties":{
   288              "id":{
   289                "type":"string"
   290              },
   291              "created_at":{
   292                "type":"string",
   293                "format":"date-time"
   294              },
   295              "updated_at":{
   296                "type":"string",
   297                "format":"date-time"
   298              },
   299              "name":{
   300                "type":"string"
   301              },
   302              "entry_ids":{
   303                "type":"array",
   304                "items":{
   305                  "type":"string"
   306                }
   307              },
   308              "autocomplete":{
   309                "type":"boolean"
   310              },
   311              "position":{
   312                "type":"integer"
   313              }
   314            }
   315          }
   316        }
   317      }
   318    }