github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_settings.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":"Settings"
    12        }
    13      ],
    14      "paths":{
    15        "/settings":{
    16          "get":{
    17            "tags":[
    18              "Settings"
    19            ],
    20            "summary":"Getting all settings",
    21            "operationId":"getAllSettings",
    22            "description":"This method renders all settings of your domain.\n\nAuthorization​: only users that can update settings.",
    23            "responses":{
    24              "200":{
    25                "description":"Success",
    26                "content":{
    27                  "application/json":{
    28                    "schema":{
    29                      "$ref":"#/components/schemas/Settings"
    30                    }
    31                  }
    32                }
    33              }
    34            }
    35          },
    36          "put":{
    37            "tags":[
    38              "Settings"
    39            ],
    40            "summary":"Updating settings",
    41            "operationId":"updateSettings",
    42            "description":"This method updates the current domain settings.\n\nAuthorization​: only users that can update settings.",
    43            "parameters":[
    44              {
    45                "name":"activity_presence_threshold",
    46                "in":"query",
    47                "required":false,
    48                "description":"(in hours).",
    49                "schema":{
    50                  "type":"integer"
    51                }
    52              },
    53              {
    54                "name":"activity_tracking",
    55                "in":"query",
    56                "required":false,
    57                "description":"​Enable activity tracking (Boolean)",
    58                "schema":{
    59                  "type":"boolean"
    60                }
    61              },
    62              {
    63                "name":"beginning_of_week",
    64                "in":"query",
    65                "required":false,
    66                "description":"(Day of week)",
    67                "schema":{
    68                  "type":"string"
    69                }
    70              },
    71              {
    72                "name":"category_tagging",
    73                "in":"query",
    74                "required":false,
    75                "description":"A​ ctivate the forced categorization by source.​ (Boolean)",
    76                "schema":{
    77                  "type":"boolean"
    78                }
    79              },
    80              {
    81                "name":"content_languages",
    82                "in":"query",
    83                "required":false,
    84                "description":"(See format)",
    85                "schema":{
    86                  "type":"string"
    87                }
    88              },
    89              {
    90                "name":"dashboard",
    91                "in":"query",
    92                "required":false,
    93                "description":"Activate the dashboard (Boolean)",
    94                "schema":{
    95                  "type":"boolean"
    96                }
    97              },
    98              {
    99                "name":"deny_iframe_integration",
   100                "in":"query",
   101                "required":false,
   102                "description":"Prevent the DD to be embed by other websites (Boolean)",
   103                "schema":{
   104                  "type":"boolean"
   105                }
   106              },
   107              {
   108                "name":"disable_password_autocomplete",
   109                "in":"query",
   110                "required":false,
   111                "description":"(Boolean)",
   112                "schema":{
   113                  "type":"boolean"
   114                }
   115              },
   116              {
   117                "name":"expire_password_after",
   118                "in":"query",
   119                "required":false,
   120                "description":"password expiration delay (in seconds)",
   121                "schema":{
   122                  "type":"integer"
   123                }
   124              },
   125              {
   126                "name":"expire_password_enabled",
   127                "in":"query",
   128                "required":false,
   129                "description":"enable password expiration (Boolean)",
   130                "schema":{
   131                  "type":"boolean"
   132                }
   133              },
   134              {
   135                "name":"export_in_seconds",
   136                "in":"query",
   137                "required":false,
   138                "description":"provide durations in seconds in export (Boolean)",
   139                "schema":{
   140                  "type":"boolean"
   141                }
   142              },
   143              {
   144                "name":"fold_useless_contents",
   145                "in":"query",
   146                "required":false,
   147                "description":"fold archived contents (Boolean)",
   148                "schema":{
   149                  "type":"boolean"
   150                }
   151              },
   152              {
   153                "name":"fte_duration",
   154                "in":"query",
   155                "required":false,
   156                "description":"FTE data period (in hours)",
   157                "schema":{
   158                  "type":"integer"
   159                }
   160              },
   161              {
   162                "name":"identity_merge",
   163                "in":"query",
   164                "required":false,
   165                "description":"enable identity merge (Boolean)",
   166                "schema":{
   167                  "type":"boolean"
   168                }
   169              },
   170              {
   171                "name":"intervention_defer_rates[]",
   172                "in":"query",
   173                "required":false,
   174                "description":"(Array of times in seconds)",
   175                "schema":{
   176                  "type":"array",
   177                  "items":{
   178                    "type":"integer"
   179                  }
   180                }
   181              },
   182              {
   183                "name":"intervention_defer_threshold",
   184                "in":"query",
   185                "required":false,
   186                "description":"(in seconds)",
   187                "schema":{
   188                  "type":"integer"
   189                }
   190              },
   191              {
   192                "name":"intervention_rates",
   193                "in":"query",
   194                "required":false,
   195                "description":"(Array of times in seconds)",
   196                "schema":{
   197                  "type":"array",
   198                  "items":{
   199                    "type":"integer"
   200                  }
   201                }
   202              },
   203              {
   204                "name":"locale",
   205                "in":"query",
   206                "required":false,
   207                "description":"locale code (String)",
   208                "schema":{
   209                  "type":"string"
   210                }
   211              },
   212              {
   213                "name":"multi_lang",
   214                "in":"query",
   215                "required":false,
   216                "description":"activate multi language support for messages (Boolean)",
   217                "schema":{
   218                  "type":"boolean"
   219                }
   220              },
   221              {
   222                "name":"name",
   223                "in":"query",
   224                "required":false,
   225                "description":"Name of the Dimelo Digital (String)",
   226                "schema":{
   227                  "type":"string"
   228                }
   229              },
   230              {
   231                "name":"password_archivable_enabled",
   232                "in":"query",
   233                "required":false,
   234                "description":"prohibit reusing old passwords (Boolean)",
   235                "schema":{
   236                  "type":"boolean"
   237                }
   238              },
   239              {
   240                "name":"password_archivable_size",
   241                "in":"query",
   242                "required":false,
   243                "description":"number of archived passwords",
   244                "schema":{
   245                  "type":"integer"
   246                }
   247              },
   248              {
   249                "name":"password_min_length",
   250                "in":"query",
   251                "required":false,
   252                "description":"minimum character length",
   253                "schema":{
   254                  "type":"integer"
   255                }
   256              },
   257              {
   258                "name":"password_non_word",
   259                "in":"query",
   260                "required":false,
   261                "description":"should contain at least 1 non alphanumeric char (Boolean)",
   262                "schema":{
   263                  "type":"boolean"
   264                }
   265              },
   266              {
   267                "name":"password_numbers",
   268                "in":"query",
   269                "required":false,
   270                "description":"should contain at least 1 number (Boolean)",
   271                "schema":{
   272                  "type":"boolean"
   273                }
   274              },
   275              {
   276                "name":"password_recovery_disabled",
   277                "in":"query",
   278                "required":false,
   279                "description":"disable password recovery by email (Boolean)",
   280                "schema":{
   281                  "type":"boolean"
   282                }
   283              },
   284              {
   285                "name":"push_enabled",
   286                "in":"query",
   287                "required":false,
   288                "description":"Enable push mode (Boolean)",
   289                "schema":{
   290                  "type":"boolean"
   291                }
   292              },
   293              {
   294                "name":"reply_as_any_identity",
   295                "in":"query",
   296                "required":false,
   297                "description":"Enable reply as any identity (Boolean)",
   298                "schema":{
   299                  "type":"boolean"
   300                }
   301              },
   302              {
   303                "name":"rtl_support",
   304                "in":"query",
   305                "required":false,
   306                "description":"Enable right to left support (Boolean)",
   307                "schema":{
   308                  "type":"boolean"
   309                }
   310              },
   311              {
   312                "name":"self_approval_required",
   313                "in":"query",
   314                "required":false,
   315                "description":"​Allow authors to ask approval of their messages (Boolean)",
   316                "schema":{
   317                  "type":"boolean"
   318                }
   319              },
   320              {
   321                "name":"session_timeout",
   322                "in":"query",
   323                "required":false,
   324                "description":"Session timeout (in minutes)",
   325                "schema":{
   326                  "type":"integer"
   327                }
   328              },
   329              {
   330                "name":"spellchecking",
   331                "in":"query",
   332                "required":false,
   333                "description":"Enable spellchecking (Boolean)",
   334                "schema":{
   335                  "type":"boolean"
   336                }
   337              },
   338              {
   339                "name":"style",
   340                "in":"query",
   341                "required":false,
   342                "description":"Defines the DD’s design (String)",
   343                "schema":{
   344                  "type":"string"
   345                }
   346              },
   347              {
   348                "name":"third_party_services_disabled",
   349                "in":"query",
   350                "required":false,
   351                "description":"Disable third-party services (tracking...) (Boolean)",
   352                "schema":{
   353                  "type":"boolean"
   354                }
   355              },
   356              {
   357                "name":"timezone",
   358                "in":"query",
   359                "required":false,
   360                "description":"Use the timezone endpoint to get the timezone name (String)",
   361                "schema":{
   362                  "type":"string"
   363                }
   364              },
   365              {
   366                "name":"track_js",
   367                "in":"query",
   368                "required":false,
   369                "description":"Track JS errors (Boolean)",
   370                "schema":{
   371                  "type":"boolean"
   372                }
   373              },
   374              {
   375                "name":"type",
   376                "in":"query",
   377                "required":false,
   378                "description":"Can be ‘demo’, ‘production’ or ‘archived’",
   379                "schema":{
   380                  "type":"string",
   381                  "enum":[
   382                    "demo",
   383                    "production",
   384                    "archived"
   385                  ]
   386                }
   387              },
   388              {
   389                "name":"urgent_task_threshold",
   390                "in":"query",
   391                "required":false,
   392                "description":"Chat max response time (in seconds)",
   393                "schema":{
   394                  "type":"integer"
   395                }
   396              },
   397              {
   398                "name":"use_system_font",
   399                "in":"query",
   400                "required":false,
   401                "description":"Experimental (Boolean)",
   402                "schema":{
   403                  "type":"boolean"
   404                }
   405              }
   406            ],
   407            "responses":{
   408              "200":{
   409                "description":"Success",
   410                "content":{
   411                  "application/json":{
   412                    "schema":{
   413                      "$ref":"#/components/schemas/Settings"
   414                    }
   415                  }
   416                }
   417              }
   418            }
   419          }
   420        }
   421      },
   422      "servers":[
   423        {
   424          "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   425        }
   426      ],
   427      "components":{
   428        "schemas":{
   429          "Settings":{
   430            "properties":{
   431              "id":{
   432                "type":"string"
   433              },
   434              "created_at":{
   435                "type":"string",
   436                "format":"date-time"
   437              },
   438              "updated_at":{
   439                "type":"string",
   440                "format":"date-time"
   441              },
   442              "activity_presence_threshold":{
   443                "type":"integer"
   444              },
   445              "activity_tracking":{
   446                "type":"boolean"
   447              },
   448              "beginning_of_week":{
   449                "type":"string"
   450              },
   451              "content_languages[]":{
   452                "type":"array",
   453                "items":{
   454                  "type":"string"
   455                }
   456              },
   457              "deny_iframe_integration":{
   458                "type":"boolean"
   459              },
   460              "disable_password_autocomplete":{
   461                "type":"boolean"
   462              },
   463              "dump_in_preprod":{
   464                "type":"boolean"
   465              },
   466              "expire_password_after":{
   467                "type":"integer"
   468              },
   469              "expire_password_enabled":{
   470                "type":"boolean"
   471              },
   472              "fte_duration":{
   473                "type":"integer"
   474              },
   475              "identity_merge":{
   476                "type":"boolean"
   477              },
   478              "intervention_defer_rates":{
   479                "type":"array",
   480                "items":{
   481                  "type":"integer"
   482                }
   483              },
   484              "intervention_defer_threshold":{
   485                "type":"integer"
   486              },
   487              "intervention_rates":{
   488                "type":"array",
   489                "items":{
   490                  "type":"integer"
   491                }
   492              },
   493              "locale":{
   494                "type":"string"
   495              },
   496              "multi_lang":{
   497                "type":"boolean"
   498              },
   499              "name":{
   500                "type":"string"
   501              },
   502              "password_archivable_enabled":{
   503                "type":"boolean"
   504              },
   505              "password_archivable_size":{
   506                "type":"integer"
   507              },
   508              "password_min_length":{
   509                "type":"integer"
   510              },
   511              "password_non_word":{
   512                "type":"boolean"
   513              },
   514              "password_numbers":{
   515                "type":"boolean"
   516              },
   517              "password_recovery_disabled":{
   518                "type":"boolean"
   519              },
   520              "push_enabled":{
   521                "type":"boolean"
   522              },
   523              "reply_as_any_identity":{
   524                "type":"boolean"
   525              },
   526              "rtl_support":{
   527                "type":"boolean"
   528              },
   529              "self_approval_required":{
   530                "type":"boolean"
   531              },
   532              "session_timeout":{
   533                "type":"integer"
   534              },
   535              "sharding_key":{
   536                "type":"string"
   537              },
   538              "spellchecking":{
   539                "type":"boolean"
   540              },
   541              "style":{
   542                "type":"string"
   543              },
   544              "third_party_services_disabled":{
   545                "type":"boolean"
   546              },
   547              "timezone":{
   548                "type":"string"
   549              },
   550              "type":{
   551                "type":"string"
   552              },
   553              "urgent_task_threshold":{
   554                "type":"integer"
   555              },
   556              "browser_notifications_disabled":{
   557                "type":"boolean"
   558              },
   559              "display_only_unknown_bbcode":{
   560                "type":"boolean"
   561              },
   562              "intervention_closing_period":{
   563                "type":"integer"
   564              },
   565              "use_two_letters_avatars":{
   566                "type":"boolean"
   567              }
   568            }
   569          }
   570        }
   571      }
   572    }