github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_intervention-comments.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": "Intervention Comments"
    12        }
    13      ],
    14      "paths": {
    15        "/intervention_comments": {
    16          "get": {
    17            "tags": [
    18              "Intervention Comments"
    19            ],
    20            "summary": "Getting all intervention comments",
    21            "operationId": "getAllInterventionComments",
    22            "description": "This method renders interventions comments ordered by creation date (descending). Only comments in sources where token’s user has “read” permission are returned.\n\nAuthorization​: no.",
    23            "parameters": [
    24              {
    25                  "name": "intervention_id",
    26                  "in": "query",
    27                  "description": "To filter comments on given intervention id.",
    28                  "required": false,
    29                  "schema": {
    30                    "type": "string"
    31                  }
    32                },
    33                {
    34                  "name": "thread_id",
    35                  "in": "query",
    36                  "description": "To filter comments on given thread id.",
    37                  "required": false,
    38                  "schema": {
    39                    "type": "string"
    40                  }
    41                },
    42                {
    43                  "name": "user_id",
    44                  "in": "query",
    45                  "description": "To filter comments on given user id.",
    46                  "required": false,
    47                  "schema": {
    48                    "type": "string"
    49                  }
    50                },
    51                {
    52                  "name": "identity_id",
    53                  "in": "query",
    54                  "description": "To filter comments on given identity id.",
    55                  "required": false,
    56                  "schema": {
    57                    "type": "string"
    58                  }
    59                },
    60              {
    61                "name": "offset",
    62                "in": "query",
    63                "description": "The record index to start. Default value is 0.",
    64                "required": false,
    65                "schema": {
    66                  "type": "integer",
    67                  "format": "int32"
    68                }
    69              },
    70              {
    71                "name": "limit",
    72                "in": "query",
    73                "description": "The max number of records to return. Default value is 30, max value is 150.",
    74                "required": false,
    75                "schema": {
    76                  "type": "integer",
    77                  "format": "int32"
    78                }
    79              }
    80            ],
    81            "responses": {
    82              "200": {
    83                "description": "Success",
    84                "content": {
    85                  "application/json": {
    86                    "schema": {
    87                      "$ref": "#/components/schemas/GetAllInterventionCommentsResponse"
    88                    }
    89                  }
    90                }
    91              }
    92            }
    93          },
    94          "post": {
    95                "tags": [
    96                  "Intervention Comments"
    97                ],
    98                "summary": "Creating an intervention comment",
    99                "operationId": "createInterventionComment",
   100                "description": "This method creates a new intervention comment. In case of success it renders the created comment, otherwise, it renders an error (422 HTTP code). It creates comment as token’s user. If token’s user does not have “read” on given intervention’s source a 404 HTTP response will be returned.",
   101                "parameters": [
   102                  {
   103                      "name": "body",
   104                      "in": "query",
   105                      "description": "The comment body (mandatory).",
   106                      "required": true,
   107                      "schema": {
   108                        "type": "string"
   109                      }
   110                    },
   111                    {
   112                      "name": "intervention_id",
   113                      "in": "query",
   114                      "description": "The comment intervention id (mandatory).",
   115                      "required": true,
   116                      "schema": {
   117                        "type": "string"
   118                      }
   119                    },
   120                    {
   121                      "name": "user_id",
   122                      "in": "query",
   123                      "description": "The comment user id (mandatory).",
   124                      "required": true,
   125                      "schema": {
   126                        "type": "string"
   127                      }
   128                    }
   129                ],
   130                "responses": {
   131                  "200": {
   132                    "description": "Success",
   133                    "content": {
   134                      "application/json": {
   135                        "schema": {
   136                          "$ref": "#/components/schemas/InterventionComment"
   137                        }
   138                      }
   139                    }
   140                  }
   141                }
   142  
   143              }
   144        },
   145        "/intervention_comments/{interventionCommentId}": {
   146          "get": {
   147            "tags": [
   148              "Intervention Comments"
   149            ],
   150            "summary": "Getting an intervention comment from its id",
   151            "operationId": "getInterventionComment",
   152            "description": "This method renders an intervention comment from given id. If token’s user does not have “read” on comment’s source a 404 HTTP response will be returned.",
   153            "parameters": [
   154              {
   155                "name": "interventionCommentId",
   156                "in": "path",
   157                "required": true,
   158                "schema": {
   159                  "type": "string"
   160                }
   161              }
   162            ],
   163            "responses": {
   164              "200": {
   165                "description": "Success",
   166                "content": {
   167                  "application/json": {
   168                    "schema": {
   169                      "$ref": "#/components/schemas/InterventionComment"
   170                    }
   171                  }
   172                }
   173              }
   174            }
   175          },
   176        
   177        "delete":{
   178          "tags": [
   179              "Intervention Comments"
   180            ],
   181            "summary": "Deleting an intervention comment",
   182            "operationId": "deleteInterventionComment",
   183            "description": "This method destroys an intervention comment. It renders comment itself. If token’s user does not have “read” on comment’s source a 404 HTTP response will be returned.\n\nAuthorization​: no.",
   184            "parameters": [
   185              {
   186                "name": "interventionCommentId",
   187                "in": "path",
   188                "required": true,
   189                "schema": {
   190                  "type": "string"
   191                }
   192              }
   193            ],
   194            "responses": {
   195              "200": {
   196                "description": "Success",
   197                "content": {
   198                  "application/json": {
   199                    "schema": {
   200                      "$ref": "#/components/schemas/InterventionComment"
   201                    }
   202                  }
   203                }
   204              }
   205            }
   206          }
   207  
   208          
   209        }
   210      },
   211      "servers": [
   212        {
   213          "url": "https://DOMAIN.api.engagement.dimelo.com/1.0"
   214        }
   215      ],
   216      "components": {
   217        "schemas": {
   218          "GetAllInterventionCommentsResponse": {
   219            "properties": {
   220              "count": {
   221                "type": "integer",
   222                "format": "int32"
   223              },
   224              "limit": {
   225                "type": "integer",
   226                "format": "int32"
   227              },
   228              "offset": {
   229                "type": "integer",
   230                "format": "int32"
   231              },
   232              "records": {
   233                "type": "array",
   234                "items": {
   235                  "$ref": "#/components/schemas/InterventionComment"
   236                }
   237              }
   238            }
   239          },
   240          "InterventionComment": {
   241            "properties": {
   242              "id": {
   243                "type": "string"
   244              },
   245              "created_at": {
   246                "type": "string",
   247                "format": "date-time"
   248              },
   249              "updated_at": {
   250                "type": "string",
   251                "format": "date-time"
   252              },
   253              "user_id": {
   254                "type": "string"
   255              },
   256              "videntity_id": {
   257                "type": "string"
   258              },
   259              "thread_id": {
   260                "type": "string"
   261              },
   262              "intervention_id": {
   263                  "type": "string"
   264              },
   265              "body": {
   266                  "type": "string"
   267              }
   268            }
   269          }
   270        }
   271      }
   272    }