github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_sources.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":"Sources"
    12      }
    13    ],
    14    "paths":{
    15      "/content_sources":{
    16        "get":{
    17          "tags":[
    18            "Sources"
    19          ],
    20          "summary":"Getting all sources",
    21          "operationId":"getAllSources",
    22          "description":"This method renders sources ordered by creation date (ascending).",
    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/GetAllSourcesResponse"
    52                  }
    53                }
    54              }
    55            }
    56          }
    57        }
    58      },
    59      "/content_sources/{sourceId}":{
    60        "get":{
    61          "tags":[
    62            "Sources"
    63          ],
    64          "summary":"Getting a source from its id",
    65          "operationId":"getSource",
    66          "description":"This method renders a source from given id.",
    67          "parameters":[
    68            {
    69              "name":"sourceId",
    70              "in":"path",
    71              "required":true,
    72              "schema":{
    73                "type":"string"
    74              }
    75            }
    76          ],
    77          "responses":{
    78            "200":{
    79              "description":"Success",
    80              "content":{
    81                "application/json":{
    82                  "schema":{
    83                    "$ref":"#/components/schemas/Source"
    84                  }
    85                }
    86              }
    87            }
    88          }
    89        },
    90        "put":{
    91          "tags":[
    92            "Sources"
    93          ],
    94          "summary":"Updating a source",
    95          "operationId":"updateSource",
    96          "description":"This method updates an existing source from given attributes and renders it in case of success.",
    97          "parameters":[
    98            {
    99              "name":"sourceId",
   100              "in":"path",
   101              "required":true,
   102              "schema":{
   103                "type":"string"
   104              }
   105            },
   106            {
   107              "name":"name",
   108              "description":"Source name",
   109              "in":"query",
   110              "required":false,
   111              "schema":{
   112                "type":"string"
   113              }
   114            },
   115            {
   116              "name":"active",
   117              "description":"Activate/deactivate the source (Boolean)",
   118              "in":"query",
   119              "required":false,
   120              "schema":{
   121                "type":"boolean"
   122              }
   123            },
   124            {
   125              "name":"channel_id",
   126              "description":"Channel",
   127              "in":"query",
   128              "required":false,
   129              "schema":{
   130                "type":"string"
   131              }
   132            },
   133            {
   134              "name":"color",
   135              "description":"Color of the icon (see S​ ource colors​) (Integer)",
   136              "in":"query",
   137              "required":false,
   138              "schema":{
   139                "type":"integer"
   140              }
   141            },
   142            {
   143              "name":"sla_response",
   144              "description":"Response time (seconds)",
   145              "in":"query",
   146              "required":false,
   147              "schema":{
   148                "type":"integer"
   149              }
   150            },
   151            {
   152              "name":"sla_expired_strategy",
   153              "description":"SLA expired strategy (\"max\", \"half\" or \"base\")",
   154              "in":"query",
   155              "required":false,
   156              "schema":{
   157                "type":"string",
   158                "enum":[
   159                  "max",
   160                  "half",
   161                  "base"
   162                ]
   163              }
   164            },
   165            {
   166              "name":"intervention_messages_boost",
   167              "description":"Priority boost of messages with intervention (Integer)",
   168              "in":"query",
   169              "required":false,
   170              "schema":{
   171                "type":"integer"
   172              }
   173            },
   174            {
   175              "name":"transferred_tasks_boost",
   176              "description":"Priority boost of transferred tasks (Integer)",
   177              "in":"query",
   178              "required":false,
   179              "schema":{
   180                "type":"integer"
   181              }
   182            },
   183            {
   184              "name":"hidden_from_stats",
   185              "description":"Hide from statistics (Boolean)",
   186              "in":"query",
   187              "required":false,
   188              "schema":{
   189                "type":"boolean"
   190              }
   191            },
   192            {
   193              "name":"default_category_ids[]",
   194              "description":"Default categories",
   195              "in":"query",
   196              "required":false,
   197              "schema":{
   198                "type":"array",
   199                "items":{
   200                  "type":"string"
   201                }
   202              }
   203            },
   204            {
   205              "name":"user_thread_default_category_ids[]",
   206              "description":"Default categories (agent messages)",
   207              "in":"query",
   208              "required":false,
   209              "schema":{
   210                "type":"array",
   211                "items":{
   212                  "type":"string"
   213                }
   214              }
   215            },
   216            {
   217              "name":"default_content_language",
   218              "description":"Default content language",
   219              "in":"query",
   220              "required":false,
   221              "schema":{
   222                "type":"string"
   223              }
   224            },
   225            {
   226              "name":"auto_detect_content_language",
   227              "description":"Auto-detect content language (Boolean)",
   228              "in":"query",
   229              "required":false,
   230              "schema":{
   231                "type":"boolean"
   232              }
   233            },
   234            {
   235              "name":"content_archiving",
   236              "description":"Automatic archiving of old contents (Boolean)",
   237              "in":"query",
   238              "required":false,
   239              "schema":{
   240                "type":"boolean"
   241              }
   242            },
   243            {
   244              "name":"content_archiving_period",
   245              "description":"Archive contents older than (seconds)",
   246              "in":"query",
   247              "required":false,
   248              "schema":{
   249                "type":"integer"
   250              }
   251            }
   252          ],
   253          "responses":{
   254            "200":{
   255              "description":"Success",
   256              "content":{
   257                "application/json":{
   258                  "schema":{
   259                    "$ref":"#/components/schemas/Source"
   260                  }
   261                }
   262              }
   263            }
   264          }
   265        }
   266      }
   267    },
   268    "servers":[
   269      {
   270        "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   271      }
   272    ],
   273    "components":{
   274      "schemas":{
   275        "GetAllSourcesResponse":{
   276          "properties":{
   277            "count":{
   278              "type":"integer",
   279              "format":"int32"
   280            },
   281            "limit":{
   282              "type":"integer",
   283              "format":"int32"
   284            },
   285            "offset":{
   286              "type":"integer",
   287              "format":"int32"
   288            },
   289            "records":{
   290              "type":"array",
   291              "items":{
   292                "$ref":"#/components/schemas/Source"
   293              }
   294            }
   295          }
   296        },
   297        "Source":{
   298          "properties":{
   299            "id":{
   300              "type":"string"
   301            },
   302            "created_at":{
   303              "type":"string",
   304              "format":"date-time"
   305            },
   306            "updated_at":{
   307              "type":"string",
   308              "format":"date-time"
   309            },
   310            "active":{
   311              "type":"boolean",
   312              "description":"Activate/deactivate the source"
   313            },
   314            "community_id":{
   315              "type":"string"
   316            },
   317            "channel_id":{
   318              "type":"string"
   319            },
   320            "name":{
   321              "type":"string",
   322              "description":"Source name"
   323            },
   324            "status":{
   325              "type":"string"
   326            },
   327            "color":{
   328              "type":"integer",
   329              "format":"int32",
   330              "description":"Color of the icon: Default: 0 Blue: 1 Green: 2 Turquoise: 3 Purple: 4 Yellow: 5 Orange: 6 Red: 7 Asphalt: 8 Grey: 9"
   331            },
   332            "sla_response":{
   333              "type":"integer",
   334              "format":"int32",
   335              "description":"Response time (seconds)"
   336            },
   337            "sla_expired_strategy":{
   338              "type":"string",
   339              "enum":[
   340                "max",
   341                "half",
   342                "base"
   343              ],
   344              "description":"SLA expired strategy (\"max\", \"half\" or \"base\")"
   345            },
   346            "intervention_messages_boost":{
   347              "type":"integer",
   348              "format":"int32",
   349              "description":"Priority boost of messages with intervention"
   350            },
   351            "transferred_tasks_boost":{
   352              "type":"integer",
   353              "format":"int32",
   354              "description":"Priority boost of transferred tasks"
   355            },
   356            "hidden_from_stats":{
   357              "type":"boolean",
   358              "description":"Hide from statistics"
   359            },
   360            "default_category_ids":{
   361              "type":"array",
   362              "items":{
   363                "type":"string"
   364              },
   365              "description":"Default categories"
   366            },
   367            "user_thread_default_category_ids":{
   368              "type":"array",
   369              "items":{
   370                "type":"string"
   371              },
   372              "description":"Default categories (agent messages)"
   373            },
   374            "default_content_language":{
   375              "type":"string",
   376              "description":"Default content language"
   377            },
   378            "auto_detect_content_language":{
   379              "type":"boolean",
   380              "description":"Auto-detect content language (Boolean)"
   381            },
   382            "time_sheet_ids":{
   383              "type":"array",
   384              "items":{
   385                "type":"string"
   386              }
   387            },
   388            "content_archiving":{
   389              "type":"boolean",
   390              "description":"Automatic archiving of old contents (Boolean)"
   391            },
   392            "content_archiving_period":{
   393              "type":"integer",
   394              "format":"int64",
   395              "description":"Archive contents older than (seconds)"
   396            },
   397            "content_languages":{
   398              "type":"array",
   399              "items":{
   400                "type":"string"
   401              }
   402            },
   403            "type":{
   404              "type":"string"
   405            },
   406            "error_message":{
   407              "type":"string"
   408            }
   409          }
   410        }
   411      }
   412    }
   413  }