github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_events.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":"Events"
    12        }
    13      ],
    14      "paths":{
    15        "/events":{
    16          "get":{
    17            "tags":[
    18              "Events"
    19            ],
    20            "summary":"Getting all events",
    21            "operationId":"getAllEvents",
    22            "description":"This method renders events ordered by creation date (descending).\n\nAuthorization​: Only users whose role can search event permission.",
    23            "parameters":[
    24              {
    25                "name":"q",
    26                "in":"query",
    27                "description":"To filter events on given query. Query works exactly like threads query but only have those keywords: content, content_thread, name_in, created_before, created_after, user. Order can be created_at.desc (default) or created_at.asc. e.g. q=name_in:\"content.replied\"%20content_thread:\"7f946431b6eebffafae642cc\"%20created_after:\"2014-03-20\"%20user:\"4ee91f197aa58d01b500000f\"%20order:\"created_at.asc\"\n* DateTime parameters should be ISO-8601\n* you can specify multiple value for a given keyword: q=name_in:’content.replied’&name_in:’content.ignored’\nPlease refer to ​Search & filtering parameters​ for more details.",
    28                "required":false,
    29                "schema":{
    30                  "type":"string"
    31                }
    32              },
    33              {
    34                "name":"offset",
    35                "in":"query",
    36                "description":"The record index to start. Default value is 0.",
    37                "required":false,
    38                "schema":{
    39                  "type":"integer",
    40                  "format":"int32"
    41                }
    42              },
    43              {
    44                "name":"limit",
    45                "in":"query",
    46                "description":"The max number of records to return. Default value is 30, max value is 150.",
    47                "required":false,
    48                "schema":{
    49                  "type":"integer",
    50                  "format":"int32"
    51                }
    52              }
    53            ],
    54            "responses":{
    55              "200":{
    56                "description":"Success",
    57                "content":{
    58                  "application/json":{
    59                    "schema":{
    60                      "$ref":"#/components/schemas/GetAllEventsResponse"
    61                    }
    62                  }
    63                }
    64              }
    65            }
    66          }
    67        },
    68        "/events/{eventId}":{
    69          "get":{
    70            "tags":[
    71              "Events"
    72            ],
    73            "summary":"Getting an event from its id",
    74            "operationId":"getEvent",
    75            "description":"This method renders an event from given id. If token’s user role does not have “search event” permission a 404 HTTP response will be returned.\n\nAuthorization​: Only users who’s role can search event permission.",
    76            "parameters":[
    77              {
    78                "name":"eventId",
    79                "in":"path",
    80                "required":true,
    81                "schema":{
    82                  "type":"string"
    83                }
    84              }
    85            ],
    86            "responses":{
    87              "200":{
    88                "description":"Success",
    89                "content":{
    90                  "application/json":{
    91                    "schema":{
    92                      "$ref":"#/components/schemas/Event"
    93                    }
    94                  }
    95                }
    96              }
    97            }
    98          }
    99        }
   100      },
   101      "servers":[
   102        {
   103          "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   104        }
   105      ],
   106      "components":{
   107        "schemas":{
   108          "GetAllEventsResponse":{
   109            "properties":{
   110              "count":{
   111                "type":"integer",
   112                "format":"int32"
   113              },
   114              "limit":{
   115                "type":"integer",
   116                "format":"int32"
   117              },
   118              "offset":{
   119                "type":"integer",
   120                "format":"int32"
   121              },
   122              "records":{
   123                "type":"array",
   124                "items":{
   125                  "$ref":"#/components/schemas/Event"
   126                }
   127              }
   128            }
   129          },
   130          "Event":{
   131            "required":[
   132              "id"
   133            ],
   134            "properties":{
   135              "id":{
   136                "type":"string"
   137              },
   138              "created_at":{
   139                "type":"string",
   140                "format":"date-time"
   141              },
   142              "updated_at":{
   143                "type":"string",
   144                "format":"date-time"
   145              },
   146              "name":{
   147                "type":"string"
   148              },
   149              "user_id":{
   150                "type":"string"
   151              },
   152              "extra_infos":{
   153                "$ref":"#/components/schemas/EventExtraInfo"
   154              }
   155            }
   156          },
   157          "EventExtraInfo":{
   158            "description":"attributes in extra_infos are optional and unspecified/not guaranteed, don’t rely on it for critical tasks, this is provided as information only",
   159            "properties":{
   160              "authentication_strategy":{
   161                "type":"string"
   162              },
   163              "business/time_sheet_id":{
   164                "type":"string"
   165              },
   166              "category_ids":{
   167                "type":"array",
   168                "items":{
   169                  "type":"string"
   170                }
   171              },
   172              "closed_automatically":{
   173                "type":"string"
   174              },
   175              "content_id":{
   176                "type":"string"
   177              },
   178              "content_source_id":{
   179                "type":"string"
   180              },
   181              "content_thread_id":{
   182                "type":"string"
   183              },
   184              "deferred_duration":{
   185                "type":"string"
   186              },
   187              "deletions":{
   188                "type":"object"
   189              },
   190              "foreign_id":{
   191                "description":"can be null",
   192                "type":"string"
   193              },
   194              "intervention_id":{
   195                "type":"string"
   196              },
   197              "request_ip":{
   198                "type":"string"
   199              },
   200              "task_id":{
   201                "type":"string"
   202              },
   203              "user_id":{
   204                "type":"string"
   205              }
   206            }
   207          }
   208        }
   209      }
   210    }