github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_presence-status.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": "Presence Status"
    12      }
    13    ],
    14    "paths": {
    15      "/presence_status": {
    16        "get": {
    17          "tags": [
    18            "Presence Status"
    19          ],
    20          "summary": "Getting all presence statuses",
    21          "operationId": "getAllPresenceStatus",
    22          "description": "This method renders all presence statuses ordered by name (in alphabetical order).",
    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/GetAllPresenceStatusResponse"
    52                  }
    53                }
    54              }
    55            }
    56          }
    57        },
    58        "post": {
    59          "tags": [
    60            "Presence Status"
    61          ],
    62          "summary": "Creating a presence status",
    63          "operationId": "createPresenceStatus",
    64          "description": "This method creates a presence status. In case of success it renders the presence status, otherwise, it renders an error (422 HTTP code).\n\nAuthorization​: only users that have the right to monitor the task view.",
    65          "parameters": [
    66            {
    67              "name": "name",
    68              "description": "The name of the presence status.",
    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/PresenceStatus"
    83                  }
    84                }
    85              }
    86            }
    87          }
    88        }
    89      },
    90      "/presence_status/{presenceStatusId}": {
    91        "get": {
    92          "tags": [
    93            "Presence Status"
    94          ],
    95          "summary": "Getting a presence status from its id",
    96          "operationId": "getPresenceStatus",
    97          "description": "This method renders a presence status from given id.\n\nAuthorization​: only users that have the right to monitor the task view.",
    98          "parameters": [
    99            {
   100              "name": "presenceStatusId",
   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/PresenceStatus"
   115                  }
   116                }
   117              }
   118            }
   119          }
   120        },
   121        "put": {
   122          "tags": [
   123            "Presence Status"
   124          ],
   125          "summary": "Updating a presence status",
   126          "operationId": "updatePresenceStatus",
   127          "description": "This method updates an existing presence status from given attributes and renders it in case of success.\n\nAuthorization​: only users that have the right to monitor the task view.",
   128          "parameters": [
   129            {
   130              "name": "presenceStatusId",
   131              "in": "path",
   132              "required": true,
   133              "schema": {
   134                "type": "string"
   135              }
   136            },
   137            {
   138              "name": "name",
   139              "description": "The name of the presence status.",
   140              "in": "query",
   141              "required": true,
   142              "schema": {
   143                "type": "string"
   144              }
   145            }
   146          ],
   147          "responses": {
   148            "200": {
   149              "description": "Success",
   150              "content": {
   151                "application/json": {
   152                  "schema": {
   153                    "$ref": "#/components/schemas/PresenceStatus"
   154                  }
   155                }
   156              }
   157            }
   158          }
   159        },
   160        "delete": {
   161          "tags": [
   162            "Presence Status"
   163          ],
   164          "summary": "Deleting a presence status",
   165          "operationId": "deletePresenceStatus",
   166          "description": "This method destroys an existing presence status. It renders presence status itself. It renders a 404 if id is invalid.\n\nAuthorization​: only users that have the right to monitor the task view.",
   167          "parameters": [
   168            {
   169              "name": "presenceStatusId",
   170              "in": "path",
   171              "required": true,
   172              "schema": {
   173                "type": "string"
   174              }
   175            }
   176          ],
   177          "responses": {
   178            "200": {
   179              "description": "Success",
   180              "content": {
   181                "application/json": {
   182                  "schema": {
   183                    "$ref": "#/components/schemas/PresenceStatus"
   184                  }
   185                }
   186              }
   187            }
   188          }
   189        }
   190      }
   191    },
   192    "servers": [
   193      {
   194        "url": "https://DOMAIN.api.engagement.dimelo.com/1.0"
   195      }
   196    ],
   197    "components": {
   198      "schemas": {
   199        "GetAllPresenceStatusResponse": {
   200          "properties": {
   201            "count": {
   202              "type": "integer",
   203              "format": "int32"
   204            },
   205            "limit": {
   206              "type": "integer",
   207              "format": "int32"
   208            },
   209            "offset": {
   210              "type": "integer",
   211              "format": "int32"
   212            },
   213            "records": {
   214              "type": "array",
   215              "items": {
   216                "$ref": "#/components/schemas/PresenceStatus"
   217              }
   218            }
   219          }
   220        },
   221        "PresenceStatus": {
   222          "required": [
   223            "id",
   224            "name"
   225          ],
   226          "properties": {
   227            "id": {
   228              "type": "string"
   229            },
   230            "created_at": {
   231              "type": "string",
   232              "format": "date-time"
   233            },
   234            "updated_at": {
   235              "type": "string",
   236              "format": "date-time"
   237            },
   238            "name": {
   239              "type": "string"
   240            }
   241          }
   242        }
   243      }
   244    }
   245  }