github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_reply-assistant-entries.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 Entries"
    12      }
    13    ],
    14    "paths":{
    15      "/reply_assistant/entries":{
    16        "get":{
    17          "tags":[
    18            "Reply Assistant Entries"
    19          ],
    20          "summary":"Getting​ a​ll​ reply assistant e​ntries",
    21          "operationId":"getAllReplyAssistantEntries",
    22          "description":"This method renders all entries 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/GetAllReplyAssistantEntriesResponse"
    52                  }
    53                }
    54              }
    55            }
    56          }
    57        },
    58        "post":{
    59          "tags":[
    60            "Reply Assistant Entries"
    61          ],
    62          "summary":"Creating an entry",
    63          "operationId":"createReplyAssistantEntry",
    64          "description":"This method creates a reply assistant entry. In case of success it renders the entry, 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":"label",
    68              "description":"The name of the entry.",
    69              "in":"query",
    70              "required":true,
    71              "schema":{
    72                "type":"string"
    73              }
    74            }
    75          ],
    76          "responses":{
    77            "200":{
    78              "description":"Success",
    79              "content":{
    80                "application/json":{
    81                  "schema":{
    82                    "$ref":"#/components/schemas/ReplyAssistantEntry"
    83                  }
    84                }
    85              }
    86            }
    87          }
    88        }
    89      },
    90      "/reply_assistant/entries/{replyAssistantEntryId}":{
    91        "get":{
    92          "tags":[
    93            "Reply Assistant Entries"
    94          ],
    95          "summary":"Getting a reply assistant entry from its id",
    96          "operationId":"getReplyAssistantEntry",
    97          "description":"This method renders an entry from given id.\n\nAuthorization​: only users that have the right to manage reply assistant.",
    98          "parameters":[
    99            {
   100              "name":"replyAssistantEntryId",
   101              "in":"path",
   102              "required":true,
   103              "schema":{
   104                "type":"string"
   105              }
   106            }
   107          ],
   108          "responses":{
   109            "200":{
   110              "description":"Success",
   111              "content":{
   112                "application/json":{
   113                  "schema":{
   114                    "$ref":"#/components/schemas/ReplyAssistantEntry"
   115                  }
   116                }
   117              }
   118            }
   119          }
   120        },
   121        "put":{
   122          "tags":[
   123            "Reply Assistant Entries"
   124          ],
   125          "summary":"Updating a reply assistant entry",
   126          "operationId":"updateReplyAssistantEntry",
   127          "description":"This method updates an existing entry from given attributes and renders it in case of success.\n\nAuthorization​: only users that have the right to manage reply assistant.",
   128          "parameters":[
   129            {
   130              "name":"replyAssistantEntryId",
   131              "in":"path",
   132              "required":true,
   133              "schema":{
   134                "type":"string"
   135              }
   136            },
   137            {
   138              "name":"label",
   139              "description":"The name of the entry.",
   140              "in":"query",
   141              "required":false,
   142              "schema":{
   143                "type":"string"
   144              }
   145            },
   146            {
   147              "name":"foreign_id",
   148              "description":"The internal/company id of the entry. This is used to match Engage Digital entry’s id with the company one. Example: KB042.",
   149              "in":"query",
   150              "required":false,
   151              "schema":{
   152                "type":"string"
   153              }
   154            },
   155            {
   156              "name":"category_ids[]",
   157              "description":"To restrict the entry to a set of Engage Digital categories. Then, KB entries that do not match message’s categories to which you are replying will not be suggested.",
   158              "in":"query",
   159              "required":false,
   160              "explode":true,
   161              "schema":{
   162                "type":"array",
   163                "items":{
   164                  "type":"string"
   165                }
   166              }
   167            },
   168            {
   169              "name":"shortcuts[]",
   170              "description":"entry shortcuts",
   171              "in":"query",
   172              "required":false,
   173              "explode":true,
   174              "schema":{
   175                "type":"array",
   176                "items":{
   177                  "type":"string"
   178                }
   179              }
   180            },
   181            {
   182              "name":"entry_group_id",
   183              "description":"Entry group id.",
   184              "in":"query",
   185              "required":false,
   186              "schema":{
   187                "type":"string"
   188              }
   189            },
   190            {
   191              "name":"source_ids[]",
   192              "description":"Source ids (array)",
   193              "in":"query",
   194              "required":false,
   195              "explode":true,
   196              "schema":{
   197                "type":"array",
   198                "items":{
   199                  "type":"string"
   200                }
   201              }
   202            }
   203          ],
   204          "responses":{
   205            "200":{
   206              "description":"Success",
   207              "content":{
   208                "application/json":{
   209                  "schema":{
   210                    "$ref":"#/components/schemas/ReplyAssistantEntry"
   211                  }
   212                }
   213              }
   214            }
   215          }
   216        },
   217        "delete":{
   218          "tags":[
   219            "Reply Assistant Entries"
   220          ],
   221          "summary":"Deleting a reply assistant entry",
   222          "operationId":"deleteReplyAssistantEntry",
   223          "description":"This method destroys an existing entry. It renders the entry itself. It renders a 404 if id is invalid.\n\nAuthorization​: only users that have the right to manage reply assistant.",
   224          "parameters":[
   225            {
   226              "name":"replyAssistantEntryId",
   227              "in":"path",
   228              "required":true,
   229              "schema":{
   230                "type":"string"
   231              }
   232            }
   233          ],
   234          "responses":{
   235            "200":{
   236              "description":"Success",
   237              "content":{
   238                "application/json":{
   239                  "schema":{
   240                    "$ref":"#/components/schemas/ReplyAssistantEntry"
   241                  }
   242                }
   243              }
   244            }
   245          }
   246        }
   247      }
   248    },
   249    "servers":[
   250      {
   251        "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   252      }
   253    ],
   254    "components":{
   255      "schemas":{
   256        "GetAllReplyAssistantEntriesResponse":{
   257          "properties":{
   258            "count":{
   259              "type":"integer",
   260              "format":"int32"
   261            },
   262            "limit":{
   263              "type":"integer",
   264              "format":"int32"
   265            },
   266            "offset":{
   267              "type":"integer",
   268              "format":"int32"
   269            },
   270            "records":{
   271              "type":"array",
   272              "items":{
   273                "$ref":"#/components/schemas/ReplyAssistantEntry"
   274              }
   275            }
   276          }
   277        },
   278        "ReplyAssistantEntry":{
   279          "required":[
   280            "id"
   281          ],
   282          "properties":{
   283            "id":{
   284              "type":"string"
   285            },
   286            "created_at":{
   287              "type":"string",
   288              "format":"date-time"
   289            },
   290            "updated_at":{
   291              "type":"string",
   292              "format":"date-time"
   293            },
   294            "label":{
   295              "type":"string"
   296            },
   297            "version_ids":{
   298              "type":"array",
   299              "items":{
   300                "type":"string"
   301              }
   302            },
   303            "source_ids":{
   304              "type":"array",
   305              "items":{
   306                "type":"string"
   307              }
   308            },
   309            "foreign_id":{
   310              "type":"string"
   311            },
   312            "shortcuts":{
   313              "type":"string"
   314            },
   315            "category_ids":{
   316              "type":"array",
   317              "items":{
   318                "type":"string"
   319              }
   320            },
   321            "entry_group_id":{
   322              "type":"string"
   323            }
   324          }
   325        }
   326      }
   327    }
   328  }