github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_reply-assistant-versions.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 Versions"
    12      }
    13    ],
    14    "paths":{
    15      "/reply_assistant/versions":{
    16        "get":{
    17          "tags":[
    18            "Reply Assistant Versions"
    19          ],
    20          "summary":"Getting​ a​ll​ reply assistant versions",
    21          "operationId":"getAllReplyAssistantVersions",
    22          "description":"This method renders all reply assistant versions 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/GetAllReplyAssistantVersionsResponse"
    52                  }
    53                }
    54              }
    55            }
    56          }
    57        },
    58        "post":{
    59          "tags":[
    60            "Reply Assistant Versions"
    61          ],
    62          "summary":"Creating a reply assistant version",
    63          "operationId":"createReplyAssistantVersion",
    64          "description":"This method creates a reply assistant version. In case of success it renders the version, otherwise, it renders an error (422 HTTP code, 404 if the entry_id is invalid).\n\nAuthorization​: only users that have the right to manage reply assistant.",
    65          "parameters":[
    66            {
    67              "name":"body",
    68              "description":"Body of the version",
    69              "in":"query",
    70              "required":true,
    71              "schema":{
    72                "type":"string"
    73              }
    74            },
    75            {
    76              "name":"entry_id",
    77              "description":"Reply assistant entry id (mandatory)",
    78              "in":"query",
    79              "required":true,
    80              "schema":{
    81                "type":"string"
    82              }
    83            },
    84            {
    85              "name":"source_ids",
    86              "description":"Source ids (array)",
    87              "in":"query",
    88              "required":false,
    89              "explode":true,
    90              "schema":{
    91                "type":"array",
    92                "items":{
    93                  "type":"string"
    94                }
    95              }
    96            },
    97            {
    98              "name":"format",
    99              "description":"Either “text” or “html”",
   100              "in":"query",
   101              "required":false,
   102              "schema":{
   103                "type":"string",
   104                "enum":[
   105                  "text",
   106                  "html"
   107                ]
   108              }
   109            },
   110            {
   111              "name":"language",
   112              "description":"Language (ex: “fr”)",
   113              "in":"query",
   114              "required":false,
   115              "schema":{
   116                "type":"string"
   117              }
   118            }
   119          ],
   120          "responses":{
   121            "200":{
   122              "description":"Success",
   123              "content":{
   124                "application/json":{
   125                  "schema":{
   126                    "$ref":"#/components/schemas/ReplyAssistantVersion"
   127                  }
   128                }
   129              }
   130            }
   131          }
   132        }
   133      },
   134      "/reply_assistant/versions/{replyAssistantVersionId}":{
   135        "get":{
   136          "tags":[
   137            "Reply Assistant Versions"
   138          ],
   139          "summary":"Getting a reply assistant version from its id",
   140          "operationId":"getReplyAssistantVersion",
   141          "description":"This method renders a version from given id.\n\nAuthorization​: only users that have the right to manage reply assistant.",
   142          "parameters":[
   143            {
   144              "name":"replyAssistantVersionId",
   145              "in":"path",
   146              "required":true,
   147              "schema":{
   148                "type":"string"
   149              }
   150            }
   151          ],
   152          "responses":{
   153            "200":{
   154              "description":"Success",
   155              "content":{
   156                "application/json":{
   157                  "schema":{
   158                    "$ref":"#/components/schemas/ReplyAssistantVersion"
   159                  }
   160                }
   161              }
   162            }
   163          }
   164        },
   165        "put":{
   166          "tags":[
   167            "Reply Assistant Versions"
   168          ],
   169          "summary":"Updating a reply assistant version",
   170          "operationId":"updateReplyAssistantVersion",
   171          "description":"This method updates an existing version from given attributes and renders it in case of success.\n\nAuthorization​: only users that have the right to manage reply assistant.",
   172          "parameters":[
   173            {
   174              "name":"replyAssistantVersionId",
   175              "in":"path",
   176              "required":true,
   177              "schema":{
   178                "type":"string"
   179              }
   180            },
   181            {
   182              "name":"body",
   183              "description":"Body of the version",
   184              "in":"query",
   185              "required":false,
   186              "schema":{
   187                "type":"string"
   188              }
   189            },
   190            {
   191              "name":"entry_id",
   192              "description":"Reply assistant entry id.",
   193              "in":"query",
   194              "required":false,
   195              "schema":{
   196                "type":"string"
   197              }
   198            },
   199            {
   200              "name":"source_ids[]",
   201              "description":"Source ids (array)",
   202              "in":"query",
   203              "required":false,
   204              "explode":true,
   205              "schema":{
   206                "type":"array",
   207                "items":{
   208                  "type":"string"
   209                }
   210              }
   211            },
   212            {
   213              "name":"format",
   214              "description":"Either “text” or “html”",
   215              "in":"query",
   216              "required":false,
   217              "explode":true,
   218              "schema":{
   219                "type":"string",
   220                "enum":[
   221                  "text",
   222                  "html"
   223                ]
   224              }
   225            },
   226            {
   227              "name":"language",
   228              "description":"Language (ex: “fr”)",
   229              "in":"query",
   230              "required":false,
   231              "schema":{
   232                "type":"string"
   233              }
   234            }
   235          ],
   236          "responses":{
   237            "200":{
   238              "description":"Success",
   239              "content":{
   240                "application/json":{
   241                  "schema":{
   242                    "$ref":"#/components/schemas/ReplyAssistantVersion"
   243                  }
   244                }
   245              }
   246            }
   247          }
   248        },
   249        "delete":{
   250          "tags":[
   251            "Reply Assistant Versions"
   252          ],
   253          "summary":"Deleting a reply assistant version",
   254          "operationId":"deleteReplyAssistantVersion",
   255          "description":"This method destroys an existing version. It renders the version itself. It renders a 404 if id is invalid.\n\nAuthorization​: only users that have the right to manage reply assistant.",
   256          "parameters":[
   257            {
   258              "name":"replyAssistantVersionId",
   259              "in":"path",
   260              "required":true,
   261              "schema":{
   262                "type":"string"
   263              }
   264            }
   265          ],
   266          "responses":{
   267            "200":{
   268              "description":"Success",
   269              "content":{
   270                "application/json":{
   271                  "schema":{
   272                    "$ref":"#/components/schemas/ReplyAssistantVersion"
   273                  }
   274                }
   275              }
   276            }
   277          }
   278        }
   279      }
   280    },
   281    "servers":[
   282      {
   283        "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   284      }
   285    ],
   286    "components":{
   287      "schemas":{
   288        "GetAllReplyAssistantVersionsResponse":{
   289          "properties":{
   290            "count":{
   291              "type":"integer",
   292              "format":"int32"
   293            },
   294            "limit":{
   295              "type":"integer",
   296              "format":"int32"
   297            },
   298            "offset":{
   299              "type":"integer",
   300              "format":"int32"
   301            },
   302            "records":{
   303              "type":"array",
   304              "items":{
   305                "$ref":"#/components/schemas/ReplyAssistantVersion"
   306              }
   307            }
   308          }
   309        },
   310        "ReplyAssistantVersion":{
   311          "required":[
   312            "id"
   313          ],
   314          "properties":{
   315            "id":{
   316              "type":"string"
   317            },
   318            "created_at":{
   319              "type":"string",
   320              "format":"date-time"
   321            },
   322            "updated_at":{
   323              "type":"string",
   324              "format":"date-time"
   325            },
   326            "body":{
   327              "type":"string"
   328            },
   329            "entry_id":{
   330              "type":"string"
   331            },
   332            "source_ids":{
   333              "type":"array",
   334              "items":{
   335                "type":"string"
   336              }
   337            },
   338            "format":{
   339              "type":"string",
   340              "enum":[
   341                "text",
   342                "html"
   343              ]
   344            },
   345            "attachments_count":{
   346              "type":"integer"
   347            },
   348            "language":{
   349              "type":"string"
   350            }
   351          }
   352        }
   353      }
   354    }
   355  }