-{"openapi":"3.0.3","info":{"title":"XCally Motion API","description":"OpenAPI document for XCally Motion API","termsOfService":"http://xcally.com/terms/","contact":{"name":"API Support","url":"http://www.xcally.com/support","email":"support@xcally.com"},"license":{"name":"XCally EULA","url":"http://xcally.com/eula/"},"version":"3.0.0.alpha"},"servers":[{"url":"http://localhost:9000/api","description":"Localhost instance"}],"paths":{"/actions/{id}":{"put":{"summary":"Update an existing Action","security":[{"BearerAuth":[]}],"operationId":"updateActionById","tags":["Actions"],"requestBody":{"required":true,"description":"data for updating a new Action","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"action":{"type":"string","description":"Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script"},"data1":{"type":"string","description":"contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]"},"data2":{"type":"string","description":"integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]"},"data3":{"type":"string","description":"motionbar[NULL,NULL,WinAppArguments]"},"data4":{"type":"string"},"data5":{"type":"string"},"data6":{"type":"string"},"data7":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Action to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Action not found"}}}},"/actions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Action","security":[{"BearerAuth":[]}],"operationId":"deleteActionById","tags":["Actions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Action to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Action not found"}}}},"/analytics/custom_reports":{"get":{"summary":"Gets a list of Analytic Custom Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticCustomReport","tags":["Analytic Custom Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticCustomReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Custom Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticCustomReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Custom Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticCustomReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Custom Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticCustomReport","tags":["Analytic Custom Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Custom Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"parent":{"type":"string"},"table":{"type":"string"},"conditions":{"type":"string"},"joins":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"AnalyticCustomReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticCustomReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/custom_reports/{id}":{"get":{"summary":"Gets a single Analytic Custom Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticCustomReportById","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport to get"}],"responses":{"200":{"description":"AnalyticCustomReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticCustomReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticCustomReport not found"}}},"put":{"summary":"Update an existing Analytic Custom Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticCustomReportById","tags":["Analytic Custom Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Custom Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"parent":{"type":"string"},"table":{"type":"string"},"conditions":{"type":"string"},"joins":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticCustomReport not found"}}}},"/analytics/custom_reports/{id}/preview":{"get":{"summary":"Report Preview","security":[{"BearerAuth":[]}],"operationId":"preview","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/custom_reports/{id}/run":{"get":{"summary":"Report Run","security":[{"BearerAuth":[]}],"operationId":"run","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/custom_reports/{id}/query":{"get":{"summary":"Report Query SQL","security":[{"BearerAuth":[]}],"operationId":"query","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/custom_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Custom Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticCustomReportById","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticCustomReport not found"}}}},"/analytics/default_reports":{"get":{"summary":"Gets a list of Analytic Default Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticDefaultReport","tags":["Analytic Default Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticDefaultReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Default Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticDefaultReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Default Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticDefaultReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Default Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticDefaultReport","tags":["Analytic Default Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Default Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"parent":{"type":"string"},"table":{"type":"string"},"conditions":{"type":"string"},"joins":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"AnalyticDefaultReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticDefaultReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/default_reports/{id}":{"get":{"summary":"Gets a single Analytic Default Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticDefaultReportById","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport to get"}],"responses":{"200":{"description":"AnalyticDefaultReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticDefaultReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticDefaultReport not found"}}},"put":{"summary":"Update an existing Analytic Default Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticDefaultReportById","tags":["Analytic Default Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Default Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"parent":{"type":"string"},"table":{"type":"string"},"conditions":{"type":"string"},"joins":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticDefaultReport not found"}}}},"/analytics/default_reports/{id}/preview":{"get":{"summary":"Report Preview","security":[{"BearerAuth":[]}],"operationId":"preview","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/default_reports/{id}/run":{"get":{"summary":"Report Run","security":[{"BearerAuth":[]}],"operationId":"run","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/default_reports/{id}/query":{"get":{"summary":"Report Query SQL","security":[{"BearerAuth":[]}],"operationId":"query","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/default_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Default Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticDefaultReportById","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticDefaultReport not found"}}}},"/analytics/extracted_reports":{"get":{"summary":"Gets a list of Analytic Extacted Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticExtractedReport","tags":["Analytic Extracted Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticExtractedReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Extacted Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticExtractedReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Extacted Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticExtractedReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Extracted Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticExtractedReport","tags":["Analytic Extracted Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Extracted Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"basename":{"type":"string"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"savename":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"status":{"type":"string","default":"Loading"},"type":{"type":"string","enum":["manual","scheduled"],"default":"manual"},"reportId":{"type":"integer"},"reportType":{"type":"string"}},"required":["name","basename","output","savename","type"]}}}},"responses":{"201":{"description":"AnalyticExtractedReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticExtractedReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/extracted_reports/{id}":{"get":{"summary":"Gets a single Analytic Extracted Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticExtractedReportById","tags":["Analytic Extracted Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticExtractedReport to get"}],"responses":{"200":{"description":"AnalyticExtractedReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticExtractedReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticExtractedReport not found"}}},"put":{"summary":"Update an existing Analytic Extracted Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticExtractedReportById","tags":["Analytic Extracted Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Extracted Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"basename":{"type":"string"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"savename":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"status":{"type":"string","default":"Loading"},"type":{"type":"string","enum":["manual","scheduled"],"default":"manual"},"reportId":{"type":"integer"},"reportType":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticExtractedReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticExtractedReport not found"}}}},"/analytics/extracted_reports/{id}/download":{"get":{"summary":"Download Extracted Report","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Analytic Extracted Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticExtractedReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/extracted_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Extracted Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticExtractedReportById","tags":["Analytic Extracted Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticExtractedReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticExtractedReport not found"}}}},"/analytics/field_reports":{"get":{"summary":"Gets a list of Analytic Field Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticFieldReport","tags":["Analytic Field Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticFieldReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Field Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticFieldReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Field Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticFieldReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Field Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticFieldReport","tags":["Analytic Field Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Field Report","content":{"application/json":{"schema":{"type":"object","properties":{"field":{"type":"string"},"alias":{"type":"string"},"function":{"type":"string"},"format":{"type":"string"},"groupBy":{"type":"boolean","default":false},"orderBy":{"type":"string"},"custom":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"AnalyticFieldReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticFieldReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/field_reports/{id}":{"get":{"summary":"Gets a single Analytic Field Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticFieldReportById","tags":["Analytic Field Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticFieldReport to get"}],"responses":{"200":{"description":"AnalyticFieldReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticFieldReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticFieldReport not found"}}},"put":{"summary":"Update an existing Analytic Field Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticFieldReportById","tags":["Analytic Field Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Field Report","content":{"application/json":{"schema":{"type":"object","properties":{"field":{"type":"string"},"alias":{"type":"string"},"function":{"type":"string"},"format":{"type":"string"},"groupBy":{"type":"boolean","default":false},"orderBy":{"type":"string"},"custom":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticFieldReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticFieldReport not found"}}},"delete":{"summary":"Deletes many Analytic Field Reports","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticFieldReport","tags":["Analytic Field Reports"],"parameters":[{"in":"query","name":"ids","style":"form","explode":false,"schema":{"type":"integer"},"required":true,"description":"Numeric ids of the AnalyticFieldReport to be deleted, as a comma-separated list. E.g. `ids=1,2,3` deletes elements with id = 1, 2 and 3"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticFieldReport not found"}}}},"/analytics/field_reports/create_many":{"post":{"summary":"Creates many Analytic Field Reports","security":[{"BearerAuth":[]}],"operationId":"createManyAnalyticFieldReport","tags":["Analytic Field Reports"],"requestBody":{"required":true,"description":"data for the creation of many Analytic Field Reports","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"alias":{"type":"string"},"function":{"type":"string"},"format":{"type":"string"},"groupBy":{"type":"boolean","default":false},"orderBy":{"type":"string"},"custom":{"type":"boolean","default":false}}}}}}},"responses":{"201":{"description":"Successfully created."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/field_reports/{id}/create_many":{"post":{"summary":"Rewrite fields set","security":[{"BearerAuth":[]}],"operationId":"addFields","tags":["Analytic Field Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticFieldReport"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/field_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Field Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticFieldReportById","tags":["Analytic Field Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticFieldReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticFieldReport not found"}}}},"/analytics/metrics":{"get":{"summary":"Gets a list of Analytic Metric","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticMetric","tags":["Analytic Metrics"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticMetric"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Metric","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticMetric"}}}}},"206":{"description":"Partial (paged) collection of Analytic Metric","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticMetric"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Metrics","security":[{"BearerAuth":[]}],"operationId":"createAnalyticMetric","tags":["Analytic Metrics"],"requestBody":{"required":true,"description":"data for creating a new Analytic Metrics","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"table":{"type":"string"},"metric":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"AnalyticMetric successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticMetric"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/metrics/{id}":{"get":{"summary":"Gets a single Analytic Metrics","security":[{"BearerAuth":[]}],"operationId":"getAnalyticMetricById","tags":["Analytic Metrics"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticMetric to get"}],"responses":{"200":{"description":"AnalyticMetric with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticMetric"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticMetric not found"}}},"put":{"summary":"Update an existing Analytic Metrics","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticMetricById","tags":["Analytic Metrics"],"requestBody":{"required":true,"description":"data for updating a new Analytic Metrics","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"table":{"type":"string"},"metric":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticMetric to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticMetric not found"}}}},"/analytics/metrics/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Metrics","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticMetricById","tags":["Analytic Metrics"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticMetric to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticMetric not found"}}}},"/analytics/tree_reports":{"get":{"summary":"Gets a list of Analytic Tree Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticTreeReport","tags":["Analytic Tree Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticTreeReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Tree Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticTreeReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Tree Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticTreeReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Tree Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticTreeReport","tags":["Analytic Tree Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Tree Report","content":{"application/json":{"schema":{"type":"object","properties":{"tree":{"type":"string"}},"required":["tree"]}}}},"responses":{"201":{"description":"AnalyticTreeReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticTreeReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/tree_reports/{id}":{"get":{"summary":"Gets a single Analytic Tree Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticTreeReportById","tags":["Analytic Tree Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticTreeReport to get"}],"responses":{"200":{"description":"AnalyticTreeReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticTreeReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticTreeReport not found"}}},"put":{"summary":"Update an existing Analytic Tree Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticTreeReportById","tags":["Analytic Tree Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Tree Report","content":{"application/json":{"schema":{"type":"object","properties":{"tree":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticTreeReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticTreeReport not found"}}}},"/analytics/tree_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Tree Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticTreeReportById","tags":["Analytic Tree Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticTreeReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticTreeReport not found"}}}},"/attachments":{"get":{"summary":"Gets a list of Attachments","security":[{"BearerAuth":[]}],"operationId":"listAllAttachment","tags":["Attachments"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Attachment"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Attachments","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}},"206":{"description":"Partial (paged) collection of Attachments","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/attachments/{id}":{"get":{"summary":"Gets a single Attachment","security":[{"BearerAuth":[]}],"operationId":"getAttachmentById","tags":["Attachments"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Attachment to get"}],"responses":{"200":{"description":"Attachment with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attachment"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Attachment not found"}}},"put":{"summary":"Update an existing Attachment","security":[{"BearerAuth":[]}],"operationId":"updateAttachmentById","tags":["Attachments"],"requestBody":{"required":true,"description":"data for updating a new Attachment","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"basename":{"type":"string"},"type":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Attachment to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Attachment not found"}}}},"/attachments/{id}/download":{"get":{"summary":"Download attachment","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Attachments"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Attachment"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/attachments/clone":{"post":{"summary":"Clone an existing Attachment","security":[{"BearerAuth":[]}],"operationId":"cloneAttachment","tags":["Attachments"],"requestBody":{"required":true,"description":"data for creating a new Attachment","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Attachment to clone"},"name":{"type":"string"},"basename":{"type":"string"},"type":{"type":"string"}},"required":["id"]}}}},"responses":{"201":{"description":"Attachment successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attachment"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/attachments/":{"post":{"summary":"Add attachment","security":[{"BearerAuth":[]}],"operationId":"postcreate","tags":["Attachments"],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/attachments/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Attachment","security":[{"BearerAuth":[]}],"operationId":"deleteAttachmentById","tags":["Attachments"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Attachment to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Attachment not found"}}}},"/auth/google":{"post":{"summary":"Creates a new User token using Google login","operationId":"googleLogin","tags":["Authentication"],"requestBody":{"required":true,"description":"Google user credentials","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"the username"},"password":{"type":"string","format":"password","description":"the user password"}},"required":["name","password"]}}}},"responses":{"201":{"description":"login success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"user id"},"statusCall":{"type":"string","description":"user call status"},"token":{"type":"string","description":"jwt for authenticated calls"}}}}}},"401":{"description":"Not authenticated","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"the authentication error"}}}}}}}}},"/auth/local":{"post":{"summary":"Creates a new User token","operationId":"localLogin","tags":["Authentication"],"requestBody":{"required":true,"description":"user credentials","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"the username"},"password":{"type":"string","format":"password","description":"the user password"}},"required":["name","password"]}}}},"responses":{"201":{"description":"login success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"user id"},"statusCall":{"type":"string","description":"user call status"},"token":{"type":"string","description":"jwt for authenticated calls"}}}}}},"401":{"description":"Not authenticated","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"the authentication error"}}}}}}}}},"/auth/local/forgot":{"post":{"summary":"Creates a new password reset token","operationId":"localForgotPassword","tags":["Authentication"],"requestBody":{"required":true,"description":"the email to which the reset token will be sent","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"the user email used during registration"}},"required":["email"]}}}},"responses":{"201":{"description":"password reset token successfully issued"}}}},"/auth/local/reset/{token}":{"post":{"summary":"Reset user password","operationId":"localResetPassword","tags":["Authentication"],"parameters":[{"in":"path","name":"token","schema":{"type":"string"},"required":true,"description":"token issued by `/auth/local/forgot`"}],"requestBody":{"required":true,"description":"the new password for the user","content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","format":"password","description":"the new user password"}},"required":["password"]}}}},"responses":{"201":{"description":"password reset success"}}}},"/automations":{"get":{"summary":"Gets a list of Automations","security":[{"BearerAuth":[]}],"operationId":"listAllAutomation","tags":["Automations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Automation"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Automations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation"}}}}},"206":{"description":"Partial (paged) collection of Automations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Automation","security":[{"BearerAuth":[]}],"operationId":"createAutomation","tags":["Automations"],"requestBody":{"required":true,"description":"data for creating a new Automation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"string"},"description":{"type":"string"},"status":{"type":"boolean","default":false},"timeout":{"type":"integer","default":10}},"required":["name"]}}}},"responses":{"201":{"description":"Automation successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/automations/{id}":{"get":{"summary":"Gets a single Automation","security":[{"BearerAuth":[]}],"operationId":"getAutomationById","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation to get"}],"responses":{"200":{"description":"Automation with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Automation not found"}}},"put":{"summary":"Update an existing Automation","security":[{"BearerAuth":[]}],"operationId":"updateAutomationById","tags":["Automations"],"requestBody":{"required":true,"description":"data for updating a new Automation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"string"},"description":{"type":"string"},"status":{"type":"boolean","default":false},"timeout":{"type":"integer","default":10}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Automation not found"}}}},"/automations/{id}/conditions":{"get":{"summary":"Gets Automation Conditions","security":[{"BearerAuth":[]}],"operationId":"getConditions","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new conditions","security":[{"BearerAuth":[]}],"operationId":"addConditions","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/automations/{id}/actions":{"get":{"summary":"Gets Automation Actions","security":[{"BearerAuth":[]}],"operationId":"getActions","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new actions","security":[{"BearerAuth":[]}],"operationId":"addActions","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/automations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Automation","security":[{"BearerAuth":[]}],"operationId":"deleteAutomationById","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Automation not found"}}}},"/campaigns":{"get":{"summary":"Gets a list of IVR Campaigns","security":[{"BearerAuth":[]}],"operationId":"listAllCampaign","tags":["IVR Campaigns"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Campaign"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of IVR Campaigns","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}}}}},"206":{"description":"Partial (paged) collection of IVR Campaigns","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"createCampaign","tags":["IVR Campaigns"],"requestBody":{"required":true,"description":"data for creating a new IVR Campaign","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["ivr"],"default":"ivr"},"description":{"type":"string"},"active":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"limitCalls":{"type":"integer","description":"Max 200 calls.","default":30},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialPrefix":{"type":"string","default":null},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150}},"required":["name","type"]}}}},"responses":{"201":{"description":"Campaign successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}":{"get":{"summary":"Gets a single IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"getCampaignById","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign to get"}],"responses":{"200":{"description":"Campaign with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Campaign not found"}}},"put":{"summary":"Update an existing IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"updateCampaignById","tags":["IVR Campaigns"],"requestBody":{"required":true,"description":"data for updating a new IVR Campaign","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["ivr"],"default":"ivr"},"description":{"type":"string"},"active":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"limitCalls":{"type":"integer","description":"Max 200 calls.","default":30},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialPrefix":{"type":"string","default":null},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Campaign not found"}}}},"/campaigns/{id}/hoppers":{"get":{"summary":"Gets IVR campaign hoppers","security":[{"BearerAuth":[]}],"operationId":"getHoppers","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/hopper_histories":{"get":{"summary":"Gets IVR campaign hopper histories","security":[{"BearerAuth":[]}],"operationId":"getHopperHistories","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/hopper_finals":{"get":{"summary":"Gets IVR campaign hopper finals","security":[{"BearerAuth":[]}],"operationId":"getHopperFinals","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/hopper_black":{"get":{"summary":"Gets IVR campaign hopper blacks","security":[{"BearerAuth":[]}],"operationId":"getHopperBlacks","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/lists":{"get":{"summary":"Get IVR campaign lists","security":[{"BearerAuth":[]}],"operationId":"getLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add lists to an IVR campaign","security":[{"BearerAuth":[]}],"operationId":"addLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove lists from an IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"removeLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/blacklists":{"get":{"summary":"Get IVR campaign blacklists","security":[{"BearerAuth":[]}],"operationId":"getBlackLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add blacklists to an IVR campaign","security":[{"BearerAuth":[]}],"operationId":"addBlackLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove blacklists from an IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"removeBlackLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/clone":{"post":{"summary":"Clone an existing IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"cloneCampaign","tags":["IVR Campaigns"],"requestBody":{"required":true,"description":"data for creating a new IVR Campaign","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the IVR Campaign to clone"},"name":{"type":"string"},"type":{"type":"string","enum":["ivr"],"default":"ivr"},"description":{"type":"string"},"active":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"limitCalls":{"type":"integer","description":"Max 200 calls.","default":30},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialPrefix":{"type":"string","default":null},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150}},"required":["id"]}}}},"responses":{"201":{"description":"Campaign successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/destroy_many":{"delete":{"summary":"Destroy an existing IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"deleteCampaignById","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Campaign not found"}}}},"/canned_answers":{"get":{"summary":"Gets a list of Canned Answers","security":[{"BearerAuth":[]}],"operationId":"listAllCannedAnswer","tags":["Canned Answers"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CannedAnswer"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Canned Answers","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CannedAnswer"}}}}},"206":{"description":"Partial (paged) collection of Canned Answers","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CannedAnswer"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/canned_answers/{id}":{"get":{"summary":"Gets a single Canned Answer","security":[{"BearerAuth":[]}],"operationId":"getCannedAnswerById","tags":["Canned Answers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CannedAnswer to get"}],"responses":{"200":{"description":"CannedAnswer with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CannedAnswer"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CannedAnswer not found"}}},"put":{"summary":"Update an existing Canned Answer","security":[{"BearerAuth":[]}],"operationId":"updateCannedAnswerById","tags":["Canned Answers"],"requestBody":{"required":true,"description":"data for updating a new Canned Answer","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CannedAnswer to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CannedAnswer not found"}}}},"/canned_answers/":{"post":{"summary":"Create a new canned answer","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Canned Answers"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/canned_answers/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Canned Answer","security":[{"BearerAuth":[]}],"operationId":"deleteCannedAnswerById","tags":["Canned Answers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CannedAnswer to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CannedAnswer not found"}}}},"/cdr":{"get":{"summary":"Gets a list of Cdrs","security":[{"BearerAuth":[]}],"operationId":"listAllCdr","tags":["cdr"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Cdr"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Cdrs","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cdr"}}}}},"206":{"description":"Partial (paged) collection of Cdrs","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cdr"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Cdr","security":[{"BearerAuth":[]}],"operationId":"createCdr","tags":["cdr"],"requestBody":{"required":true,"description":"data for creating a new Cdr","content":{"application/json":{"schema":{"type":"object","properties":{"calldate":{"type":"string","default":"1970-01-01 00:00:01"},"clid":{"type":"string"},"src":{"type":"string"},"dst":{"type":"string"},"dcontext":{"type":"string"},"channel":{"type":"string"},"dstchannel":{"type":"string"},"lastapp":{"type":"string"},"lastdata":{"type":"string"},"duration":{"type":"integer","default":0},"billsec":{"type":"integer","default":0},"disposition":{"type":"string"},"amaflags":{"type":"integer","default":0},"accountcode":{"type":"string"},"userfield":{"type":"string"},"uniqueid":{"type":"string"},"linkedid":{"type":"string"},"sequence":{"type":"string"},"peeraccount":{"type":"string"},"type":{"type":"string"},"tag":{"type":"string"}},"required":["calldate","duration","billsec","amaflags"]}}}},"responses":{"201":{"description":"Cdr successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cdr"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cdr/describe":{"get":{"summary":"Gets table info about Cdrs","security":[{"BearerAuth":[]}],"operationId":"describeCdr","tags":["cdr"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cdr/{id}":{"get":{"summary":"Gets a single Cdr","security":[{"BearerAuth":[]}],"operationId":"getCdrById","tags":["cdr"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Cdr to get"}],"responses":{"200":{"description":"Cdr with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cdr"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Cdr not found"}}},"put":{"summary":"Update an existing Cdr","security":[{"BearerAuth":[]}],"operationId":"updateCdrById","tags":["cdr"],"requestBody":{"required":true,"description":"data for updating a new Cdr","content":{"application/json":{"schema":{"type":"object","properties":{"calldate":{"type":"string","default":"1970-01-01 00:00:01"},"clid":{"type":"string"},"src":{"type":"string"},"dst":{"type":"string"},"dcontext":{"type":"string"},"channel":{"type":"string"},"dstchannel":{"type":"string"},"lastapp":{"type":"string"},"lastdata":{"type":"string"},"duration":{"type":"integer","default":0},"billsec":{"type":"integer","default":0},"disposition":{"type":"string"},"amaflags":{"type":"integer","default":0},"accountcode":{"type":"string"},"userfield":{"type":"string"},"uniqueid":{"type":"string"},"linkedid":{"type":"string"},"sequence":{"type":"string"},"peeraccount":{"type":"string"},"type":{"type":"string"},"tag":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Cdr to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Cdr not found"}}}},"/cdr/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Cdr","security":[{"BearerAuth":[]}],"operationId":"deleteCdrById","tags":["cdr"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Cdr to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Cdr not found"}}}},"/chat/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getChatApplicationById","tags":["Chat Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatApplication to get"}],"responses":{"200":{"description":"ChatApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateChatApplicationById","tags":["Chat Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatApplication not found"}}}},"/chat/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteChatApplicationById","tags":["Chat Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatApplication not found"}}}},"/chat/groups":{"get":{"summary":"Gets a list of Groups","security":[{"BearerAuth":[]}],"operationId":"listAllChatGroup","tags":["Chat Groups"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatGroup"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Groups","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatGroup"}}}}},"206":{"description":"Partial (paged) collection of Groups","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatGroup"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Group","security":[{"BearerAuth":[]}],"operationId":"createChatGroup","tags":["Chat Groups"],"requestBody":{"required":true,"description":"data for creating a new Group","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"write":{"type":"boolean","default":true}},"required":["name"]}}}},"responses":{"201":{"description":"ChatGroup successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatGroup"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/describe":{"get":{"summary":"Gets table info about Groups","security":[{"BearerAuth":[]}],"operationId":"describeChatGroup","tags":["Chat Groups"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/{id}":{"get":{"summary":"Gets a single Group","security":[{"BearerAuth":[]}],"operationId":"getChatGroupById","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup to get"}],"responses":{"200":{"description":"ChatGroup with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatGroup"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatGroup not found"}}},"put":{"summary":"Update an existing Group","security":[{"BearerAuth":[]}],"operationId":"updateChatGroupById","tags":["Chat Groups"],"requestBody":{"required":true,"description":"data for updating a new Group","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"write":{"type":"boolean","default":true}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatGroup not found"}}}},"/chat/groups/{id}/unread":{"get":{"summary":"Get unread chat group messages","security":[{"BearerAuth":[]}],"operationId":"getUnread","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/{id}/members":{"get":{"summary":"Gets Members","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add members to chat group","security":[{"BearerAuth":[]}],"operationId":"addMembers","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes members from a group","security":[{"BearerAuth":[]}],"operationId":"removeMembers","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/{id}/messages":{"get":{"summary":"Gets Messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new group message","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Group","security":[{"BearerAuth":[]}],"operationId":"deleteChatGroupById","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatGroup not found"}}}},"/chat/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllChatInteraction","tags":["Chat Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createChatInteraction","tags":["Chat Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"ratingValue":{"type":"integer"},"ratingType":{"type":"string","enum":["star","thumb"],"default":"star"},"ratingMessage":{"type":"string"},"pathTranscript":{"type":"string"},"mailTranscript":{"type":"string"},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"browserName":{"type":"string"},"browserVersion":{"type":"string"},"osName":{"type":"string"},"osVersion":{"type":"string"},"deviceModel":{"type":"string"},"deviceVendor":{"type":"string"},"deviceType":{"type":"string"},"referer":{"type":"string"},"customerIp":{"type":"string"},"formData":{"type":"string"},"read1stAt":{"type":"string"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"closeReason":{"type":"string"},"customerPort":{"type":"string"},"vidaooSessionId":{"type":"string"}},"required":["lastMsgDirection"]}}}},"responses":{"201":{"description":"ChatInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeChatInteraction","tags":["Chat Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/{id}":{"get":{"summary":"Gets a single Interaction","operationId":"getChatInteractionById","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction to get"}],"responses":{"200":{"description":"ChatInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInteraction"}}}},"404":{"description":"ChatInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateChatInteractionById","tags":["Chat Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"ratingValue":{"type":"integer"},"ratingType":{"type":"string","enum":["star","thumb"],"default":"star"},"ratingMessage":{"type":"string"},"pathTranscript":{"type":"string"},"mailTranscript":{"type":"string"},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"browserName":{"type":"string"},"browserVersion":{"type":"string"},"osName":{"type":"string"},"osVersion":{"type":"string"},"deviceModel":{"type":"string"},"deviceVendor":{"type":"string"},"deviceType":{"type":"string"},"referer":{"type":"string"},"customerIp":{"type":"string"},"formData":{"type":"string"},"read1stAt":{"type":"string"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"closeReason":{"type":"string"},"customerPort":{"type":"string"},"vidaooSessionId":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatInteraction not found"}}}},"/chat/interactions/{id}/attachment_download":{"get":{"summary":"Download attachment","operationId":"attachmentDownload","tags":["Attachments"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/chat/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","operationId":"addMessage","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"201":{"description":"successfully created"}}}},"/chat/interactions/{id}/my_messages":{"get":{"summary":"Gets interaction messages","operationId":"getMyMessages","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/chat/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/{id}/vidaoo":{"post":{"summary":"Create Vidaoo Session","security":[{"BearerAuth":[]}],"operationId":"createVidaooSession","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/{id}/attachment_upload":{"post":{"summary":"Add attachment","operationId":"postattachmentUpload","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."}}}},"/chat/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/{id}/custom_update":{"put":{"summary":"Update interaction","operationId":"customUpdate","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"successfully updated"}}}},"/chat/interactions/{id}/abandon":{"put":{"summary":"Abandon interaction","operationId":"abandon","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"successfully updated"}}}},"/chat/interactions/{id}/close":{"put":{"summary":"Close Interaction","operationId":"close","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"successfully updated"}}}},"/chat/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteChatInteractionById","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatInteraction not found"}}}},"/chat/internal/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllChatInternalMessage","tags":["Chat Internal Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatInternalMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatInternalMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatInternalMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createChatInternalMessage","tags":["Chat Internal Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"ChatInternalMessageId":{"type":"integer"}},"required":["body"]}}}},"responses":{"201":{"description":"ChatInternalMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInternalMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/internal/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeChatInternalMessage","tags":["Chat Internal Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/internal/messages/users":{"get":{"summary":"Gets Users Last Messages","security":[{"BearerAuth":[]}],"operationId":"getUsers","tags":["ChatInternalMessage"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/internal/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getChatInternalMessageById","tags":["Chat Internal Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInternalMessage to get"}],"responses":{"200":{"description":"ChatInternalMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInternalMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatInternalMessage not found"}}},"put":{"summary":"Update an existing Message","operationId":"updateChatInternalMessageById","tags":["Chat Internal Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"ChatInternalMessageId":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInternalMessage to be updated"}],"responses":{"200":{"description":"successful update"},"404":{"description":"ChatInternalMessage not found"}}}},"/chat/internal/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteChatInternalMessageById","tags":["Chat Internal Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInternalMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatInternalMessage not found"}}}},"/chat/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllChatMessage","tags":["Chat Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createChatMessage","tags":["Chat Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"secret":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"ChatMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeChatMessage","tags":["Chat Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getChatMessageById","tags":["Chat Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage to get"}],"responses":{"200":{"description":"ChatMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatMessage not found"}}},"put":{"summary":"Update an existing Message","operationId":"updateChatMessageById","tags":["Chat Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"secret":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage to be updated"}],"responses":{"200":{"description":"successful update"},"404":{"description":"ChatMessage not found"}}}},"/chat/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteChatMessageById","tags":["Chat Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatMessage not found"}}}},"/chat/offline_messages":{"get":{"summary":"Gets a list of OfflineMessages","security":[{"BearerAuth":[]}],"operationId":"listAllChatOfflineMessage","tags":["Chat Offline Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatOfflineMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of OfflineMessages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatOfflineMessage"}}}}},"206":{"description":"Partial (paged) collection of OfflineMessages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatOfflineMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new OfflineMessage","security":[{"BearerAuth":[]}],"operationId":"createChatOfflineMessage","tags":["Chat Offline Messages"],"requestBody":{"required":true,"description":"data for creating a new OfflineMessage","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"}},"required":["body"]}}}},"responses":{"201":{"description":"ChatOfflineMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatOfflineMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/offline_messages/describe":{"get":{"summary":"Gets table info about OfflineMessages","security":[{"BearerAuth":[]}],"operationId":"describeChatOfflineMessage","tags":["Chat Offline Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/offline_messages/{id}":{"get":{"summary":"Gets a single OfflineMessage","security":[{"BearerAuth":[]}],"operationId":"getChatOfflineMessageById","tags":["Chat Offline Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatOfflineMessage to get"}],"responses":{"200":{"description":"ChatOfflineMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatOfflineMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatOfflineMessage not found"}}},"put":{"summary":"Update an existing OfflineMessage","security":[{"BearerAuth":[]}],"operationId":"updateChatOfflineMessageById","tags":["Chat Offline Messages"],"requestBody":{"required":true,"description":"data for updating a new OfflineMessage","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatOfflineMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatOfflineMessage not found"}}}},"/chat/offline_messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing OfflineMessage","security":[{"BearerAuth":[]}],"operationId":"deleteChatOfflineMessageById","tags":["Chat Offline Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatOfflineMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatOfflineMessage not found"}}}},"/chat/proactive_actions/{id}":{"get":{"summary":"Gets a single Proactive Action","security":[{"BearerAuth":[]}],"operationId":"getChatProactiveActionById","tags":["Chat Proactive Actions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatProactiveAction to get"}],"responses":{"200":{"description":"ChatProactiveAction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatProactiveAction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatProactiveAction not found"}}},"put":{"summary":"Update an existing Proactive Action","security":[{"BearerAuth":[]}],"operationId":"updateChatProactiveActionById","tags":["Chat Proactive Actions"],"requestBody":{"required":true,"description":"data for updating a new Proactive Action","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["mouseOver","timeout"],"default":"mouseOver"},"selector":{"type":"string"},"timeout":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatProactiveAction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatProactiveAction not found"}}}},"/chat/proactive_actions":{"post":{"summary":"Creates a new Proactive Action","security":[{"BearerAuth":[]}],"operationId":"createChatProactiveAction","tags":["Chat Proactive Actions"],"requestBody":{"required":true,"description":"data for creating a new Proactive Action","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["mouseOver","timeout"],"default":"mouseOver"},"selector":{"type":"string"},"timeout":{"type":"integer"}},"required":["name"]}}}},"responses":{"201":{"description":"ChatProactiveAction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatProactiveAction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/proactive_actions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Proactive Action","security":[{"BearerAuth":[]}],"operationId":"deleteChatProactiveActionById","tags":["Chat Proactive Actions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatProactiveAction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatProactiveAction not found"}}}},"/chat/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllChatQueue","tags":["Chat Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createChatQueue","tags":["Chat Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}},"required":["name"]}}}},"responses":{"201":{"description":"ChatQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeChatQueue","tags":["Chat Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getChatQueueById","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue to get"}],"responses":{"200":{"description":"ChatQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateChatQueueById","tags":["Chat Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueue not found"}}}},"/chat/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteChatQueueById","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueue not found"}}}},"/chat/reports/queue":{"get":{"summary":"Gets a list of Chat Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllChatQueueReport","tags":["Chat Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Chat Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Chat Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Chat Queue Report","security":[{"BearerAuth":[]}],"operationId":"createChatQueueReport","tags":["Chat Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Chat Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"ChatQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/reports/queue/describe":{"get":{"summary":"Gets table info about Chat Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeChatQueueReport","tags":["Chat Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/reports/queue/{id}":{"get":{"summary":"Gets a single Chat Queue Report","security":[{"BearerAuth":[]}],"operationId":"getChatQueueReportById","tags":["Chat Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueueReport to get"}],"responses":{"200":{"description":"ChatQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueueReport not found"}}},"put":{"summary":"Update an existing Chat Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateChatQueueReportById","tags":["Chat Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Chat Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueueReport not found"}}}},"/chat/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Chat Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteChatQueueReportById","tags":["Chat Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueueReport not found"}}}},"/chat/reports/transfer":{"get":{"summary":"Gets a list of Chat Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllChatTransferReport","tags":["Chat Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Chat Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Chat Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Chat Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createChatTransferReport","tags":["Chat Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Chat Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"ChatTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/reports/transfer/describe":{"get":{"summary":"Gets table info about Chat Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeChatTransferReport","tags":["Chat Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/reports/transfer/{id}":{"get":{"summary":"Gets a single Chat Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getChatTransferReportById","tags":["Chat Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatTransferReport to get"}],"responses":{"200":{"description":"ChatTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatTransferReport not found"}}},"put":{"summary":"Update an existing Chat Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateChatTransferReportById","tags":["Chat Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Chat Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatTransferReport not found"}}}},"/chat/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Chat Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteChatTransferReportById","tags":["Chat Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatTransferReport not found"}}}},"/chat/websites":{"get":{"summary":"Gets a list of Websites","security":[{"BearerAuth":[]}],"operationId":"listAllChatWebsite","tags":["Chat Websites"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatWebsite"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Websites","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatWebsite"}}}}},"206":{"description":"Partial (paged) collection of Websites","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatWebsite"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Website","security":[{"BearerAuth":[]}],"operationId":"createChatWebsite","tags":["Chat Websites"],"requestBody":{"required":true,"description":"data for creating a new Website","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"description":{"type":"string"},"mapKey":{"type":"string","default":"email"},"mapKeyOffline":{"type":"string","default":"email"},"key":{"type":"string"},"agentAlias":{"type":"string","default":"Agent"},"customerAlias":{"type":"string","default":"Me"},"color":{"type":"string","default":"#011F6A"},"color_button":{"type":"string","default":"#011F6A"},"textColor":{"type":"string","default":"#ffffff"},"fontSize":{"type":"integer","default":15},"remote":{"type":"string"},"animation":{"type":"boolean","default":true},"header_shape":{"type":"string","enum":["rounded","squared"],"default":"rounded"},"header_online":{"type":"string","default":"We are here!"},"start_chat_button":{"type":"string","default":"Chat"},"offline_chat_button":{"type":"string","default":"Send"},"header_offline":{"type":"string","default":"Contact us"},"download_transcript":{"type":"boolean","default":true},"timeout":{"type":"integer","default":0},"whiteLabel":{"type":"string","default":"Powered by xCALLY"},"defaultWhiteLabel":{"type":"boolean","default":true},"sitepic":{"type":"string"},"closingQuestion":{"type":"string","default":"Do you want to close the interaction?"},"formSubmitSuccessMessage":{"type":"string","default":"Form properly submitted"},"formSubmitFailureMessage":{"type":"string","default":"Form submission error"},"noteTitle":{"type":"string","default":"Note"},"placeholderMessage":{"type":"string","default":"Type a message"},"closingMessage":{"type":"string","default":"Thanks you for your time!"},"closingMessageButton":{"type":"string","default":"Send"},"skipMessageButton":{"type":"string","default":"Skip"},"conditionAgreement":{"type":"boolean","default":false},"enableRating":{"type":"boolean","default":false},"enableFeedback":{"type":"boolean","default":false},"enableSendButton":{"type":"boolean","default":false},"feedbackTitle":{"type":"string","default":"Feedback"},"ratingType":{"type":"string","enum":["star","thumb"],"default":"star"},"ratingStarsNumber":{"type":"integer","default":5},"onlineForm":{"type":"string","default":"{\"items\":[{\"type\":\"input\",\"variable\":null,\"config\":{\"placeholder\":\"name\",\"type\":\"text\",\"required\":true},\"props\":{\"title\":\"name\",\"helpText\":\"\"}},{\"type\":\"input\",\"props\":{\"title\":\"email\",\"helpText\":\"\"},\"config\":{\"required\":true,\"placeholder\":\"email\",\"type\":\"email\"},\"variable\":null}],\"fromKey\":1}"},"offlineForm":{"type":"string","default":"{\"items\":[{\"type\":\"input\",\"props\":{\"title\":\"email\",\"helpText\":\"\"},\"config\":{\"required\":true,\"placeholder\":\"email\",\"type\":\"email\"},\"variable\":null},{\"type\":\"textarea\",\"config\":{\"placeholder\":\"Comments\"},\"props\":{\"title\":\"Comments\",\"helpText\":\"Leave your comments\"}}],\"fromKey\":0}"},"token":{"type":"string","default":"6NYikaKczHDsD4EV1s72ZpdP7g2lv37W"},"autoclose":{"type":"boolean","default":true},"enableCustomerWriting":{"type":"boolean","default":false},"forwardTranscript":{"type":"boolean","default":false},"forwardTranscriptMessage":{"type":"string"},"forwardOffline":{"type":"boolean","default":false},"forwardOfflineAddress":{"type":"string"},"waitingTitle":{"type":"string","default":"All of our agents are busy at this time. Your chat is very important to us."},"waitingMessage":{"type":"string","default":"Please hold and we will answer your request as soon as possible."},"offlineMessageSubject":{"type":"string","default":"New offline message from websiteName"},"offlineMessageBody":{"type":"string","default":"You received a new offline message from websiteName. Here you can find the details of the request:"},"enableUnmanagedNote":{"type":"boolean","default":true},"unmanagedMessage":{"type":"string","default":"Your request has not been processed."},"skipUnmanaged":{"type":"string","default":"Skip"},"sendUnmanaged":{"type":"string","default":"Send"},"enableCustomerAttachment":{"type":"boolean","default":false},"enableCustomerCheckmarks":{"type":"boolean","default":false},"agentAvatar":{"type":"string"},"showAgentAvatar":{"type":"boolean","default":false},"timezone":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"hideWhenOffline":{"type":"boolean","default":false},"agentIdentifier":{"type":"string","default":"website_alias"},"waitForTheAssignedAgent":{"type":"integer","default":10},"alignment":{"type":"string","default":"bottom_right"},"verticalAlignment":{"type":"integer","default":30},"messagesAlignment":{"type":"string","default":"alternate"},"defaultTitle":{"type":"string"},"customerAvatar":{"type":"string"},"showCustomerAvatar":{"type":"boolean","default":false},"messageFontSize":{"type":"integer","default":12},"backgroundColor":{"type":"string","default":"#fafafa"},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"systemAlias":{"type":"string","default":"System"},"systemAvatar":{"type":"string"},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"vidaooEscalation":{"type":"boolean","default":false},"vidaooApiKey":{"type":"string","default":false}},"required":["name","address","key","color","color_button","textColor","backgroundColor"]}}}},"responses":{"201":{"description":"ChatWebsite successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatWebsite"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/describe":{"get":{"summary":"Gets table info about Websites","security":[{"BearerAuth":[]}],"operationId":"describeChatWebsite","tags":["Chat Websites"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}":{"get":{"summary":"Gets a single Website","security":[{"BearerAuth":[]}],"operationId":"getChatWebsiteById","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite to get"}],"responses":{"200":{"description":"ChatWebsite with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatWebsite"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatWebsite not found"}}},"put":{"summary":"Update an existing Website","security":[{"BearerAuth":[]}],"operationId":"updateChatWebsiteById","tags":["Chat Websites"],"requestBody":{"required":true,"description":"data for updating a new Website","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"description":{"type":"string"},"mapKey":{"type":"string","default":"email"},"mapKeyOffline":{"type":"string","default":"email"},"key":{"type":"string"},"agentAlias":{"type":"string","default":"Agent"},"customerAlias":{"type":"string","default":"Me"},"color":{"type":"string","default":"#011F6A"},"color_button":{"type":"string","default":"#011F6A"},"textColor":{"type":"string","default":"#ffffff"},"fontSize":{"type":"integer","default":15},"remote":{"type":"string"},"animation":{"type":"boolean","default":true},"header_shape":{"type":"string","enum":["rounded","squared"],"default":"rounded"},"header_online":{"type":"string","default":"We are here!"},"start_chat_button":{"type":"string","default":"Chat"},"offline_chat_button":{"type":"string","default":"Send"},"header_offline":{"type":"string","default":"Contact us"},"download_transcript":{"type":"boolean","default":true},"timeout":{"type":"integer","default":0},"whiteLabel":{"type":"string","default":"Powered by xCALLY"},"defaultWhiteLabel":{"type":"boolean","default":true},"sitepic":{"type":"string"},"closingQuestion":{"type":"string","default":"Do you want to close the interaction?"},"formSubmitSuccessMessage":{"type":"string","default":"Form properly submitted"},"formSubmitFailureMessage":{"type":"string","default":"Form submission error"},"noteTitle":{"type":"string","default":"Note"},"placeholderMessage":{"type":"string","default":"Type a message"},"closingMessage":{"type":"string","default":"Thanks you for your time!"},"closingMessageButton":{"type":"string","default":"Send"},"skipMessageButton":{"type":"string","default":"Skip"},"conditionAgreement":{"type":"boolean","default":false},"enableRating":{"type":"boolean","default":false},"enableFeedback":{"type":"boolean","default":false},"enableSendButton":{"type":"boolean","default":false},"feedbackTitle":{"type":"string","default":"Feedback"},"ratingType":{"type":"string","enum":["star","thumb"],"default":"star"},"ratingStarsNumber":{"type":"integer","default":5},"onlineForm":{"type":"string","default":"{\"items\":[{\"type\":\"input\",\"variable\":null,\"config\":{\"placeholder\":\"name\",\"type\":\"text\",\"required\":true},\"props\":{\"title\":\"name\",\"helpText\":\"\"}},{\"type\":\"input\",\"props\":{\"title\":\"email\",\"helpText\":\"\"},\"config\":{\"required\":true,\"placeholder\":\"email\",\"type\":\"email\"},\"variable\":null}],\"fromKey\":1}"},"offlineForm":{"type":"string","default":"{\"items\":[{\"type\":\"input\",\"props\":{\"title\":\"email\",\"helpText\":\"\"},\"config\":{\"required\":true,\"placeholder\":\"email\",\"type\":\"email\"},\"variable\":null},{\"type\":\"textarea\",\"config\":{\"placeholder\":\"Comments\"},\"props\":{\"title\":\"Comments\",\"helpText\":\"Leave your comments\"}}],\"fromKey\":0}"},"token":{"type":"string","default":"sUS2aAfQTKplrp7C7e7Y0msoJi1Tvt11"},"autoclose":{"type":"boolean","default":true},"enableCustomerWriting":{"type":"boolean","default":false},"forwardTranscript":{"type":"boolean","default":false},"forwardTranscriptMessage":{"type":"string"},"forwardOffline":{"type":"boolean","default":false},"forwardOfflineAddress":{"type":"string"},"waitingTitle":{"type":"string","default":"All of our agents are busy at this time. Your chat is very important to us."},"waitingMessage":{"type":"string","default":"Please hold and we will answer your request as soon as possible."},"offlineMessageSubject":{"type":"string","default":"New offline message from websiteName"},"offlineMessageBody":{"type":"string","default":"You received a new offline message from websiteName. Here you can find the details of the request:"},"enableUnmanagedNote":{"type":"boolean","default":true},"unmanagedMessage":{"type":"string","default":"Your request has not been processed."},"skipUnmanaged":{"type":"string","default":"Skip"},"sendUnmanaged":{"type":"string","default":"Send"},"enableCustomerAttachment":{"type":"boolean","default":false},"enableCustomerCheckmarks":{"type":"boolean","default":false},"agentAvatar":{"type":"string"},"showAgentAvatar":{"type":"boolean","default":false},"timezone":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"hideWhenOffline":{"type":"boolean","default":false},"agentIdentifier":{"type":"string","default":"website_alias"},"waitForTheAssignedAgent":{"type":"integer","default":10},"alignment":{"type":"string","default":"bottom_right"},"verticalAlignment":{"type":"integer","default":30},"messagesAlignment":{"type":"string","default":"alternate"},"defaultTitle":{"type":"string"},"customerAvatar":{"type":"string"},"showCustomerAvatar":{"type":"boolean","default":false},"messageFontSize":{"type":"integer","default":12},"backgroundColor":{"type":"string","default":"#fafafa"},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"systemAlias":{"type":"string","default":"System"},"systemAvatar":{"type":"string"},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"vidaooEscalation":{"type":"boolean","default":false},"vidaooApiKey":{"type":"string","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatWebsite not found"}}}},"/chat/websites/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/logo":{"get":{"summary":"Get logo","operationId":"getLogo","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add logo","security":[{"BearerAuth":[]}],"operationId":"postaddLogo","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/avatar":{"get":{"summary":"Get avatar","operationId":"getAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add avatar","security":[{"BearerAuth":[]}],"operationId":"postaddAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/customer_avatar":{"get":{"summary":"Get Customer Avatar","operationId":"getCustomerAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add customer avatar","security":[{"BearerAuth":[]}],"operationId":"postaddCustomerAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/system_avatar":{"get":{"summary":"Get System Avatar","operationId":"getSystemAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add system avatar","security":[{"BearerAuth":[]}],"operationId":"postaddSystemAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/interactions":{"get":{"summary":"Gets Website Interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new interactions","security":[{"BearerAuth":[]}],"operationId":"addInteraction","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/snippet":{"get":{"summary":"Gets Website Snippet","operationId":"getSnippet","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/chat/websites/{id}/applications":{"get":{"summary":"Gets Website Applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/proactive_actions":{"get":{"summary":"Gets Website Proactive Actions","security":[{"BearerAuth":[]}],"operationId":"getProactiveActions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new Proactive Actions","security":[{"BearerAuth":[]}],"operationId":"addProactiveActions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/fields":{"get":{"summary":"Gets Website Fields","operationId":"getFields","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/chat/websites/{id}/offline_messages":{"get":{"summary":"Gets Website Offline Messages","security":[{"BearerAuth":[]}],"operationId":"getOfflineMessages","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/users":{"get":{"summary":"Gets agents from website","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a website","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a website","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/notify":{"post":{"summary":"Notify new message","operationId":"notify","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"}}}},"/chat/websites/{id}/offline":{"post":{"summary":"Offline message","operationId":"offline","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"}}}},"/chat/websites/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Website","security":[{"BearerAuth":[]}],"operationId":"deleteChatWebsiteById","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatWebsite not found"}}}},"/cloudProviders":{"get":{"summary":"Gets a list of CloudProviders","security":[{"BearerAuth":[]}],"operationId":"listAllCloudProvider","tags":["CloudProviders"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CloudProvider"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of CloudProviders","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudProvider"}}}}},"206":{"description":"Partial (paged) collection of CloudProviders","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudProvider"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new CloudProvider","security":[{"BearerAuth":[]}],"operationId":"createCloudProvider","tags":["CloudProviders"],"requestBody":{"required":true,"description":"data for creating a new CloudProvider","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"service":{"type":"string","enum":["AmazonAWS","Google"]},"data1":{"type":"string"},"data2":{"type":"string"}},"required":["name","service"]}}}},"responses":{"201":{"description":"CloudProvider successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudProvider"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cloudProviders/{id}":{"get":{"summary":"Gets a single CloudProvider","security":[{"BearerAuth":[]}],"operationId":"getCloudProviderById","tags":["CloudProviders"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CloudProvider to get"}],"responses":{"200":{"description":"CloudProvider with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudProvider"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CloudProvider not found"}}},"put":{"summary":"Update an existing CloudProvider","security":[{"BearerAuth":[]}],"operationId":"updateCloudProviderById","tags":["CloudProviders"],"requestBody":{"required":true,"description":"data for updating a new CloudProvider","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"service":{"type":"string","enum":["AmazonAWS","Google"]},"data1":{"type":"string"},"data2":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CloudProvider to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CloudProvider not found"}}}},"/cloudProviders/{id}/destroy_many":{"delete":{"summary":"Destroy an existing CloudProvider","security":[{"BearerAuth":[]}],"operationId":"deleteCloudProviderById","tags":["CloudProviders"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CloudProvider to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CloudProvider not found"}}}},"/cm/companies":{"get":{"summary":"Gets a list of Companies","security":[{"BearerAuth":[]}],"operationId":"listAllCmCompany","tags":["Cm Companies"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmCompany"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Companies","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmCompany"}}}}},"206":{"description":"Partial (paged) collection of Companies","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmCompany"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Company","security":[{"BearerAuth":[]}],"operationId":"createCmCompany","tags":["Cm Companies"],"requestBody":{"required":true,"description":"data for creating a new Company","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"vat":{"type":"string"},"companyId":{"type":"string"},"website":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"type":{"type":"string"},"street":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"emailDomain":{"type":"string"},"sStreet":{"type":"string"},"sPostalCode":{"type":"string"},"sCity":{"type":"string"},"sCountry":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"CmCompany successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmCompany"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/companies/describe":{"get":{"summary":"Gets table info about Companies","security":[{"BearerAuth":[]}],"operationId":"describeCmCompany","tags":["Cm Companies"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/companies/{id}":{"get":{"summary":"Gets a single Company","security":[{"BearerAuth":[]}],"operationId":"getCmCompanyById","tags":["Cm Companies"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany to get"}],"responses":{"200":{"description":"CmCompany with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmCompany"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCompany not found"}}},"put":{"summary":"Update an existing Company","security":[{"BearerAuth":[]}],"operationId":"updateCmCompanyById","tags":["Cm Companies"],"requestBody":{"required":true,"description":"data for updating a new Company","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"vat":{"type":"string"},"companyId":{"type":"string"},"website":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"type":{"type":"string"},"street":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"emailDomain":{"type":"string"},"sStreet":{"type":"string"},"sPostalCode":{"type":"string"},"sCity":{"type":"string"},"sCountry":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCompany not found"}}}},"/cm/companies/{id}/contacts":{"get":{"summary":"Gets List Contacts","security":[{"BearerAuth":[]}],"operationId":"getContacts","tags":["Cm Companies"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new contacts","security":[{"BearerAuth":[]}],"operationId":"addContacts","tags":["Cm Companies"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/companies/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Company","security":[{"BearerAuth":[]}],"operationId":"deleteCmCompanyById","tags":["Cm Companies"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCompany not found"}}}},"/cm/contacts":{"get":{"summary":"Gets a list of Contacts","security":[{"BearerAuth":[]}],"operationId":"listAllCmContact","tags":["Cm Contacts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmContact"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Contacts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmContact"}}}}},"206":{"description":"Partial (paged) collection of Contacts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmContact"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/describe":{"get":{"summary":"Gets table info about Contacts","security":[{"BearerAuth":[]}],"operationId":"describeCmContact","tags":["Cm Contacts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}":{"get":{"summary":"Gets a single Contact","security":[{"BearerAuth":[]}],"operationId":"show","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"put":{"summary":"Update a single Contact","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/tags":{"get":{"summary":"Gets configurations tags","security":[{"BearerAuth":[]}],"operationId":"getTags","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Sets new tags","security":[{"BearerAuth":[]}],"operationId":"setTags","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/hoppers":{"get":{"summary":"Gets contact hoppers","security":[{"BearerAuth":[]}],"operationId":"getHoppers","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/hopper_histories":{"get":{"summary":"Gets contact hopper histories","security":[{"BearerAuth":[]}],"operationId":"getHopperHistories","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/hopper_finals":{"get":{"summary":"Gets contact hopper finals","security":[{"BearerAuth":[]}],"operationId":"getHopperFinals","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/jscripty_sessions":{"get":{"summary":"Gets contact hopper blacks","security":[{"BearerAuth":[]}],"operationId":"getJscriptySessions","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/merge":{"post":{"summary":"Merge Contact","security":[{"BearerAuth":[]}],"operationId":"merge","tags":["Cm Contacts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/":{"post":{"summary":"Create Contact","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Cm Contacts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/create_many":{"post":{"summary":"Create Contacts","security":[{"BearerAuth":[]}],"operationId":"bulkCreate","tags":["Cm Contacts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/upload":{"post":{"summary":"Upload csv","security":[{"BearerAuth":[]}],"operationId":"postupload","tags":["Cm contacts"],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/upload/{id}":{"post":{"summary":"Import new contacts by csv","security":[{"BearerAuth":[]}],"operationId":"import","tags":["Cm contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Contact","security":[{"BearerAuth":[]}],"operationId":"deleteCmContactById","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmContact not found"}}}},"/cm/custom_fields":{"get":{"summary":"Gets a list of Custom Fields","security":[{"BearerAuth":[]}],"operationId":"listAllCmCustomField","tags":["Cm Custom Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmCustomField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Custom Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmCustomField"}}}}},"206":{"description":"Partial (paged) collection of Custom Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmCustomField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/custom_fields/{id}":{"get":{"summary":"Gets a single Custom Field","security":[{"BearerAuth":[]}],"operationId":"getCmCustomFieldById","tags":["Cm Custom Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCustomField to get"}],"responses":{"200":{"description":"CmCustomField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmCustomField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCustomField not found"}}},"put":{"summary":"Update an existing Custom Field","security":[{"BearerAuth":[]}],"operationId":"updateCmCustomFieldById","tags":["Cm Custom Fields"],"requestBody":{"required":true,"description":"data for updating a new Custom Field","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"type":{"type":"string"},"values":{"type":"string"},"required":{"type":"boolean","default":false},"clickToAction":{"type":"boolean","default":false},"actionType":{"type":"string","enum":["voice"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCustomField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCustomField not found"}}}},"/cm/custom_fields/":{"post":{"summary":"Create a new custom field","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Custom Fields"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/custom_fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Custom Field","security":[{"BearerAuth":[]}],"operationId":"deleteCmCustomFieldById","tags":["Cm Custom Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCustomField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCustomField not found"}}}},"/cm/hopper":{"get":{"summary":"Gets a list of Hopper","security":[{"BearerAuth":[]}],"operationId":"listAllCmHopper","tags":["Cm Hopper"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmHopper"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Hopper","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopper"}}}}},"206":{"description":"Partial (paged) collection of Hopper","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopper"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Hopper","security":[{"BearerAuth":[]}],"operationId":"createCmHopper","tags":["Cm Hopper"],"requestBody":{"required":true,"description":"data for creating a new Hopper","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"active":{"type":"boolean","default":false},"scheduledat":{"type":"string","default":"2020-11-27 10:41:25"},"countbusyretry":{"type":"integer","default":0},"countcongestionretry":{"type":"integer","default":0},"countnoanswerretry":{"type":"integer","default":0},"callback":{"type":"boolean","default":false},"callbackuniqueid":{"type":"string","default":null},"callbackat":{"type":"string"},"priority":{"type":"integer","default":2},"recallme":{"type":"boolean","default":false},"ContactId":{"type":"integer"},"ListId":{"type":"integer"},"UserId":{"type":"integer"},"VoiceQueueId":{"type":"integer"},"CampaignId":{"type":"integer"},"countnosuchnumberretry":{"type":"integer","default":0},"countdropretry":{"type":"integer","default":0},"countabandonedretry":{"type":"integer","default":0},"countmachineretry":{"type":"integer","default":0},"countagentrejectretry":{"type":"integer","default":0}},"required":["phone"]}}}},"responses":{"201":{"description":"CmHopper successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopper"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper/describe":{"get":{"summary":"Gets table info about Hopper","security":[{"BearerAuth":[]}],"operationId":"describeCmHopper","tags":["Cm Hopper"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper/opencontacts":{"get":{"summary":"Gets Open Contacts","security":[{"BearerAuth":[]}],"operationId":"getOpenContacts","tags":["Cm Hopper"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper/{id}":{"get":{"summary":"Gets a single Hopper","security":[{"BearerAuth":[]}],"operationId":"getCmHopperById","tags":["Cm Hopper"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopper to get"}],"responses":{"200":{"description":"CmHopper with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopper"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopper not found"}}},"put":{"summary":"Update an existing Hopper","security":[{"BearerAuth":[]}],"operationId":"updateCmHopperById","tags":["Cm Hopper"],"requestBody":{"required":true,"description":"data for updating a new Hopper","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"active":{"type":"boolean","default":false},"scheduledat":{"type":"string","default":"2020-11-27 10:41:25"},"countbusyretry":{"type":"integer","default":0},"countcongestionretry":{"type":"integer","default":0},"countnoanswerretry":{"type":"integer","default":0},"callback":{"type":"boolean","default":false},"callbackuniqueid":{"type":"string","default":null},"callbackat":{"type":"string"},"priority":{"type":"integer","default":2},"recallme":{"type":"boolean","default":false},"ContactId":{"type":"integer"},"ListId":{"type":"integer"},"UserId":{"type":"integer"},"VoiceQueueId":{"type":"integer"},"CampaignId":{"type":"integer"},"countnosuchnumberretry":{"type":"integer","default":0},"countdropretry":{"type":"integer","default":0},"countabandonedretry":{"type":"integer","default":0},"countmachineretry":{"type":"integer","default":0},"countagentrejectretry":{"type":"integer","default":0}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopper to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopper not found"}}},"delete":{"summary":"Delete Hopper","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Cm Hopper"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopper"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper/preview":{"post":{"summary":"Gets Preview Dialer Contacts","security":[{"BearerAuth":[]}],"operationId":"getPreview","tags":["Cm Hopper"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_black":{"get":{"summary":"Gets a list of Hopper Black","security":[{"BearerAuth":[]}],"operationId":"listAllCmHopperBlack","tags":["Cm Hopper Black"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmHopperBlack"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Hopper Black","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperBlack"}}}}},"206":{"description":"Partial (paged) collection of Hopper Black","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperBlack"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_black/describe":{"get":{"summary":"Gets table info about Hopper Black","security":[{"BearerAuth":[]}],"operationId":"describeCmHopperBlack","tags":["Cm Hopper Black"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_black/{id}":{"get":{"summary":"Gets a single Hopper Black","security":[{"BearerAuth":[]}],"operationId":"getCmHopperBlackById","tags":["Cm Hopper Black"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperBlack to get"}],"responses":{"200":{"description":"CmHopperBlack with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopperBlack"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperBlack not found"}}},"put":{"summary":"Update an existing Hopper Black","security":[{"BearerAuth":[]}],"operationId":"updateCmHopperBlackById","tags":["Cm Hopper Black"],"requestBody":{"required":true,"description":"data for updating a new Hopper Black","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"ContactId":{"type":"integer"},"ListId":{"type":"integer"},"VoiceQueueId":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperBlack to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperBlack not found"}}}},"/cm/hopper_black/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Hopper Black","security":[{"BearerAuth":[]}],"operationId":"deleteCmHopperBlackById","tags":["Cm Hopper Black"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperBlack to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperBlack not found"}}}},"/cm/hopper_final":{"get":{"summary":"Gets a list of HopperFinal","security":[{"BearerAuth":[]}],"operationId":"listAllCmHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmHopperFinal"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of HopperFinal","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperFinal"}}}}},"206":{"description":"Partial (paged) collection of HopperFinal","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperFinal"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/describe":{"get":{"summary":"Gets table info about HopperFinal","security":[{"BearerAuth":[]}],"operationId":"describeCmHopperFinal","tags":["Cm Hopper Final"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/{id}":{"get":{"summary":"Gets a single HopperFinal","security":[{"BearerAuth":[]}],"operationId":"getCmHopperFinalById","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal to get"}],"responses":{"200":{"description":"CmHopperFinal with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopperFinal"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperFinal not found"}}},"put":{"summary":"Update a single hopper final","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/voice/queue/countAttributes/{id}":{"get":{"summary":"Return number contacts for attributes","security":[{"BearerAuth":[]}],"operationId":"countContactsQueueCampaignHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/campaign/countAttributes/{id}":{"get":{"summary":"Return number contacts for attributes","security":[{"BearerAuth":[]}],"operationId":"countContactsIvrCampaignHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/voice/queue/moveContacts/{id}":{"post":{"summary":"Move contacts in hopper","security":[{"BearerAuth":[]}],"operationId":"moveContactsQueueCampaignHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/voice/campaign/moveContacts/{id}":{"post":{"summary":"Move contacts in hopper","security":[{"BearerAuth":[]}],"operationId":"moveContactsIvrCampaignHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/checkContactHopper":{"post":{"summary":"Check if contact is in hopper","security":[{"BearerAuth":[]}],"operationId":"checkContactHopper","tags":["Cm Hopper Final"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_history":{"get":{"summary":"Gets a list of HopperHistory","security":[{"BearerAuth":[]}],"operationId":"listAllCmHopperHistory","tags":["Cm Hopper History"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmHopperHistory"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of HopperHistory","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperHistory"}}}}},"206":{"description":"Partial (paged) collection of HopperHistory","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperHistory"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new HopperHistory","security":[{"BearerAuth":[]}],"operationId":"createCmHopperHistory","tags":["Cm Hopper History"],"requestBody":{"required":true,"description":"data for creating a new HopperHistory","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"integer"},"statedesc":{"type":"string"},"scheduledat":{"type":"string"},"countbusyretry":{"type":"integer","default":0},"countcongestionretry":{"type":"integer","default":0},"countnoanswerretry":{"type":"integer","default":0},"countglobal":{"type":"integer","default":0},"uniqueid":{"type":"string"},"originatecalleridnum":{"type":"string"},"originatecalleridname":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"starttime":{"type":"string"},"responsetime":{"type":"string"},"answertime":{"type":"string"},"droptime":{"type":"string"},"endtime":{"type":"string"},"ringtime":{"type":"integer","default":0},"holdtime":{"type":"integer","default":0},"talktime":{"type":"integer","default":0},"followuptime":{"type":"integer","default":0},"dropreason":{"type":"string"},"campaign":{"type":"string"},"campaigntype":{"type":"string"},"membername":{"type":"string"},"reason":{"type":"string"},"amd":{"type":"boolean","default":false},"fax":{"type":"boolean","default":false},"callback":{"type":"boolean","default":false},"callbackuniqueid":{"type":"string","default":null},"callbackat":{"type":"string"},"recallme":{"type":"boolean","default":false},"editedat":{"type":"string"},"edited":{"type":"boolean","default":false},"countnosuchnumberretry":{"type":"integer","default":0},"countdropretry":{"type":"integer","default":0},"countabandonedretry":{"type":"integer","default":0},"countmachineretry":{"type":"integer","default":0},"countagentrejectretry":{"type":"integer","default":0}}}}}},"responses":{"201":{"description":"CmHopperHistory successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopperHistory"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_history/describe":{"get":{"summary":"Gets table info about HopperHistory","security":[{"BearerAuth":[]}],"operationId":"describeCmHopperHistory","tags":["Cm Hopper History"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_history/{id}":{"get":{"summary":"Gets a single HopperHistory","security":[{"BearerAuth":[]}],"operationId":"getCmHopperHistoryById","tags":["Cm Hopper History"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperHistory to get"}],"responses":{"200":{"description":"CmHopperHistory with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopperHistory"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperHistory not found"}}},"put":{"summary":"Update a single hopper history","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Cm Hopper History"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperHistory"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists":{"get":{"summary":"Gets a list of Lists","security":[{"BearerAuth":[]}],"operationId":"listAllCmList","tags":["Cm Lists"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmList"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Lists","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmList"}}}}},"206":{"description":"Partial (paged) collection of Lists","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmList"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new List","security":[{"BearerAuth":[]}],"operationId":"createCmList","tags":["Cm Lists"],"requestBody":{"required":true,"description":"data for creating a new List","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"dialPrefix":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"CmList successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmList"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/describe":{"get":{"summary":"Gets table info about Lists","security":[{"BearerAuth":[]}],"operationId":"describeCmList","tags":["Cm Lists"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}":{"get":{"summary":"Gets a single List","security":[{"BearerAuth":[]}],"operationId":"getCmListById","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList to get"}],"responses":{"200":{"description":"CmList with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmList"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmList not found"}}},"put":{"summary":"Update an existing List","security":[{"BearerAuth":[]}],"operationId":"updateCmListById","tags":["Cm Lists"],"requestBody":{"required":true,"description":"data for updating a new List","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"dialPrefix":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmList not found"}}}},"/cm/lists/{id}/dispositions":{"get":{"summary":"Gets list dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/contacts":{"get":{"summary":"Gets List Contacts","security":[{"BearerAuth":[]}],"operationId":"getContacts","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new contacts","security":[{"BearerAuth":[]}],"operationId":"addContacts","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/contacts/csv":{"get":{"summary":"Gets CSV List Contacts","security":[{"BearerAuth":[]}],"operationId":"getContactsCsv","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/fields":{"get":{"summary":"Gets Custom Fields","security":[{"BearerAuth":[]}],"operationId":"getCustomFields","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new custom field","security":[{"BearerAuth":[]}],"operationId":"addCustomField","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/users":{"get":{"summary":"Gets agents from list","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Adds agents to a list","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a list","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/destroy_many":{"delete":{"summary":"Destroy an existing List","security":[{"BearerAuth":[]}],"operationId":"deleteCmListById","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmList not found"}}}},"/conditions/{id}":{"put":{"summary":"Update an existing Condition","security":[{"BearerAuth":[]}],"operationId":"updateConditionById","tags":["Conditions"],"requestBody":{"required":true,"description":"data for updating a new Condition","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Condition to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Condition not found"}}}},"/conditions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Condition","security":[{"BearerAuth":[]}],"operationId":"deleteConditionById","tags":["Conditions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Condition to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Condition not found"}}}},"/dashboards":{"get":{"summary":"Gets a list of Dashboards","security":[{"BearerAuth":[]}],"operationId":"listAllDashboard","tags":["Dashboards"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Dashboard"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dashboards","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}}}}},"206":{"description":"Partial (paged) collection of Dashboards","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Dashboard","security":[{"BearerAuth":[]}],"operationId":"createDashboard","tags":["Dashboards"],"requestBody":{"required":true,"description":"data for creating a new Dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Dashboard successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/{id}":{"get":{"summary":"Gets a single Dashboard","security":[{"BearerAuth":[]}],"operationId":"getDashboardById","tags":["Dashboards"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard to get"}],"responses":{"200":{"description":"Dashboard with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dashboard not found"}}},"put":{"summary":"Update an existing Dashboard","security":[{"BearerAuth":[]}],"operationId":"updateDashboardById","tags":["Dashboards"],"requestBody":{"required":true,"description":"data for updating a new Dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dashboard not found"}}}},"/dashboards/{id}/items":{"get":{"summary":"Gets items","security":[{"BearerAuth":[]}],"operationId":"getItems","tags":["Dashboards"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new item","security":[{"BearerAuth":[]}],"operationId":"addItem","tags":["Dashboards"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/clone":{"post":{"summary":"Clone an existing Dashboard","security":[{"BearerAuth":[]}],"operationId":"cloneDashboard","tags":["Dashboards"],"requestBody":{"required":true,"description":"data for creating a new Dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Dashboard to clone"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id"]}}}},"responses":{"201":{"description":"Dashboard successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dashboard","security":[{"BearerAuth":[]}],"operationId":"deleteDashboardById","tags":["Dashboards"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dashboard not found"}}}},"/dashboards/items/{id}":{"get":{"summary":"Gets a single Dashboard Item","security":[{"BearerAuth":[]}],"operationId":"getDashboardItemById","tags":["Dashboard Items"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DashboardItem to get"}],"responses":{"200":{"description":"DashboardItem with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardItem"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DashboardItem not found"}}},"put":{"summary":"Update an existing item","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Dashboard Items"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DashboardItem"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/items/":{"post":{"summary":"Create dasboard item","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Dashboard Items"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/items/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dashboard Item","security":[{"BearerAuth":[]}],"operationId":"deleteDashboardItemById","tags":["Dashboard Items"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DashboardItem to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DashboardItem not found"}}}},"/dispositions":{"get":{"summary":"Gets a list of Dispositions","security":[{"BearerAuth":[]}],"operationId":"listAllDisposition","tags":["Dispositions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Disposition"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dispositions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Disposition"}}}}},"206":{"description":"Partial (paged) collection of Dispositions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Disposition"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Disposition","security":[{"BearerAuth":[]}],"operationId":"createDisposition","tags":["Dispositions"],"requestBody":{"required":true,"description":"data for creating a new Disposition","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"level":{"type":"string","enum":["first","second","third"],"default":"first"},"description":{"type":"string"}},"required":["name","level"]}}}},"responses":{"201":{"description":"Disposition successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disposition"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dispositions/{id}":{"get":{"summary":"Gets a single Disposition","security":[{"BearerAuth":[]}],"operationId":"getDispositionById","tags":["Dispositions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Disposition to get"}],"responses":{"200":{"description":"Disposition with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disposition"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Disposition not found"}}},"put":{"summary":"Update an existing Disposition","security":[{"BearerAuth":[]}],"operationId":"updateDispositionById","tags":["Dispositions"],"requestBody":{"required":true,"description":"data for updating a new Disposition","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"level":{"type":"string","enum":["first","second","third"],"default":"first"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Disposition to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Disposition not found"}}}},"/dispositions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Disposition","security":[{"BearerAuth":[]}],"operationId":"deleteDispositionById","tags":["Dispositions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Disposition to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Disposition not found"}}}},"/fax/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllFaxAccount","tags":["Fax Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Account","security":[{"BearerAuth":[]}],"operationId":"createFaxAccount","tags":["Fax Accounts"],"requestBody":{"required":true,"description":"data for creating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ecm":{"type":"string","enum":["yes","no"],"default":"yes"},"headerinfo":{"type":"string","default":"xCALLY Motion Fax"},"localstationid":{"type":"string"},"minrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"default":"4800"},"maxrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"default":"14400"},"modem":{"type":"string","default":"v17,v27,v29"},"gateway":{"type":"string","default":"no"},"faxdetect":{"type":"string","default":"no"},"t38timeout":{"type":"integer","default":5000},"tech":{"type":"string","enum":["SIP","IAX","DADHI","KHOMP"],"default":"SIP"},"key":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}},"required":["name","key"]}}}},"responses":{"201":{"description":"FaxAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeFaxAccount","tags":["Fax Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getFaxAccountById","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount to get"}],"responses":{"200":{"description":"FaxAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateFaxAccountById","tags":["Fax Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ecm":{"type":"string","enum":["yes","no"],"default":"yes"},"headerinfo":{"type":"string","default":"xCALLY Motion Fax"},"localstationid":{"type":"string"},"minrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"default":"4800"},"maxrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"default":"14400"},"modem":{"type":"string","default":"v17,v27,v29"},"gateway":{"type":"string","default":"no"},"faxdetect":{"type":"string","default":"no"},"t38timeout":{"type":"integer","default":5000},"tech":{"type":"string","enum":["SIP","IAX","DADHI","KHOMP"],"default":"SIP"},"key":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxAccount not found"}}}},"/fax/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/interactions":{"get":{"summary":"Gets account interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new interactions","security":[{"BearerAuth":[]}],"operationId":"addInteraction","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/applications":{"get":{"summary":"Gets account pplications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/messages":{"get":{"summary":"Gets account messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/users":{"get":{"summary":"Gets agents from fax account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a fax account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a fax account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/addaccountapplications":{"post":{"summary":"Creates new account and applications","security":[{"BearerAuth":[]}],"operationId":"addAccountApplications","tags":["Fax Accounts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/updateaccountapplications":{"post":{"summary":"Update account and applications","security":[{"BearerAuth":[]}],"operationId":"updateAccountApplications","tags":["Fax Accounts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/send":{"post":{"summary":"Send new fax","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Account","security":[{"BearerAuth":[]}],"operationId":"deleteFaxAccountById","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxAccount not found"}}}},"/fax/applications":{"get":{"summary":"Gets a list of Applications","security":[{"BearerAuth":[]}],"operationId":"listAllFaxApplication","tags":["Fax Applications"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxApplication"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxApplication"}}}}},"206":{"description":"Partial (paged) collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxApplication"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Application","security":[{"BearerAuth":[]}],"operationId":"createFaxApplication","tags":["Fax Applications"],"requestBody":{"required":true,"description":"data for creating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}},"required":["priority","app"]}}}},"responses":{"201":{"description":"FaxApplication successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getFaxApplicationById","tags":["Fax Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxApplication to get"}],"responses":{"200":{"description":"FaxApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateFaxApplicationById","tags":["Fax Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxApplication not found"}}}},"/fax/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteFaxApplicationById","tags":["Fax Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxApplication not found"}}}},"/fax/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllFaxInteraction","tags":["Fax Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createFaxInteraction","tags":["Fax Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"read1stAt":{"type":"string"},"fax":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}},"required":["firstMsgDirection","lastMsgDirection"]}}}},"responses":{"201":{"description":"FaxInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeFaxInteraction","tags":["Fax Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getFaxInteractionById","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction to get"}],"responses":{"200":{"description":"FaxInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateFaxInteractionById","tags":["Fax Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"read1stAt":{"type":"string"},"fax":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxInteraction not found"}}}},"/fax/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/{id}/download":{"get":{"summary":"Get interactions","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteFaxInteractionById","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxInteraction not found"}}}},"/fax/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllFaxMessage","tags":["Fax Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeFaxMessage","tags":["Fax Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getFaxMessageById","tags":["Fax Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage to get"}],"responses":{"200":{"description":"FaxMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateFaxMessageById","tags":["Fax Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"failMessage":{"type":"string","default":null},"readAt":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxMessage not found"}}}},"/fax/messages/{id}/download":{"get":{"summary":"Get message","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Fax Message"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/":{"post":{"summary":"Create message and send Fax","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Fax Messages"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Fax Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Fax Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteFaxMessageById","tags":["Fax Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxMessage not found"}}}},"/fax/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllFaxQueue","tags":["Fax Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createFaxQueue","tags":["Fax Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"lastAgent":{"type":"integer","default":0}},"required":["name","timeout","strategy"]}}}},"responses":{"201":{"description":"FaxQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeFaxQueue","tags":["Fax Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getFaxQueueById","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue to get"}],"responses":{"200":{"description":"FaxQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateFaxQueueById","tags":["Fax Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"lastAgent":{"type":"integer","default":0}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueue not found"}}}},"/fax/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteFaxQueueById","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueue not found"}}}},"/fax/reports/queue":{"get":{"summary":"Gets a list of Fax Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllFaxQueueReport","tags":["Fax Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Fax Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Fax Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Fax Queue Report","security":[{"BearerAuth":[]}],"operationId":"createFaxQueueReport","tags":["Fax Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Fax Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"FaxQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/reports/queue/describe":{"get":{"summary":"Gets table info about Fax Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeFaxQueueReport","tags":["Fax Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/reports/queue/{id}":{"get":{"summary":"Gets a single Fax Queue Report","security":[{"BearerAuth":[]}],"operationId":"getFaxQueueReportById","tags":["Fax Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueueReport to get"}],"responses":{"200":{"description":"FaxQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueueReport not found"}}},"put":{"summary":"Update an existing Fax Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateFaxQueueReportById","tags":["Fax Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Fax Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueueReport not found"}}}},"/fax/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Fax Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteFaxQueueReportById","tags":["Fax Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueueReport not found"}}}},"/fax/reports/transfer":{"get":{"summary":"Gets a list of Fax Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllFaxTransferReport","tags":["Fax Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Fax Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Fax Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Fax Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createFaxTransferReport","tags":["Fax Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Fax Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"FaxTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/reports/transfer/describe":{"get":{"summary":"Gets table info about Fax Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeFaxTransferReport","tags":["Fax Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/reports/transfer/{id}":{"get":{"summary":"Gets a single Fax Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getFaxTransferReportById","tags":["Fax Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxTransferReport to get"}],"responses":{"200":{"description":"FaxTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxTransferReport not found"}}},"put":{"summary":"Update an existing Fax Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateFaxTransferReportById","tags":["Fax Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Fax Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxTransferReport not found"}}}},"/fax/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Fax Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteFaxTransferReportById","tags":["Fax Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxTransferReport not found"}}}},"/integrations/desk/accounts":{"get":{"summary":"Gets a list of Desk Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllDeskAccount","tags":["Desk Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each DeskAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Desk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskAccount"}}}}},"206":{"description":"Partial (paged) collection of Desk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Desk Account","security":[{"BearerAuth":[]}],"operationId":"createDeskAccount","tags":["Desk Accounts"],"requestBody":{"required":true,"description":"data for creating a new Desk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"remoteUri":{"type":"string"},"authType":{"type":"string","enum":["basic"],"default":"basic"},"password":{"type":"string"},"consumerKey":{"type":"string"},"consumerSecret":{"type":"string"},"token":{"type":"string"},"tokenSecret":{"type":"string"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"responses":{"201":{"description":"DeskAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/accounts/{id}":{"get":{"summary":"Gets a single Desk Account","security":[{"BearerAuth":[]}],"operationId":"getDeskAccountById","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount to get"}],"responses":{"200":{"description":"DeskAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskAccount not found"}}},"put":{"summary":"Update an existing Desk Account","security":[{"BearerAuth":[]}],"operationId":"updateDeskAccountById","tags":["Desk Accounts"],"requestBody":{"required":true,"description":"data for updating a new Desk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"remoteUri":{"type":"string"},"authType":{"type":"string","enum":["basic"],"default":"basic"},"password":{"type":"string"},"consumerKey":{"type":"string"},"consumerSecret":{"type":"string"},"token":{"type":"string"},"tokenSecret":{"type":"string"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskAccount not found"}}}},"/integrations/desk/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Desk Account","security":[{"BearerAuth":[]}],"operationId":"deleteDeskAccountById","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskAccount not found"}}}},"/integrations/desk/configurations":{"get":{"summary":"Gets a list of Desk Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllDeskConfiguration","tags":["Desk Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each DeskConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Desk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Desk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Desk Configuration","security":[{"BearerAuth":[]}],"operationId":"createDeskConfiguration","tags":["Desk Configurations"],"requestBody":{"required":true,"description":"data for creating a new Desk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"DeskConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}":{"get":{"summary":"Gets a single Desk Configuration","security":[{"BearerAuth":[]}],"operationId":"getDeskConfigurationById","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration to get"}],"responses":{"200":{"description":"DeskConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskConfiguration not found"}}},"put":{"summary":"Update an existing Desk Configuration","security":[{"BearerAuth":[]}],"operationId":"updateDeskConfigurationById","tags":["Desk Configurations"],"requestBody":{"required":true,"description":"data for updating a new Desk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskConfiguration not found"}}}},"/integrations/desk/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}/tags":{"get":{"summary":"Gets configurations tags","security":[{"BearerAuth":[]}],"operationId":"getTags","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Sets new tags","security":[{"BearerAuth":[]}],"operationId":"setTags","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Desk Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteDeskConfigurationById","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskConfiguration not found"}}}},"/integrations/desk/fields":{"get":{"summary":"Gets a list of Desk Fields","security":[{"BearerAuth":[]}],"operationId":"listAllDeskField","tags":["Desk Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each DeskField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Desk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskField"}}}}},"206":{"description":"Partial (paged) collection of Desk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Desk Field","security":[{"BearerAuth":[]}],"operationId":"createDeskField","tags":["Desk Fields"],"requestBody":{"required":true,"description":"data for creating a new Desk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"DeskField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/fields/{id}":{"get":{"summary":"Gets a single Desk Field","security":[{"BearerAuth":[]}],"operationId":"getDeskFieldById","tags":["Desk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskField to get"}],"responses":{"200":{"description":"DeskField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskField not found"}}},"put":{"summary":"Update an existing Desk Field","security":[{"BearerAuth":[]}],"operationId":"updateDeskFieldById","tags":["Desk Fields"],"requestBody":{"required":true,"description":"data for updating a new Desk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskField not found"}}}},"/integrations/desk/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Desk Field","security":[{"BearerAuth":[]}],"operationId":"deleteDeskFieldById","tags":["Desk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskField not found"}}}},"/integrations/dynamics365/accounts":{"get":{"summary":"Gets a list of Dynamics365 Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllDynamics365Account","tags":["Dynamics365 Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Dynamics365Account"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dynamics365 Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Account"}}}}},"206":{"description":"Partial (paged) collection of Dynamics365 Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Account"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Dynamics365 Account","security":[{"BearerAuth":[]}],"operationId":"createDynamics365Account","tags":["Dynamics365 Accounts"],"requestBody":{"required":true,"description":"data for creating a new Dynamics365 Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"remoteUri":{"type":"string"},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"serverUrl":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"Dynamics365Account successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Account"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/accounts/{id}":{"get":{"summary":"Gets a single Dynamics365 Account","security":[{"BearerAuth":[]}],"operationId":"getDynamics365AccountById","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account to get"}],"responses":{"200":{"description":"Dynamics365Account with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Account"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Account not found"}}},"put":{"summary":"Update an existing Dynamics365 Account","security":[{"BearerAuth":[]}],"operationId":"updateDynamics365AccountById","tags":["Dynamics365 Accounts"],"requestBody":{"required":true,"description":"data for updating a new Dynamics365 Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"remoteUri":{"type":"string"},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"serverUrl":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Account not found"}}}},"/integrations/dynamics365/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dynamics365 Account","security":[{"BearerAuth":[]}],"operationId":"deleteDynamics365AccountById","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Account not found"}}}},"/integrations/dynamics365/configurations":{"get":{"summary":"Gets a list of Dynamics365 Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllDynamics365Configuration","tags":["Dynamics365 Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Dynamics365Configuration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dynamics365 Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Configuration"}}}}},"206":{"description":"Partial (paged) collection of Dynamics365 Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Configuration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Dynamics365 Configuration","security":[{"BearerAuth":[]}],"operationId":"createDynamics365Configuration","tags":["Dynamics365 Configurations"],"requestBody":{"required":true,"description":"data for creating a new Dynamics365 Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ticketType":{"type":"string","enum":["incident","phonecall"],"default":"incident"}}}}}},"responses":{"201":{"description":"Dynamics365Configuration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Configuration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/configurations/{id}":{"get":{"summary":"Gets a single Dynamics365 Configuration","security":[{"BearerAuth":[]}],"operationId":"getDynamics365ConfigurationById","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration to get"}],"responses":{"200":{"description":"Dynamics365Configuration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Configuration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Configuration not found"}}},"put":{"summary":"Update an existing Dynamics365 Configuration","security":[{"BearerAuth":[]}],"operationId":"updateDynamics365ConfigurationById","tags":["Dynamics365 Configurations"],"requestBody":{"required":true,"description":"data for updating a new Dynamics365 Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ticketType":{"type":"string","enum":["incident","phonecall"],"default":"incident"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Configuration not found"}}}},"/integrations/dynamics365/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dynamics365 Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteDynamics365ConfigurationById","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Configuration not found"}}}},"/integrations/dynamics365/fields":{"get":{"summary":"Gets a list of Dynamics365 Fields","security":[{"BearerAuth":[]}],"operationId":"listAllDynamics365Field","tags":["Dynamics365 Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Dynamics365Field"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dynamics365 Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Field"}}}}},"206":{"description":"Partial (paged) collection of Dynamics365 Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Field"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Dynamics365 Field","security":[{"BearerAuth":[]}],"operationId":"createDynamics365Field","tags":["Dynamics365 Fields"],"requestBody":{"required":true,"description":"data for creating a new Dynamics365 Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"Dynamics365Field successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Field"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/fields/{id}":{"get":{"summary":"Gets a single Dynamics365 Field","security":[{"BearerAuth":[]}],"operationId":"getDynamics365FieldById","tags":["Dynamics365 Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Field to get"}],"responses":{"200":{"description":"Dynamics365Field with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Field"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Field not found"}}},"put":{"summary":"Update an existing Dynamics365 Field","security":[{"BearerAuth":[]}],"operationId":"updateDynamics365FieldById","tags":["Dynamics365 Fields"],"requestBody":{"required":true,"description":"data for updating a new Dynamics365 Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Field to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Field not found"}}}},"/integrations/dynamics365/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dynamics365 Field","security":[{"BearerAuth":[]}],"operationId":"deleteDynamics365FieldById","tags":["Dynamics365 Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Field to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Field not found"}}}},"/integrations":{"get":{"summary":"Gets a list of Integrations","security":[{"BearerAuth":[]}],"operationId":"listAllIntegration","tags":["Integrations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Integration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Integrations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}}}}},"206":{"description":"Partial (paged) collection of Integrations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Integration","security":[{"BearerAuth":[]}],"operationId":"createIntegration","tags":["Integrations"],"requestBody":{"required":true,"description":"data for creating a new Integration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"main":{"type":"string","default":"app.js"},"filename":{"type":"string"},"path":{"type":"string"},"type":{"type":"string"},"size":{"type":"integer"},"active":{"type":"boolean","default":false},"author":{"type":"string"},"logo":{"type":"string"},"state":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"remoteUri":{"type":"string"},"link":{"type":"string","default":"#"}},"required":["name","version"]}}}},"responses":{"201":{"description":"Integration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/{id}":{"get":{"summary":"Gets a single Integration","security":[{"BearerAuth":[]}],"operationId":"getIntegrationById","tags":["Integrations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Integration to get"}],"responses":{"200":{"description":"Integration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Integration not found"}}},"put":{"summary":"Update an existing Integration","security":[{"BearerAuth":[]}],"operationId":"updateIntegrationById","tags":["Integrations"],"requestBody":{"required":true,"description":"data for updating a new Integration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"main":{"type":"string","default":"app.js"},"filename":{"type":"string"},"path":{"type":"string"},"type":{"type":"string"},"size":{"type":"integer"},"active":{"type":"boolean","default":false},"author":{"type":"string"},"logo":{"type":"string"},"state":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"remoteUri":{"type":"string"},"link":{"type":"string","default":"#"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Integration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Integration not found"}}}},"/integrations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Integration","security":[{"BearerAuth":[]}],"operationId":"deleteIntegrationById","tags":["Integrations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Integration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Integration not found"}}}},"/integrations/reports":{"get":{"summary":"Gets a list of Integration Reports","security":[{"BearerAuth":[]}],"operationId":"listAllIntegrationReport","tags":["Integration Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each IntegrationReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Integration Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationReport"}}}}},"206":{"description":"Partial (paged) collection of Integration Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Integration Report","security":[{"BearerAuth":[]}],"operationId":"createIntegrationReport","tags":["Integration Reports"],"requestBody":{"required":true,"description":"data for creating a new Integration Report","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"string"},"eventChannel":{"type":"string"},"exitStatus":{"type":"string"},"ticketId":{"type":"string"},"integrationId":{"type":"integer"},"contacts":{"type":"string"},"uniqueid":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"queue":{"type":"string"},"interface":{"type":"string"},"membername":{"type":"string"},"agentcalledAt":{"type":"string"},"agentconnectAt":{"type":"string"},"holdtime":{"type":"integer"},"agentcomplete":{"type":"boolean","default":false},"agentcompleteAt":{"type":"string"},"talktime":{"type":"integer"},"agentacw":{"type":"boolean","default":false},"acwtime":{"type":"integer"},"reason":{"type":"string"},"agentringnoanswer":{"type":"boolean","default":false},"agentringnoanswerAt":{"type":"string"},"agentdump":{"type":"boolean","default":false},"agentdumpAt":{"type":"string"},"lastevent":{"type":"string"},"channel":{"type":"string"},"channelstate":{"type":"integer"},"channelstatedesc":{"type":"string"},"connectedlinenum":{"type":"string"},"connectedlinename":{"type":"string"},"language":{"type":"string"},"accountcode":{"type":"string"},"context":{"type":"string"},"exten":{"type":"string"},"priority":{"type":"string"},"destchannel":{"type":"string"},"destchannelstate":{"type":"integer"},"destchannelstatedesc":{"type":"string"},"destcalleridnum":{"type":"string"},"destcalleridname":{"type":"string"},"destconnectedlinenum":{"type":"string"},"destconnectedlinename":{"type":"string"},"destlanguage":{"type":"string"},"destaccountcode":{"type":"string"},"destcontext":{"type":"string"},"destexten":{"type":"string"},"destpriority":{"type":"string"},"destuniqueid":{"type":"string"},"messageId":{"type":"string"},"inReplyTo":{"type":"string"},"subject":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"attachment":{"type":"string"},"html":{"type":"string"},"text":{"type":"string"},"status":{"type":"string","enum":["SENT","SENDING","RECEIVED","FAILED"]},"url":{"type":"string"},"app":{"type":"string"},"appdata":{"type":"string"},"projectId":{"type":"integer"}}}}}},"responses":{"201":{"description":"IntegrationReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/reports/describe":{"get":{"summary":"Gets table info about Integration Reports","security":[{"BearerAuth":[]}],"operationId":"describeIntegrationReport","tags":["Integration Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/reports/{id}":{"get":{"summary":"Gets a single Integration Report","security":[{"BearerAuth":[]}],"operationId":"getIntegrationReportById","tags":["Integration Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the IntegrationReport to get"}],"responses":{"200":{"description":"IntegrationReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"IntegrationReport not found"}}},"put":{"summary":"Update an existing Integration Report","security":[{"BearerAuth":[]}],"operationId":"updateIntegrationReportById","tags":["Integration Reports"],"requestBody":{"required":true,"description":"data for updating a new Integration Report","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"string"},"eventChannel":{"type":"string"},"exitStatus":{"type":"string"},"ticketId":{"type":"string"},"integrationId":{"type":"integer"},"contacts":{"type":"string"},"uniqueid":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"queue":{"type":"string"},"interface":{"type":"string"},"membername":{"type":"string"},"agentcalledAt":{"type":"string"},"agentconnectAt":{"type":"string"},"holdtime":{"type":"integer"},"agentcomplete":{"type":"boolean","default":false},"agentcompleteAt":{"type":"string"},"talktime":{"type":"integer"},"agentacw":{"type":"boolean","default":false},"acwtime":{"type":"integer"},"reason":{"type":"string"},"agentringnoanswer":{"type":"boolean","default":false},"agentringnoanswerAt":{"type":"string"},"agentdump":{"type":"boolean","default":false},"agentdumpAt":{"type":"string"},"lastevent":{"type":"string"},"channel":{"type":"string"},"channelstate":{"type":"integer"},"channelstatedesc":{"type":"string"},"connectedlinenum":{"type":"string"},"connectedlinename":{"type":"string"},"language":{"type":"string"},"accountcode":{"type":"string"},"context":{"type":"string"},"exten":{"type":"string"},"priority":{"type":"string"},"destchannel":{"type":"string"},"destchannelstate":{"type":"integer"},"destchannelstatedesc":{"type":"string"},"destcalleridnum":{"type":"string"},"destcalleridname":{"type":"string"},"destconnectedlinenum":{"type":"string"},"destconnectedlinename":{"type":"string"},"destlanguage":{"type":"string"},"destaccountcode":{"type":"string"},"destcontext":{"type":"string"},"destexten":{"type":"string"},"destpriority":{"type":"string"},"destuniqueid":{"type":"string"},"messageId":{"type":"string"},"inReplyTo":{"type":"string"},"subject":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"attachment":{"type":"string"},"html":{"type":"string"},"text":{"type":"string"},"status":{"type":"string","enum":["SENT","SENDING","RECEIVED","FAILED"]},"url":{"type":"string"},"app":{"type":"string"},"appdata":{"type":"string"},"projectId":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the IntegrationReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"IntegrationReport not found"}}}},"/integrations/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Integration Report","security":[{"BearerAuth":[]}],"operationId":"deleteIntegrationReportById","tags":["Integration Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the IntegrationReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"IntegrationReport not found"}}}},"/intervals":{"get":{"summary":"Gets a list of Intervals","security":[{"BearerAuth":[]}],"operationId":"listAllInterval","tags":["Intervals"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Interval"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Intervals","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Interval"}}}}},"206":{"description":"Partial (paged) collection of Intervals","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Interval"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interval","security":[{"BearerAuth":[]}],"operationId":"createInterval","tags":["Intervals"],"requestBody":{"required":true,"description":"data for creating a new Interval","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string"}}}}}},"responses":{"201":{"description":"Interval successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interval"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/intervals/{id}":{"get":{"summary":"Gets a single Interval","security":[{"BearerAuth":[]}],"operationId":"getIntervalById","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval to get"}],"responses":{"200":{"description":"Interval with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interval"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Interval not found"}}},"put":{"summary":"Update an existing Interval","security":[{"BearerAuth":[]}],"operationId":"updateIntervalById","tags":["Intervals"],"requestBody":{"required":true,"description":"data for updating a new Interval","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Interval not found"}}}},"/intervals/{id}/sub_intervals":{"get":{"summary":"Get sub intervals set","security":[{"BearerAuth":[]}],"operationId":"getIntervals","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new sub interval","security":[{"BearerAuth":[]}],"operationId":"addInterval","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/intervals/{id}/sub_intervals/create_many":{"post":{"summary":"Create new sub intervals set","security":[{"BearerAuth":[]}],"operationId":"addIntervals","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/intervals/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interval","security":[{"BearerAuth":[]}],"operationId":"deleteIntervalById","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Interval not found"}}}},"/integrations/freshdesk/accounts":{"get":{"summary":"Gets a list of Freshdesk Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllFreshdeskAccount","tags":["Freshdesk Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshdeskAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshdesk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskAccount"}}}}},"206":{"description":"Partial (paged) collection of Freshdesk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshdesk Account","security":[{"BearerAuth":[]}],"operationId":"createFreshdeskAccount","tags":["Freshdesk Accounts"],"requestBody":{"required":true,"description":"data for creating a new Freshdesk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshdeskAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/accounts/{id}":{"get":{"summary":"Gets a single Freshdesk Account","security":[{"BearerAuth":[]}],"operationId":"getFreshdeskAccountById","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount to get"}],"responses":{"200":{"description":"FreshdeskAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskAccount not found"}}},"put":{"summary":"Update an existing Freshdesk Account","security":[{"BearerAuth":[]}],"operationId":"updateFreshdeskAccountById","tags":["Freshdesk Accounts"],"requestBody":{"required":true,"description":"data for updating a new Freshdesk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskAccount not found"}}}},"/integrations/freshdesk/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshdesk Account","security":[{"BearerAuth":[]}],"operationId":"deleteFreshdeskAccountById","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskAccount not found"}}}},"/integrations/freshdesk/configurations":{"get":{"summary":"Gets a list of Freshdesk Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllFreshdeskConfiguration","tags":["Freshdesk Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshdeskConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshdesk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Freshdesk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshdesk Configuration","security":[{"BearerAuth":[]}],"operationId":"createFreshdeskConfiguration","tags":["Freshdesk Configurations"],"requestBody":{"required":true,"description":"data for creating a new Freshdesk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshdeskConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}":{"get":{"summary":"Gets a single Freshdesk Configuration","security":[{"BearerAuth":[]}],"operationId":"getFreshdeskConfigurationById","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration to get"}],"responses":{"200":{"description":"FreshdeskConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskConfiguration not found"}}},"put":{"summary":"Update an existing Freshdesk Configuration","security":[{"BearerAuth":[]}],"operationId":"updateFreshdeskConfigurationById","tags":["Freshdesk Configurations"],"requestBody":{"required":true,"description":"data for updating a new Freshdesk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskConfiguration not found"}}}},"/integrations/freshdesk/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}/tags":{"get":{"summary":"Gets configurations tags","security":[{"BearerAuth":[]}],"operationId":"getTags","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Sets new tags","security":[{"BearerAuth":[]}],"operationId":"setTags","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshdesk Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteFreshdeskConfigurationById","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskConfiguration not found"}}}},"/integrations/freshdesk/fields":{"get":{"summary":"Gets a list of Freshdesk Fields","security":[{"BearerAuth":[]}],"operationId":"listAllFreshdeskField","tags":["Freshdesk Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshdeskField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshdesk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskField"}}}}},"206":{"description":"Partial (paged) collection of Freshdesk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshdesk Field","security":[{"BearerAuth":[]}],"operationId":"createFreshdeskField","tags":["Freshdesk Fields"],"requestBody":{"required":true,"description":"data for creating a new Freshdesk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshdeskField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/fields/{id}":{"get":{"summary":"Gets a single Freshdesk Field","security":[{"BearerAuth":[]}],"operationId":"getFreshdeskFieldById","tags":["Freshdesk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskField to get"}],"responses":{"200":{"description":"FreshdeskField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskField not found"}}},"put":{"summary":"Update an existing Freshdesk Field","security":[{"BearerAuth":[]}],"operationId":"updateFreshdeskFieldById","tags":["Freshdesk Fields"],"requestBody":{"required":true,"description":"data for updating a new Freshdesk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskField not found"}}}},"/integrations/freshdesk/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshdesk Field","security":[{"BearerAuth":[]}],"operationId":"deleteFreshdeskFieldById","tags":["Freshdesk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskField not found"}}}},"/integrations/freshsales/accounts":{"get":{"summary":"Gets a list of Freshsales Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllFreshsalesAccount","tags":["Freshsales Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshsalesAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshsales Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesAccount"}}}}},"206":{"description":"Partial (paged) collection of Freshsales Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshsales Account","security":[{"BearerAuth":[]}],"operationId":"createFreshsalesAccount","tags":["Freshsales Accounts"],"requestBody":{"required":true,"description":"data for creating a new Freshsales Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshsalesAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/accounts/{id}":{"get":{"summary":"Gets a single Freshsales Account","security":[{"BearerAuth":[]}],"operationId":"getFreshsalesAccountById","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount to get"}],"responses":{"200":{"description":"FreshsalesAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesAccount not found"}}},"put":{"summary":"Update an existing Freshsales Account","security":[{"BearerAuth":[]}],"operationId":"updateFreshsalesAccountById","tags":["Freshsales Accounts"],"requestBody":{"required":true,"description":"data for updating a new Freshsales Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesAccount not found"}}}},"/integrations/freshsales/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshsales Account","security":[{"BearerAuth":[]}],"operationId":"deleteFreshsalesAccountById","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesAccount not found"}}}},"/integrations/freshsales/configurations":{"get":{"summary":"Gets a list of Freshsales Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllFreshsalesConfiguration","tags":["Freshsales Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshsalesConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshsales Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Freshsales Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshsales Configuration","security":[{"BearerAuth":[]}],"operationId":"createFreshsalesConfiguration","tags":["Freshsales Configurations"],"requestBody":{"required":true,"description":"data for creating a new Freshsales Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshsalesConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/configurations/{id}":{"get":{"summary":"Gets a single Freshsales Configuration","security":[{"BearerAuth":[]}],"operationId":"getFreshsalesConfigurationById","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration to get"}],"responses":{"200":{"description":"FreshsalesConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesConfiguration not found"}}},"put":{"summary":"Update an existing Freshsales Configuration","security":[{"BearerAuth":[]}],"operationId":"updateFreshsalesConfigurationById","tags":["Freshsales Configurations"],"requestBody":{"required":true,"description":"data for updating a new Freshsales Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesConfiguration not found"}}}},"/integrations/freshsales/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshsales Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteFreshsalesConfigurationById","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesConfiguration not found"}}}},"/integrations/freshsales/fields":{"get":{"summary":"Gets a list of Freshsales Fields","security":[{"BearerAuth":[]}],"operationId":"listAllFreshsalesField","tags":["Freshsales Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshsalesField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshsales Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesField"}}}}},"206":{"description":"Partial (paged) collection of Freshsales Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshsales Field","security":[{"BearerAuth":[]}],"operationId":"createFreshsalesField","tags":["Freshsales Fields"],"requestBody":{"required":true,"description":"data for creating a new Freshsales Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshsalesField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/fields/{id}":{"get":{"summary":"Gets a single Freshsales Field","security":[{"BearerAuth":[]}],"operationId":"getFreshsalesFieldById","tags":["Freshsales Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesField to get"}],"responses":{"200":{"description":"FreshsalesField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesField not found"}}},"put":{"summary":"Update an existing Freshsales Field","security":[{"BearerAuth":[]}],"operationId":"updateFreshsalesFieldById","tags":["Freshsales Fields"],"requestBody":{"required":true,"description":"data for updating a new Freshsales Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesField not found"}}}},"/integrations/freshsales/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshsales Field","security":[{"BearerAuth":[]}],"operationId":"deleteFreshsalesFieldById","tags":["Freshsales Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesField not found"}}}},"/integrations/salesforce/accounts":{"get":{"summary":"Gets a list of Salesforce Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllSalesforceAccount","tags":["Salesforce Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SalesforceAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Salesforce Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceAccount"}}}}},"206":{"description":"Partial (paged) collection of Salesforce Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Salesforce Account","security":[{"BearerAuth":[]}],"operationId":"createSalesforceAccount","tags":["Salesforce Accounts"],"requestBody":{"required":true,"description":"data for creating a new Salesforce Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"remoteUri":{"type":"string"},"password":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"securityToken":{"type":"string"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"responses":{"201":{"description":"SalesforceAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/accounts/{id}":{"get":{"summary":"Gets a single Salesforce Account","security":[{"BearerAuth":[]}],"operationId":"getSalesforceAccountById","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount to get"}],"responses":{"200":{"description":"SalesforceAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceAccount not found"}}},"put":{"summary":"Update an existing Salesforce Account","security":[{"BearerAuth":[]}],"operationId":"updateSalesforceAccountById","tags":["Salesforce Accounts"],"requestBody":{"required":true,"description":"data for updating a new Salesforce Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"remoteUri":{"type":"string"},"password":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"securityToken":{"type":"string"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceAccount not found"}}}},"/integrations/salesforce/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Salesforce Account","security":[{"BearerAuth":[]}],"operationId":"deleteSalesforceAccountById","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceAccount not found"}}}},"/integrations/salesforce/configurations":{"get":{"summary":"Gets a list of Salesforce Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllSalesforceConfiguration","tags":["Salesforce Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SalesforceConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Salesforce Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Salesforce Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Salesforce Configuration","security":[{"BearerAuth":[]}],"operationId":"createSalesforceConfiguration","tags":["Salesforce Configurations"],"requestBody":{"required":true,"description":"data for creating a new Salesforce Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ticketType":{"type":"string","enum":["Task","Case"],"default":"Task"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"default":"contact_lead"},"moduleCreate":{"type":"string","enum":["nothing","contact","lead"],"default":"lead"}}}}}},"responses":{"201":{"description":"SalesforceConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/configurations/{id}":{"get":{"summary":"Gets a single Salesforce Configuration","security":[{"BearerAuth":[]}],"operationId":"getSalesforceConfigurationById","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration to get"}],"responses":{"200":{"description":"SalesforceConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceConfiguration not found"}}},"put":{"summary":"Update an existing Salesforce Configuration","security":[{"BearerAuth":[]}],"operationId":"updateSalesforceConfigurationById","tags":["Salesforce Configurations"],"requestBody":{"required":true,"description":"data for updating a new Salesforce Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ticketType":{"type":"string","enum":["Task","Case"],"default":"Task"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"default":"contact_lead"},"moduleCreate":{"type":"string","enum":["nothing","contact","lead"],"default":"lead"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceConfiguration not found"}}}},"/integrations/salesforce/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Salesforce Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteSalesforceConfigurationById","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceConfiguration not found"}}}},"/integrations/salesforce/fields":{"get":{"summary":"Gets a list of Salesforce Fields","security":[{"BearerAuth":[]}],"operationId":"listAllSalesforceField","tags":["Salesforce Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SalesforceField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Salesforce Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceField"}}}}},"206":{"description":"Partial (paged) collection of Salesforce Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Salesforce Field","security":[{"BearerAuth":[]}],"operationId":"createSalesforceField","tags":["Salesforce Fields"],"requestBody":{"required":true,"description":"data for creating a new Salesforce Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"SalesforceField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/fields/{id}":{"get":{"summary":"Gets a single Salesforce Field","security":[{"BearerAuth":[]}],"operationId":"getSalesforceFieldById","tags":["Salesforce Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceField to get"}],"responses":{"200":{"description":"SalesforceField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceField not found"}}},"put":{"summary":"Update an existing Salesforce Field","security":[{"BearerAuth":[]}],"operationId":"updateSalesforceFieldById","tags":["Salesforce Fields"],"requestBody":{"required":true,"description":"data for updating a new Salesforce Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceField not found"}}}},"/integrations/salesforce/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Salesforce Field","security":[{"BearerAuth":[]}],"operationId":"deleteSalesforceFieldById","tags":["Salesforce Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceField not found"}}}},"/integrations/servicenow/accounts":{"get":{"summary":"Gets a list of Servicenow Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllServicenowAccount","tags":["Servicenow Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ServicenowAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Servicenow Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowAccount"}}}}},"206":{"description":"Partial (paged) collection of Servicenow Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Servicenow Account","security":[{"BearerAuth":[]}],"operationId":"createServicenowAccount","tags":["Servicenow Accounts"],"requestBody":{"required":true,"description":"data for creating a new Servicenow Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"responses":{"201":{"description":"ServicenowAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/accounts/{id}":{"get":{"summary":"Gets a single Servicenow Account","security":[{"BearerAuth":[]}],"operationId":"getServicenowAccountById","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount to get"}],"responses":{"200":{"description":"ServicenowAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowAccount not found"}}},"put":{"summary":"Update an existing Servicenow Account","security":[{"BearerAuth":[]}],"operationId":"updateServicenowAccountById","tags":["Servicenow Accounts"],"requestBody":{"required":true,"description":"data for updating a new Servicenow Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowAccount not found"}}}},"/integrations/servicenow/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Servicenow Account","security":[{"BearerAuth":[]}],"operationId":"deleteServicenowAccountById","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowAccount not found"}}}},"/integrations/servicenow/configurations":{"get":{"summary":"Gets a list of Servicenow Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllServicenowConfiguration","tags":["Servicenow Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ServicenowConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Servicenow Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Servicenow Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Servicenow Configuration","security":[{"BearerAuth":[]}],"operationId":"createServicenowConfiguration","tags":["Servicenow Configurations"],"requestBody":{"required":true,"description":"data for creating a new Servicenow Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"ServicenowConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/configurations/{id}":{"get":{"summary":"Gets a single Servicenow Configuration","security":[{"BearerAuth":[]}],"operationId":"getServicenowConfigurationById","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration to get"}],"responses":{"200":{"description":"ServicenowConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowConfiguration not found"}}},"put":{"summary":"Update an existing Servicenow Configuration","security":[{"BearerAuth":[]}],"operationId":"updateServicenowConfigurationById","tags":["Servicenow Configurations"],"requestBody":{"required":true,"description":"data for updating a new Servicenow Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowConfiguration not found"}}}},"/integrations/servicenow/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Servicenow Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteServicenowConfigurationById","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowConfiguration not found"}}}},"/integrations/servicenow/fields":{"get":{"summary":"Gets a list of Servicenow Fields","security":[{"BearerAuth":[]}],"operationId":"listAllServicenowField","tags":["Servicenow Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ServicenowField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Servicenow Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowField"}}}}},"206":{"description":"Partial (paged) collection of Servicenow Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Servicenow Field","security":[{"BearerAuth":[]}],"operationId":"createServicenowField","tags":["Servicenow Fields"],"requestBody":{"required":true,"description":"data for creating a new Servicenow Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"ServicenowField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/fields/{id}":{"get":{"summary":"Gets a single Servicenow Field","security":[{"BearerAuth":[]}],"operationId":"getServicenowFieldById","tags":["Servicenow Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowField to get"}],"responses":{"200":{"description":"ServicenowField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowField not found"}}},"put":{"summary":"Update an existing Servicenow Field","security":[{"BearerAuth":[]}],"operationId":"updateServicenowFieldById","tags":["Servicenow Fields"],"requestBody":{"required":true,"description":"data for updating a new Servicenow Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowField not found"}}}},"/integrations/servicenow/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Servicenow Field","security":[{"BearerAuth":[]}],"operationId":"deleteServicenowFieldById","tags":["Servicenow Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowField not found"}}}},"/integrations/sugarcrm/accounts":{"get":{"summary":"Gets a list of Sugarcrm Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllSugarcrmAccount","tags":["Sugarcrm Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SugarcrmAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sugarcrm Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmAccount"}}}}},"206":{"description":"Partial (paged) collection of Sugarcrm Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Sugarcrm Account","security":[{"BearerAuth":[]}],"operationId":"createSugarcrmAccount","tags":["Sugarcrm Accounts"],"requestBody":{"required":true,"description":"data for creating a new Sugarcrm Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"responses":{"201":{"description":"SugarcrmAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/accounts/{id}":{"get":{"summary":"Gets a single Sugarcrm Account","security":[{"BearerAuth":[]}],"operationId":"getSugarcrmAccountById","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount to get"}],"responses":{"200":{"description":"SugarcrmAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmAccount not found"}}},"put":{"summary":"Update an existing Sugarcrm Account","security":[{"BearerAuth":[]}],"operationId":"updateSugarcrmAccountById","tags":["Sugarcrm Accounts"],"requestBody":{"required":true,"description":"data for updating a new Sugarcrm Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmAccount not found"}}}},"/integrations/sugarcrm/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Sugarcrm Account","security":[{"BearerAuth":[]}],"operationId":"deleteSugarcrmAccountById","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmAccount not found"}}}},"/integrations/sugarcrm/configurations":{"get":{"summary":"Gets a list of SugarCRM Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllSugarcrmConfiguration","tags":["SugarCRM Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SugarcrmConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of SugarCRM Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmConfiguration"}}}}},"206":{"description":"Partial (paged) collection of SugarCRM Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new SugarCRM Configuration","security":[{"BearerAuth":[]}],"operationId":"createSugarcrmConfiguration","tags":["SugarCRM Configurations"],"requestBody":{"required":true,"description":"data for creating a new SugarCRM Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"SugarcrmConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/configurations/{id}":{"get":{"summary":"Gets a single SugarCRM Configuration","security":[{"BearerAuth":[]}],"operationId":"getSugarcrmConfigurationById","tags":["SugarCRM Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration to get"}],"responses":{"200":{"description":"SugarcrmConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmConfiguration not found"}}},"put":{"summary":"Update an existing SugarCRM Configuration","security":[{"BearerAuth":[]}],"operationId":"updateSugarcrmConfigurationById","tags":["SugarCRM Configurations"],"requestBody":{"required":true,"description":"data for updating a new SugarCRM Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmConfiguration not found"}}}},"/integrations/sugarcrm/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Sugarcrm Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Sugarcrm Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Sugarcrm Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing SugarCRM Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteSugarcrmConfigurationById","tags":["SugarCRM Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmConfiguration not found"}}}},"/integrations/sugarcrm/fields":{"get":{"summary":"Gets a list of Sugarcrm Fields","security":[{"BearerAuth":[]}],"operationId":"listAllSugarcrmField","tags":["Sugarcrm Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SugarcrmField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sugarcrm Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmField"}}}}},"206":{"description":"Partial (paged) collection of Sugarcrm Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Sugarcrm Field","security":[{"BearerAuth":[]}],"operationId":"createSugarcrmField","tags":["Sugarcrm Fields"],"requestBody":{"required":true,"description":"data for creating a new Sugarcrm Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"SugarcrmField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/fields/{id}":{"get":{"summary":"Gets a single Sugarcrm Field","security":[{"BearerAuth":[]}],"operationId":"getSugarcrmFieldById","tags":["Sugarcrm Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmField to get"}],"responses":{"200":{"description":"SugarcrmField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmField not found"}}},"put":{"summary":"Update an existing Sugarcrm Field","security":[{"BearerAuth":[]}],"operationId":"updateSugarcrmFieldById","tags":["Sugarcrm Fields"],"requestBody":{"required":true,"description":"data for updating a new Sugarcrm Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmField not found"}}}},"/integrations/sugarcrm/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Sugarcrm Field","security":[{"BearerAuth":[]}],"operationId":"deleteSugarcrmFieldById","tags":["Sugarcrm Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmField not found"}}}},"/integrations/vtiger/accounts":{"get":{"summary":"Gets a list of Vtiger Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllVtigerAccount","tags":["Vtiger Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VtigerAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Vtiger Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerAccount"}}}}},"206":{"description":"Partial (paged) collection of Vtiger Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Vtiger Account","security":[{"BearerAuth":[]}],"operationId":"createVtigerAccount","tags":["Vtiger Accounts"],"requestBody":{"required":true,"description":"data for creating a new Vtiger Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"moduleName":{"type":"string","default":"HelpDesk"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"},"accessKey":{"type":"string"}},"required":["name","username","moduleName","remoteUri","accessKey"]}}}},"responses":{"201":{"description":"VtigerAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/accounts/{id}":{"get":{"summary":"Gets a single Vtiger Account","security":[{"BearerAuth":[]}],"operationId":"getVtigerAccountById","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount to get"}],"responses":{"200":{"description":"VtigerAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerAccount not found"}}},"put":{"summary":"Update an existing Vtiger Account","security":[{"BearerAuth":[]}],"operationId":"updateVtigerAccountById","tags":["Vtiger Accounts"],"requestBody":{"required":true,"description":"data for updating a new Vtiger Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"moduleName":{"type":"string","default":"HelpDesk"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"},"accessKey":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerAccount not found"}}}},"/integrations/vtiger/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Vtiger Account","security":[{"BearerAuth":[]}],"operationId":"deleteVtigerAccountById","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerAccount not found"}}}},"/integrations/vtiger/configurations":{"get":{"summary":"Gets a list of Vtiger Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllVtigerConfiguration","tags":["Vtiger Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VtigerConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Vtiger Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Vtiger Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Vtiger Configuration","security":[{"BearerAuth":[]}],"operationId":"createVtigerConfiguration","tags":["Vtiger Configurations"],"requestBody":{"required":true,"description":"data for creating a new Vtiger Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"VtigerConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/configurations/{id}":{"get":{"summary":"Gets a single Vtiger Configuration","security":[{"BearerAuth":[]}],"operationId":"getVtigerConfigurationById","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration to get"}],"responses":{"200":{"description":"VtigerConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerConfiguration not found"}}},"put":{"summary":"Update an existing Vtiger Configuration","security":[{"BearerAuth":[]}],"operationId":"updateVtigerConfigurationById","tags":["Vtiger Configurations"],"requestBody":{"required":true,"description":"data for updating a new Vtiger Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerConfiguration not found"}}}},"/integrations/vtiger/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Vtiger Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteVtigerConfigurationById","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerConfiguration not found"}}}},"/integrations/vtiger/fields":{"get":{"summary":"Gets a list of Vtiger Fields","security":[{"BearerAuth":[]}],"operationId":"listAllVtigerField","tags":["Vtiger Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VtigerField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Vtiger Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerField"}}}}},"206":{"description":"Partial (paged) collection of Vtiger Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Vtiger Field","security":[{"BearerAuth":[]}],"operationId":"createVtigerField","tags":["Vtiger Fields"],"requestBody":{"required":true,"description":"data for creating a new Vtiger Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"VtigerField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/fields/{id}":{"get":{"summary":"Gets a single Vtiger Field","security":[{"BearerAuth":[]}],"operationId":"getVtigerFieldById","tags":["Vtiger Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerField to get"}],"responses":{"200":{"description":"VtigerField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerField not found"}}},"put":{"summary":"Update an existing Vtiger Field","security":[{"BearerAuth":[]}],"operationId":"updateVtigerFieldById","tags":["Vtiger Fields"],"requestBody":{"required":true,"description":"data for updating a new Vtiger Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerField not found"}}}},"/integrations/vtiger/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Vtiger Field","security":[{"BearerAuth":[]}],"operationId":"deleteVtigerFieldById","tags":["Vtiger Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerField not found"}}}},"/integrations/zendesk/accounts":{"get":{"summary":"Gets a list of Zendesk Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllZendeskAccount","tags":["Zendesk Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZendeskAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zendesk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskAccount"}}}}},"206":{"description":"Partial (paged) collection of Zendesk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zendesk Account","security":[{"BearerAuth":[]}],"operationId":"createZendeskAccount","tags":["Zendesk Accounts"],"requestBody":{"required":true,"description":"data for creating a new Zendesk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"token":{"type":"string"},"remoteUri":{"type":"string"},"authType":{"type":"string","enum":["password","token"],"default":"password"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"responses":{"201":{"description":"ZendeskAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/accounts/{id}":{"get":{"summary":"Gets a single Zendesk Account","security":[{"BearerAuth":[]}],"operationId":"getZendeskAccountById","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount to get"}],"responses":{"200":{"description":"ZendeskAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskAccount not found"}}},"put":{"summary":"Update an existing Zendesk Account","security":[{"BearerAuth":[]}],"operationId":"updateZendeskAccountById","tags":["Zendesk Accounts"],"requestBody":{"required":true,"description":"data for updating a new Zendesk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"token":{"type":"string"},"remoteUri":{"type":"string"},"authType":{"type":"string","enum":["password","token"],"default":"password"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskAccount not found"}}}},"/integrations/zendesk/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zendesk Account","security":[{"BearerAuth":[]}],"operationId":"deleteZendeskAccountById","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskAccount not found"}}}},"/integrations/zendesk/configurations":{"get":{"summary":"Gets a list of Zendesk Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllZendeskConfiguration","tags":["Zendesk Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZendeskConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zendesk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Zendesk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zendesk Configuration","security":[{"BearerAuth":[]}],"operationId":"createZendeskConfiguration","tags":["Zendesk Configurations"],"requestBody":{"required":true,"description":"data for creating a new Zendesk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"ZendeskConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}":{"get":{"summary":"Gets a single Zendesk Configuration","security":[{"BearerAuth":[]}],"operationId":"getZendeskConfigurationById","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration to get"}],"responses":{"200":{"description":"ZendeskConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskConfiguration not found"}}},"put":{"summary":"Update an existing Zendesk Configuration","security":[{"BearerAuth":[]}],"operationId":"updateZendeskConfigurationById","tags":["Zendesk Configurations"],"requestBody":{"required":true,"description":"data for updating a new Zendesk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskConfiguration not found"}}}},"/integrations/zendesk/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}/tags":{"get":{"summary":"Gets configurations tags","security":[{"BearerAuth":[]}],"operationId":"getTags","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Sets new tags","security":[{"BearerAuth":[]}],"operationId":"setTags","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zendesk Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteZendeskConfigurationById","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskConfiguration not found"}}}},"/integrations/zendesk/fields":{"get":{"summary":"Gets a list of Zendesk Fields","security":[{"BearerAuth":[]}],"operationId":"listAllZendeskField","tags":["Zendesk Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZendeskField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zendesk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskField"}}}}},"206":{"description":"Partial (paged) collection of Zendesk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zendesk Field","security":[{"BearerAuth":[]}],"operationId":"createZendeskField","tags":["Zendesk Fields"],"requestBody":{"required":true,"description":"data for creating a new Zendesk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"ZendeskField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/fields/{id}":{"get":{"summary":"Gets a single Zendesk Field","security":[{"BearerAuth":[]}],"operationId":"getZendeskFieldById","tags":["Zendesk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskField to get"}],"responses":{"200":{"description":"ZendeskField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskField not found"}}},"put":{"summary":"Update an existing Zendesk Field","security":[{"BearerAuth":[]}],"operationId":"updateZendeskFieldById","tags":["Zendesk Fields"],"requestBody":{"required":true,"description":"data for updating a new Zendesk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskField not found"}}}},"/integrations/zendesk/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zendesk Field","security":[{"BearerAuth":[]}],"operationId":"deleteZendeskFieldById","tags":["Zendesk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskField not found"}}}},"/integrations/zoho/accounts":{"get":{"summary":"Gets a list of Zoho Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllZohoAccount","tags":["Zoho Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZohoAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zoho Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoAccount"}}}}},"206":{"description":"Partial (paged) collection of Zoho Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zoho Account","security":[{"BearerAuth":[]}],"operationId":"createZohoAccount","tags":["Zoho Accounts"],"requestBody":{"required":true,"description":"data for creating a new Zoho Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"host":{"type":"string"},"zone":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"serverUrl":{"type":"string"},"code":{"type":"string"},"refreshToken":{"type":"string"}}}}}},"responses":{"201":{"description":"ZohoAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/accounts/{id}":{"get":{"summary":"Gets a single Zoho Account","security":[{"BearerAuth":[]}],"operationId":"getZohoAccountById","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount to get"}],"responses":{"200":{"description":"ZohoAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoAccount not found"}}},"put":{"summary":"Update an existing Zoho Account","security":[{"BearerAuth":[]}],"operationId":"updateZohoAccountById","tags":["Zoho Accounts"],"requestBody":{"required":true,"description":"data for updating a new Zoho Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"host":{"type":"string"},"zone":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"serverUrl":{"type":"string"},"code":{"type":"string"},"refreshToken":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoAccount not found"}}}},"/integrations/zoho/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zoho Account","security":[{"BearerAuth":[]}],"operationId":"deleteZohoAccountById","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoAccount not found"}}}},"/integrations/zoho/configurations":{"get":{"summary":"Gets a list of Zoho Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllZohoConfiguration","tags":["Zoho Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZohoConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zoho Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Zoho Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zoho Configuration","security":[{"BearerAuth":[]}],"operationId":"createZohoConfiguration","tags":["Zoho Configurations"],"requestBody":{"required":true,"description":"data for creating a new Zoho Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"moduleCreate":{"type":"string","enum":["lead","contact","nothing"],"default":"lead"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"default":"contact_lead"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"ZohoConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/configurations/{id}":{"get":{"summary":"Gets a single Zoho Configuration","security":[{"BearerAuth":[]}],"operationId":"getZohoConfigurationById","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration to get"}],"responses":{"200":{"description":"ZohoConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoConfiguration not found"}}},"put":{"summary":"Update an existing Zoho Configuration","security":[{"BearerAuth":[]}],"operationId":"updateZohoConfigurationById","tags":["Zoho Configurations"],"requestBody":{"required":true,"description":"data for updating a new Zoho Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"moduleCreate":{"type":"string","enum":["lead","contact","nothing"],"default":"lead"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"default":"contact_lead"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoConfiguration not found"}}}},"/integrations/zoho/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zoho Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteZohoConfigurationById","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoConfiguration not found"}}}},"/integrations/zoho/fields":{"get":{"summary":"Gets a list of Zoho Fields","security":[{"BearerAuth":[]}],"operationId":"listAllZohoField","tags":["Zoho Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZohoField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zoho Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoField"}}}}},"206":{"description":"Partial (paged) collection of Zoho Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zoho Field","security":[{"BearerAuth":[]}],"operationId":"createZohoField","tags":["Zoho Fields"],"requestBody":{"required":true,"description":"data for creating a new Zoho Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"ZohoField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/fields/{id}":{"get":{"summary":"Gets a single Zoho Field","security":[{"BearerAuth":[]}],"operationId":"getZohoFieldById","tags":["Zoho Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoField to get"}],"responses":{"200":{"description":"ZohoField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoField not found"}}},"put":{"summary":"Update an existing Zoho Field","security":[{"BearerAuth":[]}],"operationId":"updateZohoFieldById","tags":["Zoho Fields"],"requestBody":{"required":true,"description":"data for updating a new Zoho Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoField not found"}}}},"/integrations/zoho/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zoho Field","security":[{"BearerAuth":[]}],"operationId":"deleteZohoFieldById","tags":["Zoho Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoField not found"}}}},"/jira":{"post":{"summary":"Creates a new issue","security":[{"BearerAuth":[]}],"operationId":"createJiraIssue","tags":["Issue"],"requestBody":{"required":true,"description":"Issue content","content":{"application/json":{"schema":{"type":"object","properties":{"issuetype":{"type":"string","description":"the issue type","default":"Bug"},"summary":{"type":"string","description":"short description of the issue"},"description":{"type":"string","description":"the issue full description"}},"required":["summary","description"]}}}},"responses":{"201":{"description":"issue submitted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/answers/reports":{"get":{"summary":"Gets a list of Reports","security":[{"BearerAuth":[]}],"operationId":"listAllJscriptyAnswerReport","tags":["JscriptyAnswerReport"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each JscriptyAnswerReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyAnswerReport"}}}}},"206":{"description":"Partial (paged) collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyAnswerReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Report","security":[{"BearerAuth":[]}],"operationId":"createJscriptyAnswerReport","tags":["JscriptyAnswerReport"],"requestBody":{"required":true,"description":"data for creating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"questionId":{"type":"string"}}}}}},"responses":{"201":{"description":"JscriptyAnswerReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyAnswerReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/answers/reports/describe":{"get":{"summary":"Gets table info about Reports","security":[{"BearerAuth":[]}],"operationId":"describeJscriptyAnswerReport","tags":["JscriptyAnswerReport"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/answers/reports/{id}":{"get":{"summary":"Gets a single Report","security":[{"BearerAuth":[]}],"operationId":"getJscriptyAnswerReportById","tags":["JscriptyAnswerReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyAnswerReport to get"}],"responses":{"200":{"description":"JscriptyAnswerReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyAnswerReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyAnswerReport not found"}}},"put":{"summary":"Update an existing Report","security":[{"BearerAuth":[]}],"operationId":"updateJscriptyAnswerReportById","tags":["JscriptyAnswerReport"],"requestBody":{"required":true,"description":"data for updating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"questionId":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyAnswerReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyAnswerReport not found"}}}},"/jscripty/answers/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Report","security":[{"BearerAuth":[]}],"operationId":"deleteJscriptyAnswerReportById","tags":["JscriptyAnswerReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyAnswerReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyAnswerReport not found"}}}},"/jscripty/projects":{"get":{"summary":"Gets a list of Projects","security":[{"BearerAuth":[]}],"operationId":"listAllJscriptyProject","tags":["Jscripty Projects"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each JscriptyProject"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Projects","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyProject"}}}}},"206":{"description":"Partial (paged) collection of Projects","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyProject"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Project","security":[{"BearerAuth":[]}],"operationId":"createJscriptyProject","tags":["Jscripty Projects"],"requestBody":{"required":true,"description":"data for creating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"formData":{"type":"string"},"enableUncompleteSave":{"type":"boolean","default":true},"sendUnpauseOnSubmit":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"JscriptyProject successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/{id}":{"get":{"summary":"Gets a single Project","security":[{"BearerAuth":[]}],"operationId":"getJscriptyProjectById","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject to get"}],"responses":{"200":{"description":"JscriptyProject with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyProject not found"}}},"put":{"summary":"Update an existing Project","security":[{"BearerAuth":[]}],"operationId":"updateJscriptyProjectById","tags":["Jscripty Projects"],"requestBody":{"required":true,"description":"data for updating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"formData":{"type":"string"},"enableUncompleteSave":{"type":"boolean","default":true},"sendUnpauseOnSubmit":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyProject not found"}}}},"/jscripty/projects/{id}/sessions":{"get":{"summary":"Gets jscripty project sessions","security":[{"BearerAuth":[]}],"operationId":"getSessions","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/{id}/answers":{"get":{"summary":"Gets jscripty project answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/{id}/summary":{"get":{"summary":"Gets jscripty project summary","security":[{"BearerAuth":[]}],"operationId":"getSummary","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/clone":{"post":{"summary":"Clone an existing Project","security":[{"BearerAuth":[]}],"operationId":"cloneJscriptyProject","tags":["Jscripty Projects"],"requestBody":{"required":true,"description":"data for creating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Project to clone"},"name":{"type":"string"},"description":{"type":"string"},"formData":{"type":"string"},"enableUncompleteSave":{"type":"boolean","default":true},"sendUnpauseOnSubmit":{"type":"boolean","default":false}},"required":["id"]}}}},"responses":{"201":{"description":"JscriptyProject successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Project","security":[{"BearerAuth":[]}],"operationId":"deleteJscriptyProjectById","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyProject not found"}}}},"/jscripty/questions/reports":{"get":{"summary":"Gets a list of Reports","security":[{"BearerAuth":[]}],"operationId":"listAllJscriptyQuestionReport","tags":["JscriptyQuestionReport"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each JscriptyQuestionReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyQuestionReport"}}}}},"206":{"description":"Partial (paged) collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyQuestionReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Report","security":[{"BearerAuth":[]}],"operationId":"createJscriptyQuestionReport","tags":["JscriptyQuestionReport"],"requestBody":{"required":true,"description":"data for creating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"questionId":{"type":"string"}}}}}},"responses":{"201":{"description":"JscriptyQuestionReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyQuestionReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/questions/reports/describe":{"get":{"summary":"Gets table info about Reports","security":[{"BearerAuth":[]}],"operationId":"describeJscriptyQuestionReport","tags":["JscriptyQuestionReport"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/questions/reports/{id}":{"get":{"summary":"Gets a single Report","security":[{"BearerAuth":[]}],"operationId":"getJscriptyQuestionReportById","tags":["JscriptyQuestionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyQuestionReport to get"}],"responses":{"200":{"description":"JscriptyQuestionReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyQuestionReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyQuestionReport not found"}}},"put":{"summary":"Update an existing Report","security":[{"BearerAuth":[]}],"operationId":"updateJscriptyQuestionReportById","tags":["JscriptyQuestionReport"],"requestBody":{"required":true,"description":"data for updating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"questionId":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyQuestionReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyQuestionReport not found"}}}},"/jscripty/questions/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Report","security":[{"BearerAuth":[]}],"operationId":"deleteJscriptyQuestionReportById","tags":["JscriptyQuestionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyQuestionReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyQuestionReport not found"}}}},"/jscripty/sessions/reports":{"get":{"summary":"Gets a list of Reports","security":[{"BearerAuth":[]}],"operationId":"listAllJscriptySessionReport","tags":["JscriptySessionReport"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each JscriptySessionReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptySessionReport"}}}}},"206":{"description":"Partial (paged) collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptySessionReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Report","security":[{"BearerAuth":[]}],"operationId":"createJscriptySessionReport","tags":["JscriptySessionReport"],"requestBody":{"required":true,"description":"data for creating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"starttime":{"type":"string"},"endtime":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"completed":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"JscriptySessionReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptySessionReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/sessions/reports/describe":{"get":{"summary":"Gets table info about Reports","security":[{"BearerAuth":[]}],"operationId":"describeJscriptySessionReport","tags":["JscriptySessionReport"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/sessions/reports/{id}":{"get":{"summary":"Gets a single Report","security":[{"BearerAuth":[]}],"operationId":"getJscriptySessionReportById","tags":["JscriptySessionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptySessionReport to get"}],"responses":{"200":{"description":"JscriptySessionReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptySessionReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptySessionReport not found"}}},"put":{"summary":"Update an existing Report","security":[{"BearerAuth":[]}],"operationId":"updateJscriptySessionReportById","tags":["JscriptySessionReport"],"requestBody":{"required":true,"description":"data for updating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"starttime":{"type":"string"},"endtime":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"completed":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptySessionReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptySessionReport not found"}}}},"/jscripty/sessions/reports/{id}/questions":{"get":{"summary":"Gets Jscripty Session questions","security":[{"BearerAuth":[]}],"operationId":"getQuestions","tags":["JscriptySessionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptySessionReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/sessions/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Report","security":[{"BearerAuth":[]}],"operationId":"deleteJscriptySessionReportById","tags":["JscriptySessionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptySessionReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptySessionReport not found"}}}},"/license/":{"get":{"summary":"Gets License Info","operationId":"index","tags":["License"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/license/{id}":{"put":{"summary":"Update License Info","security":[{"BearerAuth":[]}],"operationId":"update","tags":["License"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the License"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllMailAccount","tags":["Mail Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeMailAccount","tags":["Mail Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getMailAccountById","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount to get"}],"responses":{"200":{"description":"MailAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateMailAccountById","tags":["Mail Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"},"service":{"type":"boolean","default":false},"email":{"type":"string"},"active":{"type":"boolean","default":true},"key":{"type":"string"},"template":{"type":"string"},"markAsUnread":{"type":"boolean","default":false},"fontFamily":{"type":"string","default":"Arial,Helvetica,sans-serif"},"fontSize":{"type":"integer","default":13},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}<br/>Subject : {{message.subject}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailAccount not found"}}},"delete":{"summary":"Deletes a mail account","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/in_servers":{"get":{"summary":"Gets account IMAP server","security":[{"BearerAuth":[]}],"operationId":"getImap","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new IMAP server","security":[{"BearerAuth":[]}],"operationId":"addImap","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes IMAP server from an account","security":[{"BearerAuth":[]}],"operationId":"removeImap","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/out_servers":{"get":{"summary":"Gets account SMTP server","security":[{"BearerAuth":[]}],"operationId":"getSmtp","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new SMTP server","security":[{"BearerAuth":[]}],"operationId":"addSmtp","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes SMTP server from an account","security":[{"BearerAuth":[]}],"operationId":"removeSmtp","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/interactions":{"get":{"summary":"Gets account interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new interactions","security":[{"BearerAuth":[]}],"operationId":"addInteraction","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/applications":{"get":{"summary":"Gets account applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/messages":{"get":{"summary":"Gets account messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/verify":{"get":{"summary":"Verify mail account","security":[{"BearerAuth":[]}],"operationId":"verifySmtp","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/users":{"get":{"summary":"Gets agents from mail account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a mail account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a mail account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/":{"post":{"summary":"Create a mail account","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Mail Accounts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/send":{"post":{"summary":"Send new mail","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getMailApplicationById","tags":["Mail Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailApplication to get"}],"responses":{"200":{"description":"MailApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateMailApplicationById","tags":["Mail Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailApplication not found"}}}},"/mail/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteMailApplicationById","tags":["Mail Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailApplication not found"}}}},"/mail/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllMailInteraction","tags":["Mail Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createMailInteraction","tags":["Mail Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"inReplyTo":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"subject":{"type":"string"},"attach":{"type":"boolean","default":false},"read1stAt":{"type":"string"},"substatus":{"type":"string"},"substatusAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgBody":{"type":"string"},"lastMsgText":{"type":"string"}},"required":["firstMsgDirection","lastMsgDirection"]}}}},"responses":{"201":{"description":"MailInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeMailInteraction","tags":["Mail Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getMailInteractionById","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction to get"}],"responses":{"200":{"description":"MailInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateMailInteractionById","tags":["Mail Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"inReplyTo":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"subject":{"type":"string"},"attach":{"type":"boolean","default":false},"read1stAt":{"type":"string"},"substatus":{"type":"string"},"substatusAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgBody":{"type":"string"},"lastMsgText":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailInteraction not found"}}}},"/mail/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new message","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteMailInteractionById","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailInteraction not found"}}}},"/mail/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllMailMessage","tags":["Mail Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeMailMessage","tags":["Mail Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getMailMessageById","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage to get"}],"responses":{"200":{"description":"MailMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateMailMessageById","tags":["Mail Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"plainBody":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"bcc":{"type":"string"},"subject":{"type":"string"},"sentAt":{"type":"string"},"attach":{"type":"integer","default":0},"secret":{"type":"boolean","default":false},"readAt":{"type":"string"},"originTo":{"type":"string"},"originCc":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailMessage not found"}}}},"/mail/messages/{id}/download":{"get":{"summary":"Gets message","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/":{"post":{"summary":"Create a message","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Mail Messages"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteMailMessageById","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailMessage not found"}}}},"/mail/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllMailQueue","tags":["Mail Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createMailQueue","tags":["Mail Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"responses":{"201":{"description":"MailQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeMailQueue","tags":["Mail Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getMailQueueById","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue to get"}],"responses":{"200":{"description":"MailQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateMailQueueById","tags":["Mail Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueue not found"}}}},"/mail/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteMailQueueById","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueue not found"}}}},"/mail/reports/queue":{"get":{"summary":"Gets a list of Mail Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllMailQueueReport","tags":["Mail Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Mail Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Mail Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Mail Queue Report","security":[{"BearerAuth":[]}],"operationId":"createMailQueueReport","tags":["Mail Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Mail Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"MailQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/reports/queue/describe":{"get":{"summary":"Gets table info about Mail Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeMailQueueReport","tags":["Mail Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/reports/queue/{id}":{"get":{"summary":"Gets a single Mail Queue Report","security":[{"BearerAuth":[]}],"operationId":"getMailQueueReportById","tags":["Mail Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueueReport to get"}],"responses":{"200":{"description":"MailQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueueReport not found"}}},"put":{"summary":"Update an existing Mail Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateMailQueueReportById","tags":["Mail Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Mail Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueueReport not found"}}}},"/mail/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Mail Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteMailQueueReportById","tags":["Mail Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueueReport not found"}}}},"/mail/out_servers":{"get":{"summary":"Gets a list of SMTPs","security":[{"BearerAuth":[]}],"operationId":"listAllMailServerOut","tags":["Mail SMTP"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailServerOut"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of SMTPs","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailServerOut"}}}}},"206":{"description":"Partial (paged) collection of SMTPs","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailServerOut"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new SMTP","security":[{"BearerAuth":[]}],"operationId":"createMailServerOut","tags":["Mail SMTP"],"requestBody":{"required":true,"description":"data for creating a new SMTP","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"host":{"type":"string"},"user":{"type":"string"},"pass":{"type":"string"},"port":{"type":"integer"},"secure":{"type":"boolean","default":false},"service":{"type":"string"},"authentication":{"type":"boolean","default":true}}}}}},"responses":{"201":{"description":"MailServerOut successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailServerOut"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/out_servers/{id}":{"get":{"summary":"Gets a single SMTP","security":[{"BearerAuth":[]}],"operationId":"getMailServerOutById","tags":["Mail SMTP"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailServerOut to get"}],"responses":{"200":{"description":"MailServerOut with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailServerOut"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailServerOut not found"}}},"put":{"summary":"Update an existing SMTP","security":[{"BearerAuth":[]}],"operationId":"updateMailServerOutById","tags":["Mail SMTP"],"requestBody":{"required":true,"description":"data for updating a new SMTP","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"host":{"type":"string"},"user":{"type":"string"},"pass":{"type":"string"},"port":{"type":"integer"},"secure":{"type":"boolean","default":false},"service":{"type":"string"},"authentication":{"type":"boolean","default":true}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailServerOut to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailServerOut not found"}}}},"/mail/out_servers/{id}/destroy_many":{"delete":{"summary":"Destroy an existing SMTP","security":[{"BearerAuth":[]}],"operationId":"deleteMailServerOutById","tags":["Mail SMTP"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailServerOut to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailServerOut not found"}}}},"/mail/substatuses":{"get":{"summary":"Gets a list of Substatuses","security":[{"BearerAuth":[]}],"operationId":"listAllMailSubstatus","tags":["Mail Substatuses"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailSubstatus"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Substatuses","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailSubstatus"}}}}},"206":{"description":"Partial (paged) collection of Substatuses","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailSubstatus"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createMailSubstatus","tags":["Mail Substatuses"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"MailSubstatus successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSubstatus"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/substatuses/describe":{"get":{"summary":"Gets table info about Substatuses","security":[{"BearerAuth":[]}],"operationId":"describeMailSubstatus","tags":["Mail Substatuses"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/substatuses/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getMailSubstatusById","tags":["Mail Substatuses"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailSubstatus to get"}],"responses":{"200":{"description":"MailSubstatus with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSubstatus"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailSubstatus not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateMailSubstatusById","tags":["Mail Substatuses"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailSubstatus to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailSubstatus not found"}}}},"/mail/substatuses/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteMailSubstatusById","tags":["Mail Substatuses"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailSubstatus to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailSubstatus not found"}}}},"/mail/reports/transfer":{"get":{"summary":"Gets a list of Mail Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllMailTransferReport","tags":["Mail Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Mail Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Mail Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Mail Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createMailTransferReport","tags":["Mail Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Mail Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"MailTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/reports/transfer/describe":{"get":{"summary":"Gets table info about Mail Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeMailTransferReport","tags":["Mail Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/reports/transfer/{id}":{"get":{"summary":"Gets a single Mail Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getMailTransferReportById","tags":["Mail Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailTransferReport to get"}],"responses":{"200":{"description":"MailTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailTransferReport not found"}}},"put":{"summary":"Update an existing Mail Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateMailTransferReportById","tags":["Mail Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Mail Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailTransferReport not found"}}}},"/mail/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Mail Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteMailTransferReportById","tags":["Mail Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailTransferReport not found"}}}},"/members/reports":{"get":{"summary":"Gets a list of Member Reports","security":[{"BearerAuth":[]}],"operationId":"listAllMemberReport","tags":["Member Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MemberReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Member Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MemberReport"}}}}},"206":{"description":"Partial (paged) collection of Member Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MemberReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/members/reports/describe":{"get":{"summary":"Gets table info about Member Reports","security":[{"BearerAuth":[]}],"operationId":"describeMemberReport","tags":["Member Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/members/reports/{id}":{"get":{"summary":"Gets a single Member Report","security":[{"BearerAuth":[]}],"operationId":"getMemberReportById","tags":["Member Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MemberReport to get"}],"responses":{"200":{"description":"MemberReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MemberReport not found"}}}},"/migrations":{"get":{"summary":"Gets a list of Migrations","operationId":"listAllMigration","tags":["Migrations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Migration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Migrations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Migration"}}}}},"206":{"description":"Partial (paged) collection of Migrations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Migration"}}}}}}}},"/networks":{"get":{"summary":"Gets a list of Networks","security":[{"BearerAuth":[]}],"operationId":"listAllNetwork","tags":["Networks"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Network"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Networks","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}}}},"206":{"description":"Partial (paged) collection of Networks","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/networks/{id}":{"get":{"summary":"Gets a single Network","security":[{"BearerAuth":[]}],"operationId":"getNetworkById","tags":["Networks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Network to get"}],"responses":{"200":{"description":"Network with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Network not found"}}},"put":{"summary":"Update an existing network","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Networks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Network"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Deletes a network","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Networks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Network"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/networks/":{"post":{"summary":"Create a new network","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Networks"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/notifications/":{"post":{"summary":"Send notification to user","security":[{"BearerAuth":[]}],"operationId":"sendNotification","tags":["Notifications"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelAccount","tags":["Openchannel Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Account","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelAccount","tags":["Openchannel Accounts"],"requestBody":{"required":true,"description":"data for creating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"token":{"type":"string","default":"opoXzKt8ZC9vMwf35tCZb0Y8Ci6w5NXM"},"replyUri":{"type":"string"},"key":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"mapKey":{"type":"string"},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}},"required":["name","key"]}}}},"responses":{"201":{"description":"OpenchannelAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelAccount","tags":["Openchannel Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelAccountById","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount to get"}],"responses":{"200":{"description":"OpenchannelAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelAccountById","tags":["Openchannel Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"token":{"type":"string","default":"HgITaNXHR7se5sobT0VIEUDhnuXiOOoL"},"replyUri":{"type":"string"},"key":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"mapKey":{"type":"string"},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelAccount not found"}}}},"/openchannel/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/applications":{"get":{"summary":"Gets account applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/interactions":{"get":{"summary":"Gets Openchannel Account Interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/users":{"get":{"summary":"Gets agents from openchannel account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a openchannel account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a openchannel account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/notify":{"post":{"summary":"Notify new message","operationId":"notify","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"}}}},"/openchannel/accounts/{id}/send":{"post":{"summary":"Send new openchannel message","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Account","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelAccountById","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelAccount not found"}}}},"/openchannel/applications":{"get":{"summary":"Gets a list of Applications","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelApplication","tags":["Openchannel Applications"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelApplication"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelApplication"}}}}},"206":{"description":"Partial (paged) collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelApplication"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Application","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelApplication","tags":["Openchannel Applications"],"requestBody":{"required":true,"description":"data for creating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}},"required":["priority","app"]}}}},"responses":{"201":{"description":"OpenchannelApplication successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelApplicationById","tags":["Openchannel Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelApplication to get"}],"responses":{"200":{"description":"OpenchannelApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelApplicationById","tags":["Openchannel Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelApplication not found"}}}},"/openchannel/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelApplicationById","tags":["Openchannel Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelApplication not found"}}}},"/openchannel/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelInteraction","tags":["Openchannel Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelInteraction","tags":["Openchannel Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"read1stAt":{"type":"string"},"threadId":{"type":"string"},"externalUrl":{"type":"string"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"from":{"type":"string"}},"required":["lastMsgDirection"]}}}},"responses":{"201":{"description":"OpenchannelInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelInteraction","tags":["Openchannel Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelInteractionById","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction to get"}],"responses":{"200":{"description":"OpenchannelInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelInteractionById","tags":["Openchannel Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"read1stAt":{"type":"string"},"threadId":{"type":"string"},"externalUrl":{"type":"string"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"from":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelInteraction not found"}}}},"/openchannel/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelInteractionById","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelInteraction not found"}}}},"/openchannel/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelMessage","tags":["Openchannel Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelMessage","tags":["Openchannel Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"secret":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"OpenchannelMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelMessage","tags":["Openchannel Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelMessageById","tags":["Openchannel Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage to get"}],"responses":{"200":{"description":"OpenchannelMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelMessageById","tags":["Openchannel Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"secret":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelMessage not found"}}}},"/openchannel/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Openchannel Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Openchannel Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelMessageById","tags":["Openchannel Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelMessage not found"}}}},"/openchannel/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelQueue","tags":["Openchannel Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelQueue","tags":["Openchannel Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"responses":{"201":{"description":"OpenchannelQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelQueue","tags":["Openchannel Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelQueueById","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue to get"}],"responses":{"200":{"description":"OpenchannelQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelQueueById","tags":["Openchannel Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueue not found"}}}},"/openchannel/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelQueueById","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueue not found"}}}},"/openchannel/reports/queue":{"get":{"summary":"Gets a list of Openchannel Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelQueueReport","tags":["Openchannel Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Openchannel Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Openchannel Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Openchannel Queue Report","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelQueueReport","tags":["Openchannel Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Openchannel Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"OpenchannelQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/reports/queue/describe":{"get":{"summary":"Gets table info about Openchannel Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelQueueReport","tags":["Openchannel Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/reports/queue/{id}":{"get":{"summary":"Gets a single Openchannel Queue Report","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelQueueReportById","tags":["Openchannel Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueueReport to get"}],"responses":{"200":{"description":"OpenchannelQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueueReport not found"}}},"put":{"summary":"Update an existing Openchannel Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelQueueReportById","tags":["Openchannel Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Openchannel Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueueReport not found"}}}},"/openchannel/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Openchannel Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelQueueReportById","tags":["Openchannel Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueueReport not found"}}}},"/openchannel/reports/transfer":{"get":{"summary":"Gets a list of Openchannel Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelTransferReport","tags":["Openchannel Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Openchannel Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Openchannel Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Openchannel Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelTransferReport","tags":["Openchannel Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Openchannel Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"OpenchannelTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/reports/transfer/describe":{"get":{"summary":"Gets table info about Openchannel Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelTransferReport","tags":["Openchannel Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/reports/transfer/{id}":{"get":{"summary":"Gets a single Openchannel Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelTransferReportById","tags":["Openchannel Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelTransferReport to get"}],"responses":{"200":{"description":"OpenchannelTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelTransferReport not found"}}},"put":{"summary":"Update an existing Openchannel Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelTransferReportById","tags":["Openchannel Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Openchannel Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelTransferReport not found"}}}},"/openchannel/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Openchannel Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelTransferReportById","tags":["Openchannel Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelTransferReport not found"}}}},"/pauses":{"get":{"summary":"Gets a list of Pauses","security":[{"BearerAuth":[]}],"operationId":"listAllPause","tags":["Pauses"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Pause"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Pauses","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pause"}}}}},"206":{"description":"Partial (paged) collection of Pauses","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pause"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Pause","security":[{"BearerAuth":[]}],"operationId":"createPause","tags":["Pauses"],"requestBody":{"required":true,"description":"data for creating a new Pause","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Pause successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pause"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/pauses/{id}":{"get":{"summary":"Gets a single Pause","security":[{"BearerAuth":[]}],"operationId":"getPauseById","tags":["Pauses"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Pause to get"}],"responses":{"200":{"description":"Pause with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pause"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Pause not found"}}},"put":{"summary":"Update an existing Pause","security":[{"BearerAuth":[]}],"operationId":"updatePauseById","tags":["Pauses"],"requestBody":{"required":true,"description":"data for updating a new Pause","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Pause to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Pause not found"}}}},"/pauses/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Pause","security":[{"BearerAuth":[]}],"operationId":"deletePauseById","tags":["Pauses"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Pause to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Pause not found"}}}},"/plugins":{"get":{"summary":"Gets a list of Plugins","security":[{"BearerAuth":[]}],"operationId":"listAllPlugin","tags":["Plugins"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Plugin"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Plugins","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Plugin"}}}}},"206":{"description":"Partial (paged) collection of Plugins","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Plugin"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/plugins/webhook":{"get":{"summary":"Redirect a plugin request to the specified path","operationId":"webhookGet","tags":["Plugins"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Redirect a plugin request to the specified path","operationId":"webhookPost","tags":["Plugins"],"responses":{"201":{"description":"successfully created"}}}},"/plugins/{id}":{"get":{"summary":"Gets a single Plugin","security":[{"BearerAuth":[]}],"operationId":"getPluginById","tags":["Plugins"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Plugin to get"}],"responses":{"200":{"description":"Plugin with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plugin"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Plugin not found"}}},"put":{"summary":"Update an existing plugin","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Plugins"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Plugin"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Delete a plugin","security":[{"BearerAuth":[]}],"operationId":"delete","tags":["Plugins"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Plugin"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/plugins/{id}/download":{"get":{"summary":"Download plugin source code","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Plugins"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Plugin"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/plugins/":{"post":{"summary":"Upload new plugin","security":[{"BearerAuth":[]}],"operationId":"postupload","tags":["Plugins"],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/pm2":{"get":{"summary":"Gets pm2 processes","security":[{"BearerAuth":[]}],"operationId":"getPm2Processes","tags":["Pm2"],"responses":{"200":{"description":"list of processes","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Start a single pm2 process","security":[{"BearerAuth":[]}],"operationId":"startPm2Process","tags":["Pm2"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the process"}],"requestBody":{"required":true,"description":"process data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"process name"},"script":{"type":"string","description":"script name"}},"required":["name","script"]}}}},"responses":{"201":{"description":"successfully started"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}}},"/pm2/{id}":{"get":{"summary":"Gets a single pm2 process by id","security":[{"BearerAuth":[]}],"operationId":"getPm2Process","tags":["Pm2"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the process"}],"responses":{"200":{"description":"process information","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}},"put":{"summary":"Update an existing process","security":[{"BearerAuth":[]}],"operationId":"updatePm2Process","tags":["Pm2"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the process"}],"requestBody":{"required":true,"description":"process data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"process name"},"script":{"type":"string","description":"script name"}},"required":["name","script"]}}}},"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}},"delete":{"summary":"Delete an existing process by id","security":[{"BearerAuth":[]}],"operationId":"deletePm2Process","tags":["Pm2"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the process"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}}},"/rpc/voice/channels":{"get":{"summary":"Gets a list of RTVoiceChannels","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceChannels","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTVoiceChannels","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/channels/{uniqueid}/mixmonitor":{"get":{"summary":"Gets a list of RTVoiceChannelMixMonitor","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceChannelMixMonitor","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"}],"responses":{"200":{"description":"list of RTVoiceChannelMixMonitor","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/channels/{uniqueid}/stopmixmonitor":{"get":{"summary":"Gets a list of RTVoiceChannelStopMixMonitor","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceChannelStopMixMonitor","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"}],"responses":{"200":{"description":"list of RTVoiceChannelStopMixMonitor","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/queues":{"get":{"summary":"Gets a list of RTVoiceQueues","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTVoiceQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/chat/queues":{"get":{"summary":"Gets a list of RTChatQueues","security":[{"BearerAuth":[]}],"operationId":"getRTChatQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTChatQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/mail/queues":{"get":{"summary":"Gets a list of RTMailQueues","security":[{"BearerAuth":[]}],"operationId":"getRTMailQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTMailQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/mail/accounts":{"get":{"summary":"Gets a list of RTMailAccounts","security":[{"BearerAuth":[]}],"operationId":"getRTMailAccounts","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTMailAccounts","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/openchannel/queues":{"get":{"summary":"Gets a list of RTOpenchannelQueues","security":[{"BearerAuth":[]}],"operationId":"getRTOpenchannelQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTOpenchannelQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/sms/queues":{"get":{"summary":"Gets a list of RTSmsQueues","security":[{"BearerAuth":[]}],"operationId":"getRTSmsQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTSmsQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/whatsapp/queues":{"get":{"summary":"Gets a list of RTWhatsappQueues","security":[{"BearerAuth":[]}],"operationId":"getRTWhatsappQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTWhatsappQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/fax/queues":{"get":{"summary":"Gets a list of RTFaxQueues","security":[{"BearerAuth":[]}],"operationId":"getRTFaxQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTFaxQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/queues/preview/{id}":{"get":{"summary":"Gets a single preview contact","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueuePreview","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the preview"}],"responses":{"200":{"description":"preview contact","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"preview contact not found"}}}},"/rpc/voice/queues/channels":{"get":{"summary":"Gets a list of RTVoiceQueuesChannels","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueuesChannels","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTVoiceQueuesChannels","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/queues/channels/{uniqueid}":{"get":{"summary":"Gets a single RTVoiceQueueChannel","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueueChannel","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"}],"responses":{"200":{"description":"RT Voice Queue Channel","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Channel not found"}}}},"/rpc/voice/queues/channels/{uniqueid}/hangup":{"get":{"summary":"Hangup a single RTVoiceQueueChannel","security":[{"BearerAuth":[]}],"operationId":"hangupRTVoiceQueueChannel","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"}],"responses":{"200":{"description":"Hangup ok"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Channel not found"}}}},"/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}":{"get":{"summary":"Redirect a single RTVoiceQueueChannel to a specific extension.","security":[{"BearerAuth":[]}],"operationId":"redirectRTVoiceQueueChannel","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"},{"in":"path","name":"exten","schema":{"type":"string"},"required":true,"description":"extension name"}],"responses":{"200":{"description":"Redirect ok"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Channel or extension not found"}}}},"/rpc/voice/queues/{id}":{"get":{"summary":"Gets a single RTVoiceQueue","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"RT Voice Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"RT Voice Queue not found"}}}},"/rpc/outbound":{"get":{"summary":"Gets a list of RTOutbound","security":[{"BearerAuth":[]}],"operationId":"getRTOutbound","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTOutbound","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/outbound/channels":{"get":{"summary":"Gets a list of RTOutboundChannels","security":[{"BearerAuth":[]}],"operationId":"getRTOutboundChannels","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTOutboundChannels","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/agents":{"get":{"summary":"Gets a list of RTAgents","security":[{"BearerAuth":[]}],"operationId":"getRTAgents","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTAgents","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/agents/{id}/capacity":{"put":{"summary":"Sets agent capacity","security":[{"BearerAuth":[]}],"operationId":"putRTAgentCapacity","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the agent"}],"requestBody":{"required":true,"description":"Desired capacity payload","content":{"application/json":{"schema":{"type":"object","properties":{"capacity":{"type":"integer","description":"the desired capacity"},"interaction":{"type":"object","description":"interaction"}},"required":["capacity","interaction"]}}}},"responses":{"200":{"description":"Capacity updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"agent id"},"capacity":{"type":"integer","description":"agent capacity"}},"required":["id","capacity"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Agent not found"}}}},"/rpc/telephones":{"get":{"summary":"Gets a list of RTTelephones","security":[{"BearerAuth":[]}],"operationId":"getRTTelephones","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTTelephones","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/trunks":{"get":{"summary":"Gets a list of RTTrunks","security":[{"BearerAuth":[]}],"operationId":"getRTTrunks","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTTrunks","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/campaigns":{"get":{"summary":"Gets a list of campaigns","security":[{"BearerAuth":[]}],"operationId":"getCampaigns","tags":["RPC Realtime"],"responses":{"200":{"description":"list of campaigns","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/fax/accounts":{"get":{"summary":"Gets a list of FaxAccounts","security":[{"BearerAuth":[]}],"operationId":"getFaxAccounts","tags":["RPC Realtime"],"responses":{"200":{"description":"list of FaxAccounts","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/chat/queues/waitinginteractions":{"get":{"summary":"Gets a list of chatQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getChatQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of chatQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/mail/queues/waitinginteractions":{"get":{"summary":"Gets a list of mailQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getMailQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of mailQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/openchannel/queues/waitinginteractions":{"get":{"summary":"Gets a list of openchannelQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of openchannelQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/openchannel/queues/{id}/waitinginteractions":{"get":{"summary":"Gets a list of openchannelQueuesIdWaitingInteractions for the queue","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelQueuesWaitingInteractionsForId","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"list of openchannelQueuesIdWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/sms/queues/waitinginteractions":{"get":{"summary":"Gets a list of smsQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getSmsQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of getSmsQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/whatsapp/queues/waitinginteractions":{"get":{"summary":"Gets a list of whatsappQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getWhatsappQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of whatsappQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/fax/queues/waitinginteractions":{"get":{"summary":"Gets a list of faxQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getFaxQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of faxQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/mail/queues/{id}/notify":{"post":{"summary":"Notify message to a specific mail queue","security":[{"BearerAuth":[]}],"operationId":"postMailQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the agent"}],"requestBody":{"required":true,"description":"message to be notified","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Agent not found"}}}},"/rpc/mail/queues/{id}":{"get":{"summary":"Gets a single RTMailQueue","security":[{"BearerAuth":[]}],"operationId":"getRTMailQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/chat/queues/{id}/notify":{"post":{"summary":"Notify message to a specific chat queue","security":[{"BearerAuth":[]}],"operationId":"postChatQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the agent"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Agent not found"}}}},"/rpc/chat/queues/{id}":{"get":{"summary":"Gets a single RTChatQueue","security":[{"BearerAuth":[]}],"operationId":"getRTChatQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/fax/queues/{id}/notify":{"post":{"summary":"Notify message to a specific fax queue","security":[{"BearerAuth":[]}],"operationId":"postFaxQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/fax/queues/{id}":{"get":{"summary":"Gets a single RTFaxQueue","security":[{"BearerAuth":[]}],"operationId":"getRTFaxQueue","tags":["RPC Realtimen"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/openchannel/queues/{id}/notify":{"post":{"summary":"Notify message to a specific openchannel queue","security":[{"BearerAuth":[]}],"operationId":"postOpenchannelQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}}},"/rpc/openchannel/queues/{id}":{"get":{"summary":"Gets a single RTOpenchannelQueue","security":[{"BearerAuth":[]}],"operationId":"getRTOpenchannelQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/sms/queues/{id}/notify":{"post":{"summary":"Notify message to a specific sms queue","security":[{"BearerAuth":[]}],"operationId":"postSmsQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}}},"/rpc/whatsapp/queues/{id}/notify":{"post":{"summary":"Notify message to a specific agent","security":[{"BearerAuth":[]}],"operationId":"postAgentNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the agent"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Agent not found"}}}},"/rpc/sms/queues/{id}":{"get":{"summary":"Gets a single RTSmsQueue","security":[{"BearerAuth":[]}],"operationId":"getRTSmsQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/whatsapp/queues/{id}":{"get":{"summary":"Gets a single RTWhatsappQueue","security":[{"BearerAuth":[]}],"operationId":"getRTWhatsappQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/schedules":{"get":{"summary":"Gets a list of Schedules","security":[{"BearerAuth":[]}],"operationId":"listAllSchedule","tags":["Schedules"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Schedule"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Schedules","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Schedule"}}}}},"206":{"description":"Partial (paged) collection of Schedules","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Schedule"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Schedule","security":[{"BearerAuth":[]}],"operationId":"createSchedule","tags":["Schedules"],"requestBody":{"required":true,"description":"data for creating a new Schedule","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean","default":false},"cron":{"type":"string","default":"0 0 * * *"},"startAt":{"type":"string"},"endAt":{"type":"string"},"subtractNumber":{"type":"integer","default":1},"subtractUnit":{"type":"string","enum":["years","quarters","months","weeks","days","hours","minutes"],"default":"days"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"type":{"type":"string","enum":["custom","default"],"default":"custom"},"sendMail":{"type":"boolean","default":false},"email":{"type":"string"},"cc":{"type":"string"},"bcc":{"type":"string"},"sendIfEmpty":{"type":"boolean","default":true}},"required":["name","active","cron","startAt","endAt","subtractNumber","subtractUnit","output","type"]}}}},"responses":{"201":{"description":"Schedule successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/schedules/{id}":{"get":{"summary":"Gets a single Schedule","security":[{"BearerAuth":[]}],"operationId":"getScheduleById","tags":["Schedules"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Schedule to get"}],"responses":{"200":{"description":"Schedule with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Schedule not found"}}},"put":{"summary":"Update an existing Schedule","security":[{"BearerAuth":[]}],"operationId":"updateScheduleById","tags":["Schedules"],"requestBody":{"required":true,"description":"data for updating a new Schedule","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean","default":false},"cron":{"type":"string","default":"0 0 * * *"},"startAt":{"type":"string"},"endAt":{"type":"string"},"subtractNumber":{"type":"integer","default":1},"subtractUnit":{"type":"string","enum":["years","quarters","months","weeks","days","hours","minutes"],"default":"days"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"type":{"type":"string","enum":["custom","default"],"default":"custom"},"sendMail":{"type":"boolean","default":false},"email":{"type":"string"},"cc":{"type":"string"},"bcc":{"type":"string"},"sendIfEmpty":{"type":"boolean","default":true}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Schedule to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Schedule not found"}}}},"/schedules/{id}/run":{"get":{"summary":"Run Scheduler","security":[{"BearerAuth":[]}],"operationId":"run","tags":["Schedules"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Schedule"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/schedules/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Schedule","security":[{"BearerAuth":[]}],"operationId":"deleteScheduleById","tags":["Schedules"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Schedule to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Schedule not found"}}}},"/screen/recordings":{"get":{"summary":"Gets a list of Recordings","security":[{"BearerAuth":[]}],"operationId":"listAllScreenRecording","tags":["Screen Recordings"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ScreenRecording"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenRecording"}}}}},"206":{"description":"Partial (paged) collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenRecording"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Recording","security":[{"BearerAuth":[]}],"operationId":"createScreenRecording","tags":["Screen Recordings"],"requestBody":{"required":true,"description":"data for creating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string"},"interactionid":{"type":"string"},"channel":{"type":"string"},"value":{"type":"string"},"rating":{"type":"integer"},"duration":{"type":"integer"},"startedAt":{"type":"string"},"closedAt":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"responses":{"201":{"description":"ScreenRecording successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/screen/recordings/describe":{"get":{"summary":"Gets table info about Recordings","security":[{"BearerAuth":[]}],"operationId":"describeScreenRecording","tags":["Screen Recordings"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/screen/recordings/{id}":{"get":{"summary":"Gets a single Recording","security":[{"BearerAuth":[]}],"operationId":"getScreenRecordingById","tags":["Screen Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ScreenRecording to get"}],"responses":{"200":{"description":"ScreenRecording with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ScreenRecording not found"}}},"put":{"summary":"Update an existing Recording","security":[{"BearerAuth":[]}],"operationId":"updateScreenRecordingById","tags":["Screen Recordings"],"requestBody":{"required":true,"description":"data for updating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string"},"interactionid":{"type":"string"},"channel":{"type":"string"},"value":{"type":"string"},"rating":{"type":"integer"},"duration":{"type":"integer"},"startedAt":{"type":"string"},"closedAt":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ScreenRecording to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ScreenRecording not found"}}},"delete":{"summary":"Delete screen recording","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Screen Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ScreenRecording"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/screen/recordings/{id}/download":{"get":{"summary":"Download Recording","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Screen Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ScreenRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings":{"get":{"summary":"Gets a list of Settings","security":[{"BearerAuth":[]}],"operationId":"listAllSetting","tags":["Settings"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Setting"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Settings","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Setting"}}}}},"206":{"description":"Partial (paged) collection of Settings","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Setting"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings/now":{"get":{"summary":"Get Server Current Date","operationId":"getDate","tags":["Settings"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/settings/{id}":{"get":{"summary":"Gets a single Setting","operationId":"getSettingById","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting to get"}],"responses":{"200":{"description":"Setting with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Setting"}}}},"404":{"description":"Setting not found"}}},"put":{"summary":"Update an existing Setting","security":[{"BearerAuth":[]}],"operationId":"updateSettingById","tags":["Settings"],"requestBody":{"required":true,"description":"data for updating a new Setting","content":{"application/json":{"schema":{"type":"object","properties":{"min_internal":{"type":"integer","default":1000},"min_mailbox":{"type":"integer","default":1000},"agi_port":{"type":"integer","default":4573},"soundPath":{"type":"string","default":"/var/opt/motion2/server/files/sounds/converted"},"logo":{"type":"string"},"defaultLogo":{"type":"boolean","default":true},"loginLogo":{"type":"string"},"defaultLoginLogo":{"type":"boolean","default":true},"headerWhiteLabel":{"type":"string"},"defaultHeaderWhiteLabel":{"type":"boolean","default":true},"securePassword":{"type":"boolean","default":true},"firstSetup":{"type":"boolean","default":true},"stunaddr":{"type":"string"},"turnaddr":{"type":"string"},"turnusername":{"type":"string"},"turnpassword":{"type":"string"},"pageTitle":{"type":"string"},"defaultPageTitle":{"type":"boolean","default":true},"callRecordingEncryption":{"type":"boolean","default":false},"passwordExpiresDays":{"type":"integer","default":90},"phoneBarAutoUpdater":{"type":"boolean","default":true},"phoneBarAutoUpdaterUrl":{"type":"string","default":"https://www.xcally.com/bar/phonebar/autoupdater.xml"},"enableEmailPreview":{"type":"boolean","default":false},"split":{"type":"boolean","default":true},"splitSizeCsv":{"type":"integer","default":5000},"splitSizePdf":{"type":"integer","default":5000},"splitSizeXlsx":{"type":"integer","default":5000},"messagesAlignment":{"type":"string","default":"alternate"},"chatTimeout":{"type":"integer","default":30},"phoneBarRememberMeEnabled":{"type":"boolean","default":true},"preferred":{"type":"string"},"defaultPreferred":{"type":"boolean","default":true},"rtlSupport":{"type":"boolean","default":false},"defaultScreenRecordingPath":{"type":"string"},"allowedLoginAttempts":{"type":"integer","default":5},"blockDuration":{"type":"integer","default":10},"favicon":{"type":"string"},"defaultFavicon":{"type":"boolean","default":true},"loginMailFrequency":{"type":"integer","default":10},"transcribe":{"type":"boolean","default":false},"automaticTranscribe":{"type":"boolean","default":false},"transcribeAccountId":{"type":"integer"},"transcribeRegion":{"type":"string"},"sentiment":{"type":"boolean","default":false},"automaticSentiment":{"type":"boolean","default":false},"sentimentAccountId":{"type":"integer"},"sentimentRegion":{"type":"string"},"language":{"type":"string"},"bucket":{"type":"string"},"googleSsoEnabled":{"type":"boolean","default":false},"enforcePasswordHistory":{"type":"boolean","default":true},"passwordHistoryLimit":{"type":"integer","default":3}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Setting not found"}}}},"/settings/{id}/logo":{"get":{"summary":"Get logo","operationId":"getLogo","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add logo","security":[{"BearerAuth":[]}],"operationId":"postaddLogo","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings/{id}/logo_login":{"get":{"summary":"Get logo login","operationId":"getLogoLogin","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add logo login","security":[{"BearerAuth":[]}],"operationId":"postaddLogoLogin","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings/{id}/gdpr":{"get":{"summary":"Get gdpr settings","operationId":"gdpr","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/settings/{id}/preferred":{"get":{"summary":"Get Preferred","operationId":"getPreferred","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add Preferred","security":[{"BearerAuth":[]}],"operationId":"postaddPreferred","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings/{id}/favicon":{"get":{"summary":"Get Favicon","operationId":"getFavicon","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add Favicon","security":[{"BearerAuth":[]}],"operationId":"postaddFavicon","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllSmsAccount","tags":["Sms Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Account","security":[{"BearerAuth":[]}],"operationId":"createSmsAccount","tags":["Sms Accounts"],"requestBody":{"required":true,"description":"data for creating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","default":"XiWeIvQm9jR44uKXXbaTAMRW3cKSKIDM"},"phone":{"type":"string"},"type":{"type":"string","enum":["twilio","skebby","connectel","clicksend","plivo","clickatell","csc","infobip","intelepeer"]},"accountSid":{"type":"string"},"authId":{"type":"string"},"authToken":{"type":"string"},"smsMethod":{"type":"string","enum":["SI","TI","GP"]},"username":{"type":"string"},"password":{"type":"string"},"apiKey":{"type":"string"},"senderString":{"type":"string"},"deliveryReport":{"type":"boolean","default":false},"description":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"baseUrl":{"type":"string"},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}},"required":["name","key","remote"]}}}},"responses":{"201":{"description":"SmsAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeSmsAccount","tags":["Sms Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getSmsAccountById","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount to get"}],"responses":{"200":{"description":"SmsAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateSmsAccountById","tags":["Sms Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","default":"5sbjWGiIAFCaMsOZLSTaVBFZQrZ6BXaO"},"phone":{"type":"string"},"type":{"type":"string","enum":["twilio","skebby","connectel","clicksend","plivo","clickatell","csc","infobip","intelepeer"]},"accountSid":{"type":"string"},"authId":{"type":"string"},"authToken":{"type":"string"},"smsMethod":{"type":"string","enum":["SI","TI","GP"]},"username":{"type":"string"},"password":{"type":"string"},"apiKey":{"type":"string"},"senderString":{"type":"string"},"deliveryReport":{"type":"boolean","default":false},"description":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"baseUrl":{"type":"string"},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsAccount not found"}}}},"/sms/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/applications":{"get":{"summary":"Gets account applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/interactions":{"get":{"summary":"Gets Sms Account interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/status":{"get":{"summary":"Receive message status as get request","operationId":"statusGet","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Receive message status","operationId":"status","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"}}}},"/sms/accounts/{id}/users":{"get":{"summary":"Gets agents from sms account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a sms account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a sms account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/notify":{"post":{"summary":"Notify new message","operationId":"notify","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"}}}},"/sms/accounts/{id}/send":{"post":{"summary":"Send new sms message","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Account","security":[{"BearerAuth":[]}],"operationId":"deleteSmsAccountById","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsAccount not found"}}}},"/sms/applications":{"get":{"summary":"Gets a list of Applications","security":[{"BearerAuth":[]}],"operationId":"listAllSmsApplication","tags":["Sms Applications"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsApplication"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsApplication"}}}}},"206":{"description":"Partial (paged) collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsApplication"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Application","security":[{"BearerAuth":[]}],"operationId":"createSmsApplication","tags":["Sms Applications"],"requestBody":{"required":true,"description":"data for creating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}},"required":["priority","app"]}}}},"responses":{"201":{"description":"SmsApplication successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getSmsApplicationById","tags":["Sms Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsApplication to get"}],"responses":{"200":{"description":"SmsApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateSmsApplicationById","tags":["Sms Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsApplication not found"}}}},"/sms/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteSmsApplicationById","tags":["Sms Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsApplication not found"}}}},"/sms/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllSmsInteraction","tags":["Sms Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createSmsInteraction","tags":["Sms Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"phone":{"type":"string"},"read1stAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}},"required":["firstMsgDirection","lastMsgDirection"]}}}},"responses":{"201":{"description":"SmsInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeSmsInteraction","tags":["Sms Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getSmsInteractionById","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction to get"}],"responses":{"200":{"description":"SmsInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateSmsInteractionById","tags":["Sms Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"phone":{"type":"string"},"read1stAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsInteraction not found"}}}},"/sms/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteSmsInteractionById","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsInteraction not found"}}}},"/sms/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllSmsMessage","tags":["Sms Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createSmsMessage","tags":["Sms Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"phone":{"type":"string"},"readAt":{"type":"string"},"secret":{"type":"boolean","default":false},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"SmsMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeSmsMessage","tags":["Sms Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getSmsMessageById","tags":["Sms Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage to get"}],"responses":{"200":{"description":"SmsMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateSmsMessageById","tags":["Sms Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"phone":{"type":"string"},"readAt":{"type":"string"},"secret":{"type":"boolean","default":false},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsMessage not found"}}}},"/sms/messages/{id}/status":{"post":{"summary":"Receive message status","operationId":"status","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage"}],"responses":{"201":{"description":"successfully created"}}}},"/sms/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteSmsMessageById","tags":["Sms Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsMessage not found"}}}},"/sms/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllSmsQueue","tags":["Sms Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createSmsQueue","tags":["Sms Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"responses":{"201":{"description":"SmsQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeSmsQueue","tags":["Sms Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getSmsQueueById","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue to get"}],"responses":{"200":{"description":"SmsQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateSmsQueueById","tags":["Sms Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueue not found"}}}},"/sms/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteSmsQueueById","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueue not found"}}}},"/sms/reports/queue":{"get":{"summary":"Gets a list of Sms Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllSmsQueueReport","tags":["Sms Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sms Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Sms Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Sms Queue Report","security":[{"BearerAuth":[]}],"operationId":"createSmsQueueReport","tags":["Sms Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Sms Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"SmsQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/reports/queue/describe":{"get":{"summary":"Gets table info about Sms Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeSmsQueueReport","tags":["Sms Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/reports/queue/{id}":{"get":{"summary":"Gets a single Sms Queue Report","security":[{"BearerAuth":[]}],"operationId":"getSmsQueueReportById","tags":["Sms Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueueReport to get"}],"responses":{"200":{"description":"SmsQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueueReport not found"}}},"put":{"summary":"Update an existing Sms Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateSmsQueueReportById","tags":["Sms Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Sms Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueueReport not found"}}}},"/sms/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Sms Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteSmsQueueReportById","tags":["Sms Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueueReport not found"}}}},"/sms/reports/transfer":{"get":{"summary":"Gets a list of Sms Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllSmsTransferReport","tags":["Sms Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sms Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Sms Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Sms Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createSmsTransferReport","tags":["Sms Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Sms Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"SmsTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/reports/transfer/describe":{"get":{"summary":"Gets table info about Sms Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeSmsTransferReport","tags":["Sms Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/reports/transfer/{id}":{"get":{"summary":"Gets a single Sms Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getSmsTransferReportById","tags":["Sms Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsTransferReport to get"}],"responses":{"200":{"description":"SmsTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsTransferReport not found"}}},"put":{"summary":"Update an existing Sms Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateSmsTransferReportById","tags":["Sms Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Sms Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsTransferReport not found"}}}},"/sms/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Sms Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteSmsTransferReportById","tags":["Sms Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsTransferReport not found"}}}},"/sounds":{"get":{"summary":"Gets a list of Sounds","security":[{"BearerAuth":[]}],"operationId":"listAllSound","tags":["Sounds"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Sound"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sounds","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Sound"}}}}},"206":{"description":"Partial (paged) collection of Sounds","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Sound"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sounds/{id}":{"get":{"summary":"Gets a single Sound","security":[{"BearerAuth":[]}],"operationId":"getSoundById","tags":["Sounds"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Sound to get"}],"responses":{"200":{"description":"Sound with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sound"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Sound not found"}}},"put":{"summary":"Update an existing new sound","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Sounds"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Sound"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Deletes a sound","security":[{"BearerAuth":[]}],"operationId":"delete","tags":["Sounds"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Sound"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sounds/{id}/download":{"get":{"summary":"Download Sound","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Sounds"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Sound"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sounds/":{"post":{"summary":"Create a new sound","security":[{"BearerAuth":[]}],"operationId":"postcreate","tags":["Sounds"],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllSquareMessage","tags":["Square Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createSquareMessage","tags":["Square Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"body":{"type":"string"},"direction":{"type":"string","enum":["in","out"],"default":"out"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"SquareMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getSquareMessageById","tags":["Square Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareMessage to get"}],"responses":{"200":{"description":"SquareMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateSquareMessageById","tags":["Square Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"body":{"type":"string"},"direction":{"type":"string","enum":["in","out"],"default":"out"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareMessage not found"}}}},"/square/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteSquareMessageById","tags":["Square Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareMessage not found"}}}},"/square/odbc":{"get":{"summary":"Gets a list of ODBCs","security":[{"BearerAuth":[]}],"operationId":"listAllSquareOdbc","tags":["Square ODBC"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareOdbc"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of ODBCs","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareOdbc"}}}}},"206":{"description":"Partial (paged) collection of ODBCs","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareOdbc"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new ODBC","security":[{"BearerAuth":[]}],"operationId":"createSquareOdbc","tags":["Square ODBC"],"requestBody":{"required":true,"description":"data for creating a new ODBC","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"dsn":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"SquareOdbc successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareOdbc"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/odbc/{id}":{"get":{"summary":"Gets a single ODBC","security":[{"BearerAuth":[]}],"operationId":"getSquareOdbcById","tags":["Square ODBC"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareOdbc to get"}],"responses":{"200":{"description":"SquareOdbc with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareOdbc"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareOdbc not found"}}},"put":{"summary":"Update an existing ODBC","security":[{"BearerAuth":[]}],"operationId":"updateSquareOdbcById","tags":["Square ODBC"],"requestBody":{"required":true,"description":"data for updating a new ODBC","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"dsn":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareOdbc to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareOdbc not found"}}}},"/square/odbc/{id}/test":{"get":{"summary":"Test Odbc","security":[{"BearerAuth":[]}],"operationId":"test","tags":["Square ODBC"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareOdbc"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/odbc/{id}/destroy_many":{"delete":{"summary":"Destroy an existing ODBC","security":[{"BearerAuth":[]}],"operationId":"deleteSquareOdbcById","tags":["Square ODBC"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareOdbc to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareOdbc not found"}}}},"/square/projects":{"get":{"summary":"Gets a list of Projects","security":[{"BearerAuth":[]}],"operationId":"listAllSquareProject","tags":["Square Projects"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareProject"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Projects","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareProject"}}}}},"206":{"description":"Partial (paged) collection of Projects","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareProject"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Project","security":[{"BearerAuth":[]}],"operationId":"createSquareProject","tags":["Square Projects"],"requestBody":{"required":true,"description":"data for creating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"notes":{"type":"string"},"preproduction":{"type":"object"},"production":{"type":"object"}},"required":["name"]}}}},"responses":{"201":{"description":"SquareProject successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/projects/{id}":{"get":{"summary":"Gets a single Project","security":[{"BearerAuth":[]}],"operationId":"getSquareProjectById","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject to get"}],"responses":{"200":{"description":"SquareProject with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareProject not found"}}},"put":{"summary":"Update an existing Project","security":[{"BearerAuth":[]}],"operationId":"updateSquareProjectById","tags":["Square Projects"],"requestBody":{"required":true,"description":"data for updating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"notes":{"type":"string"},"preproduction":{"type":"object"},"production":{"type":"object"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareProject not found"}}}},"/square/projects/{id}/users":{"get":{"summary":"Gets users permissions from Project","security":[{"BearerAuth":[]}],"operationId":"getUsers","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Adds user permissions to a Project","security":[{"BearerAuth":[]}],"operationId":"addUsers","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes user permissions from a Project","security":[{"BearerAuth":[]}],"operationId":"removeUsers","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/projects/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Project","security":[{"BearerAuth":[]}],"operationId":"deleteSquareProjectById","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareProject not found"}}}},"/square/recordings":{"get":{"summary":"Gets a list of Recordings","security":[{"BearerAuth":[]}],"operationId":"listAllSquareRecording","tags":["Square Recordings"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareRecording"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareRecording"}}}}},"206":{"description":"Partial (paged) collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareRecording"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Recording","security":[{"BearerAuth":[]}],"operationId":"createSquareRecording","tags":["Square Recordings"],"requestBody":{"required":true,"description":"data for creating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"callerid":{"type":"string"},"calleridname":{"type":"string"},"context":{"type":"string"},"extension":{"type":"string"},"priority":{"type":"string"},"accountcode":{"type":"string"},"dnid":{"type":"string"},"projectName":{"type":"string"},"saveName":{"type":"string"},"filename":{"type":"string"},"savePath":{"type":"string"},"format":{"type":"string"}}}}}},"responses":{"201":{"description":"SquareRecording successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/recordings/{id}":{"get":{"summary":"Gets a single Recording","security":[{"BearerAuth":[]}],"operationId":"getSquareRecordingById","tags":["Square Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareRecording to get"}],"responses":{"200":{"description":"SquareRecording with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareRecording not found"}}},"put":{"summary":"Update an existing Recording","security":[{"BearerAuth":[]}],"operationId":"updateSquareRecordingById","tags":["Square Recordings"],"requestBody":{"required":true,"description":"data for updating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"callerid":{"type":"string"},"calleridname":{"type":"string"},"context":{"type":"string"},"extension":{"type":"string"},"priority":{"type":"string"},"accountcode":{"type":"string"},"dnid":{"type":"string"},"projectName":{"type":"string"},"saveName":{"type":"string"},"filename":{"type":"string"},"savePath":{"type":"string"},"format":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareRecording to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareRecording not found"}}}},"/square/recordings/{id}/download":{"get":{"summary":"Download Recording","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Square Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/recordings/{id}/delete":{"delete":{"summary":"Delete recording","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Square Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareRecording"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/reports":{"get":{"summary":"Gets a list of Square Reports","security":[{"BearerAuth":[]}],"operationId":"listAllSquareReport","tags":["Square Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Square Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareReport"}}}}},"206":{"description":"Partial (paged) collection of Square Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Square Report","security":[{"BearerAuth":[]}],"operationId":"createSquareReport","tags":["Square Reports"],"requestBody":{"required":true,"description":"data for creating a new Square Report","content":{"application/json":{"schema":{"type":"object","properties":{"network":{"type":"string"},"network_script":{"type":"string"},"request":{"type":"string"},"channel":{"type":"string"},"language":{"type":"string"},"type":{"type":"string"},"uniqueid":{"type":"string"},"version":{"type":"string"},"callerid":{"type":"string"},"calleridname":{"type":"string"},"callingpres":{"type":"string"},"callingani2":{"type":"string"},"callington":{"type":"string"},"callingtns":{"type":"string"},"dnid":{"type":"string"},"rdnis":{"type":"string"},"context":{"type":"string"},"extension":{"type":"string"},"priority":{"type":"string"},"enhanced":{"type":"string"},"accountcode":{"type":"string"},"threadid":{"type":"string"},"project_name":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"bot":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"SquareReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/reports/describe":{"get":{"summary":"Gets table info about Square Reports","security":[{"BearerAuth":[]}],"operationId":"describeSquareReport","tags":["Square Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/reports/{id}":{"get":{"summary":"Gets a single Square Report","security":[{"BearerAuth":[]}],"operationId":"getSquareReportById","tags":["Square Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareReport to get"}],"responses":{"200":{"description":"SquareReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareReport not found"}}},"put":{"summary":"Update an existing Square Report","security":[{"BearerAuth":[]}],"operationId":"updateSquareReportById","tags":["Square Reports"],"requestBody":{"required":true,"description":"data for updating a new Square Report","content":{"application/json":{"schema":{"type":"object","properties":{"network":{"type":"string"},"network_script":{"type":"string"},"request":{"type":"string"},"channel":{"type":"string"},"language":{"type":"string"},"type":{"type":"string"},"uniqueid":{"type":"string"},"version":{"type":"string"},"callerid":{"type":"string"},"calleridname":{"type":"string"},"callingpres":{"type":"string"},"callingani2":{"type":"string"},"callington":{"type":"string"},"callingtns":{"type":"string"},"dnid":{"type":"string"},"rdnis":{"type":"string"},"context":{"type":"string"},"extension":{"type":"string"},"priority":{"type":"string"},"enhanced":{"type":"string"},"accountcode":{"type":"string"},"threadid":{"type":"string"},"project_name":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"bot":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareReport not found"}}}},"/square/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Square Report","security":[{"BearerAuth":[]}],"operationId":"deleteSquareReportById","tags":["Square Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareReport not found"}}}},"/square/details/reports":{"get":{"summary":"Gets a list of Square Detail Reports","security":[{"BearerAuth":[]}],"operationId":"listAllSquareDetailsReport","tags":["Square Details Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareDetailsReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Square Detail Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareDetailsReport"}}}}},"206":{"description":"Partial (paged) collection of Square Detail Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareDetailsReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Square Detail Report","security":[{"BearerAuth":[]}],"operationId":"createSquareDetailsReport","tags":["Square Details Reports"],"requestBody":{"required":true,"description":"data for creating a new Square Detail Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"node":{"type":"string"},"application":{"type":"string"},"data":{"type":"string"},"project_name":{"type":"string"},"callerid":{"type":"string"}}}}}},"responses":{"201":{"description":"SquareDetailsReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareDetailsReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/details/reports/describe":{"get":{"summary":"Gets table info about Square Detail Reports","security":[{"BearerAuth":[]}],"operationId":"describeSquareDetailsReport","tags":["Square Details Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/details/reports/{id}":{"get":{"summary":"Gets a single Square Detail Report","security":[{"BearerAuth":[]}],"operationId":"getSquareDetailsReportById","tags":["Square Details Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareDetailsReport to get"}],"responses":{"200":{"description":"SquareDetailsReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareDetailsReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareDetailsReport not found"}}},"put":{"summary":"Update an existing Square Detail Report","security":[{"BearerAuth":[]}],"operationId":"updateSquareDetailsReportById","tags":["Square Details Reports"],"requestBody":{"required":true,"description":"data for updating a new Square Detail Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"node":{"type":"string"},"application":{"type":"string"},"data":{"type":"string"},"project_name":{"type":"string"},"callerid":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareDetailsReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareDetailsReport not found"}}}},"/square/details/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Square Detail Report","security":[{"BearerAuth":[]}],"operationId":"deleteSquareDetailsReportById","tags":["Square Details Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareDetailsReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareDetailsReport not found"}}}},"/system":{"get":{"summary":"Gets system information","security":[{"BearerAuth":[]}],"operationId":"getSystemInformation","tags":["System Information"],"responses":{"200":{"description":"system information","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/system/process":{"get":{"summary":"Gets process information","security":[{"BearerAuth":[]}],"operationId":"getSystemProcessInformation","tags":["System Information"],"responses":{"200":{"description":"process information","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/tags":{"get":{"summary":"Gets a list of Tags","security":[{"BearerAuth":[]}],"operationId":"listAllTag","tags":["Tags"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Tag"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Tags","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}},"206":{"description":"Partial (paged) collection of Tags","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Tag","security":[{"BearerAuth":[]}],"operationId":"createTag","tags":["Tags"],"requestBody":{"required":true,"description":"data for creating a new Tag","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string","default":"#0091EA"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Tag successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/tags/{id}":{"get":{"summary":"Gets a single Tag","security":[{"BearerAuth":[]}],"operationId":"getTagById","tags":["Tags"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Tag to get"}],"responses":{"200":{"description":"Tag with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Tag not found"}}},"put":{"summary":"Update an existing Tag","security":[{"BearerAuth":[]}],"operationId":"updateTagById","tags":["Tags"],"requestBody":{"required":true,"description":"data for updating a new Tag","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string","default":"#0091EA"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Tag to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Tag not found"}}}},"/tags/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Tag","security":[{"BearerAuth":[]}],"operationId":"deleteTagById","tags":["Tags"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Tag to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Tag not found"}}}},"/teams":{"get":{"summary":"Gets a list of Teams","security":[{"BearerAuth":[]}],"operationId":"listAllTeam","tags":["Teams"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Team"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Teams","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"206":{"description":"Partial (paged) collection of Teams","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Team","security":[{"BearerAuth":[]}],"operationId":"createTeam","tags":["Teams"],"requestBody":{"required":true,"description":"data for creating a new Team","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Team successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/teams/{id}":{"get":{"summary":"Gets a single Team","security":[{"BearerAuth":[]}],"operationId":"getTeamById","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team to get"}],"responses":{"200":{"description":"Team with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Team not found"}}},"put":{"summary":"Update an existing Team","security":[{"BearerAuth":[]}],"operationId":"updateTeamById","tags":["Teams"],"requestBody":{"required":true,"description":"data for updating a new Team","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Team not found"}}}},"/teams/{id}/queues":{"get":{"summary":"Gets Queues list","security":[{"BearerAuth":[]}],"operationId":"getQueues","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add queues to a team","security":[{"BearerAuth":[]}],"operationId":"addQueues","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove queues to a team","security":[{"BearerAuth":[]}],"operationId":"removeQueues","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/teams/{id}/users":{"get":{"summary":"Gets agents from team","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Adds agents to a team","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a team","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/teams/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Team","security":[{"BearerAuth":[]}],"operationId":"deleteTeamById","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Team not found"}}}},"/templates":{"get":{"summary":"Gets a list of Templates","security":[{"BearerAuth":[]}],"operationId":"listAllTemplate","tags":["Templates"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Template"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Templates","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}}},"206":{"description":"Partial (paged) collection of Templates","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Template","security":[{"BearerAuth":[]}],"operationId":"createTemplate","tags":["Templates"],"requestBody":{"required":true,"description":"data for creating a new Template","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"html":{"type":"string"}}}}}},"responses":{"201":{"description":"Template successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/templates/{id}":{"get":{"summary":"Gets a single Template","security":[{"BearerAuth":[]}],"operationId":"getTemplateById","tags":["Templates"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Template to get"}],"responses":{"200":{"description":"Template with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Template not found"}}},"put":{"summary":"Update an existing Template","security":[{"BearerAuth":[]}],"operationId":"updateTemplateById","tags":["Templates"],"requestBody":{"required":true,"description":"data for updating a new Template","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"html":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Template to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Template not found"}}}},"/templates/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Template","security":[{"BearerAuth":[]}],"operationId":"deleteTemplateById","tags":["Templates"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Template to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Template not found"}}}},"/triggers":{"get":{"summary":"Gets a list of Triggers","security":[{"BearerAuth":[]}],"operationId":"listAllTrigger","tags":["Triggers"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Trigger"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Triggers","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}}}}},"206":{"description":"Partial (paged) collection of Triggers","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Trigger","security":[{"BearerAuth":[]}],"operationId":"createTrigger","tags":["Triggers"],"requestBody":{"required":true,"description":"data for creating a new Trigger","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"string"},"description":{"type":"string"},"status":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"Trigger successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/triggers/{id}":{"get":{"summary":"Gets a single Trigger","security":[{"BearerAuth":[]}],"operationId":"getTriggerById","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger to get"}],"responses":{"200":{"description":"Trigger with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Trigger not found"}}},"put":{"summary":"Update an existing Trigger","security":[{"BearerAuth":[]}],"operationId":"updateTriggerById","tags":["Triggers"],"requestBody":{"required":true,"description":"data for updating a new Trigger","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"string"},"description":{"type":"string"},"status":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Trigger not found"}}}},"/triggers/{id}/all_conditions":{"get":{"summary":"Gets \"AND\" Trigger Conditions","security":[{"BearerAuth":[]}],"operationId":"getAllConditions","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new \"AND\"condition","security":[{"BearerAuth":[]}],"operationId":"addAllCondition","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/triggers/{id}/any_conditions":{"get":{"summary":"Gets \"OR\" Trigger Conditions","security":[{"BearerAuth":[]}],"operationId":"getAnyConditions","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new \"OR\"condition","security":[{"BearerAuth":[]}],"operationId":"addAnyCondition","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/triggers/{id}/actions":{"get":{"summary":"Gets Trigger Actions","security":[{"BearerAuth":[]}],"operationId":"getActions","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new actions","security":[{"BearerAuth":[]}],"operationId":"addAction","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/triggers/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Trigger","security":[{"BearerAuth":[]}],"operationId":"deleteTriggerById","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Trigger not found"}}}},"/trunks":{"get":{"summary":"Gets a list of Trunks","security":[{"BearerAuth":[]}],"operationId":"listAllTrunk","tags":["Trunks"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Trunk"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Trunks","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trunk"}}}}},"206":{"description":"Partial (paged) collection of Trunks","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trunk"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/trunks/{id}":{"get":{"summary":"Gets a single Trunk","security":[{"BearerAuth":[]}],"operationId":"getTrunkById","tags":["Trunks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trunk to get"}],"responses":{"200":{"description":"Trunk with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trunk"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Trunk not found"}}},"put":{"summary":"Update an existing trunk","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Trunks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trunk"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Deletes a trunk","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Trunks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trunk"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/trunks/clone":{"post":{"summary":"Clone an existing Trunk","security":[{"BearerAuth":[]}],"operationId":"cloneTrunk","tags":["Trunks"],"requestBody":{"required":true,"description":"data for creating a new Trunk","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Trunk to clone"},"name":{"type":"string"},"type":{"type":"string","enum":["friend","user","peer"],"default":"friend"},"context":{"type":"string","default":"from-voip-provider"},"callingpres":{"type":"string","enum":["ALLOWED_NOT_SCREENED","ALLOWED_PASSED_SCREEN","ALLOWED_FAILED_SCREEN","ALLOWED","PROHIB_NOT_SCREENED","PROHIB_PASSED_SCREEN","PROHIB_FAILED_SCREEN","PROHIB"]},"deny":{"type":"string"},"permit":{"type":"string"},"secret":{"type":"string"},"md5secret":{"type":"string"},"remotesecret":{"type":"string"},"transport":{"type":"string","description":"String is deprecated. Please use an Array as [\"udp\", \"tcp\"]","default":"udp"},"dtmfmode":{"type":"string","enum":["rfc2833","info","shortinfo","inband","auto"],"default":"rfc2833"},"directmedia":{"type":"string","enum":["yes","no","nonat","update","outgoing"],"default":"no"},"directrtpsetup":{"type":"string","enum":["yes","no"],"default":"no"},"directmediapermit":{"type":"string"},"directmediadeny":{"type":"string"},"nat":{"type":"string","description":"String is deprecated. Please use an Array as [\"force_rport\", \"comedia\"]","default":"force_rport,comedia"},"callgroup":{"type":"string"},"namedcallgroup":{"type":"string"},"pickupgroup":{"type":"string"},"namedpickupgroup":{"type":"string"},"language":{"type":"string","default":"en"},"tonezone":{"type":"string"},"disallow":{"type":"string","default":"all"},"allow":{"type":"string","description":"String is deprecated. Please use an Array as [\"ulaw\", \"alaw\", \"alaw\"]","default":"ulaw;alaw;gsm"},"autoframing":{"type":"string","enum":["yes","no"]},"insecure":{"type":"string","description":"String is deprecated. Please use an Array as [\"port\", \"invite\"]","default":"port,invite"},"trustrpid":{"type":"string","enum":["yes","no"],"default":"no"},"trust_id_outbound":{"type":"string","enum":["yes","no"],"default":"no"},"progressinband":{"type":"string","enum":["yes","no","never"]},"promiscredir":{"type":"string","enum":["yes","no"]},"useclientcode":{"type":"string","enum":["yes","no"]},"accountcode":{"type":"integer"},"setvar":{"type":"string"},"callerid":{"type":"string","default":"\"\" <>"},"amaflags":{"type":"string"},"callcounter":{"type":"string","enum":["yes","no"],"default":"yes"},"busylevel":{"type":"integer"},"allowoverlap":{"type":"string","enum":["yes","no"]},"allowsubscribe":{"type":"string","enum":["yes","no"]},"allowtransfer":{"type":"string","enum":["yes","no"]},"ignoresdpversion":{"type":"string","enum":["yes","no"]},"subscribecontext":{"type":"string"},"template":{"type":"string"},"videosupport":{"type":"string","enum":["yes","no","always"],"default":"no"},"maxcallbitrate":{"type":"integer"},"rfc2833compensate":{"type":"string","enum":["yes","no"]},"mailbox":{"type":"string"},"session_timers":{"type":"string","enum":["accept","refuse","originate"]},"session_expires":{"type":"integer"},"session_minse":{"type":"integer"},"session_refresher":{"type":"string","enum":["uac","uas"],"default":"uas"},"t38pt_usertpsource":{"type":"string"},"regexten":{"type":"string"},"fromdomain":{"type":"string"},"fromuser":{"type":"string"},"port":{"type":"integer"},"qualify":{"type":"string","enum":["yes","no"],"default":"yes"},"keepalive":{"type":"integer"},"defaultip":{"type":"string"},"defaultuser":{"type":"string"},"rtptimeout":{"type":"integer"},"rtpholdtimeout":{"type":"integer"},"rtpkeepalive":{"type":"integer"},"sendrpid":{"type":"string","enum":["yes","no","pai"],"default":"no"},"outboundproxy":{"type":"string"},"callbackextension":{"type":"string"},"timert1":{"type":"integer"},"timerb":{"type":"integer"},"qualifyfreq":{"type":"integer"},"contactpermit":{"type":"string"},"contactdeny":{"type":"string"},"contactacl":{"type":"string"},"unsolicited_mailbox":{"type":"string"},"use_q850_reason":{"type":"string"},"maxforwards":{"type":"integer"},"encryption":{"type":"string","enum":["yes","no"],"default":"no"},"avpf":{"type":"string","enum":["yes","no"]},"force_avp":{"type":"string","enum":["yes","no"]},"icesupport":{"type":"string","enum":["yes","no"]},"dtlsenable":{"type":"string","enum":["yes","no"]},"dtlsverify":{"type":"string","enum":["yes","no","fingerprint","certificate"]},"dtlsrekey":{"type":"integer"},"dtlscertfile":{"type":"string"},"dtlsprivatekey":{"type":"string"},"dtlscipher":{"type":"string"},"dtlscafile":{"type":"string"},"dtlscapath":{"type":"string"},"dtlssetup":{"type":"string","enum":["active","passive","actpass"]},"dtlsfingerprint":{"type":"string"},"usereqphone":{"type":"string","enum":["yes","no"],"default":"no"},"recordonfeature":{"type":"string"},"recordofffeature":{"type":"string"},"call_limit":{"type":"integer","default":1000},"registertrying":{"type":"string","enum":["yes","no"]},"subscribemwi":{"type":"string","enum":["yes","no"]},"vmexten":{"type":"string"},"mohinterpret":{"type":"string"},"mohsuggest":{"type":"string"},"parkinglot":{"type":"string"},"description":{"type":"string"},"host":{"type":"string","default":"dynamic"},"canreinvite":{"type":"string","enum":["yes","no","nonat","update","update,nonat"],"default":"no"},"registry":{"type":"string"},"otherFields":{"type":"string"},"active":{"type":"boolean","default":true},"t38pt_udptl":{"type":"string","default":"no"}},"required":["id"]}}}},"responses":{"201":{"description":"Trunk successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trunk"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/trunks/":{"post":{"summary":"Create a new trunk","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Trunks"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users":{"get":{"summary":"Gets a list of Users","security":[{"BearerAuth":[]}],"operationId":"listUsers","tags":["Users"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each User"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Users","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"206":{"description":"Partial (paged) collection of Users","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Create a new User","security":[{"BearerAuth":[]}],"operationId":"postCreateUser","tags":["Users"],"requestBody":{"required":true,"description":"user to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"201":{"description":"user created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/describe":{"get":{"summary":"Gets table info about Users","security":[{"BearerAuth":[]}],"operationId":"describeUsers","tags":["Users"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/whoami":{"get":{"summary":"Gets current user","security":[{"BearerAuth":[]}],"operationId":"getWhoAmI","tags":["Users"],"responses":{"200":{"description":"current user information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}":{"get":{"summary":"Gets a user by id","security":[{"BearerAuth":[]}],"operationId":"getUserById","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user to get"}],"responses":{"200":{"description":"user information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"put":{"summary":"Update an existing User","security":[{"BearerAuth":[]}],"operationId":"putUpdateUser","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"user properties to be updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"description":"user updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove a user","security":[{"BearerAuth":[]}],"operationId":"deleteUser","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"204":{"description":"user deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"user not found"}}}},"/users/{id}/avatar":{"get":{"summary":"Gets a user avatar by id","security":[{"BearerAuth":[]}],"operationId":"getUserAvatarById","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user avatar","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add avatar","security":[{"BearerAuth":[]}],"operationId":"postAddAvatar","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"Add avatar","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"avatar added"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/contacts":{"get":{"summary":"Gets a user contacts by id","security":[{"BearerAuth":[]}],"operationId":"getUserContactsById","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user contacts list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user contacts list","type":"array","items":{"$ref":"#/components/schemas/CmContact"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add contacts to a user","security":[{"BearerAuth":[]}],"operationId":"postAddUserContact","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"user contacts to be added","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"contacts added"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/queues":{"get":{"summary":"Gets a user queues list by user id","security":[{"BearerAuth":[]}],"operationId":"getUserQueues","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"channel","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string","enum":["voice","mail","chat","fax","sms","whatsapp","openchannel"]},"description":"channel to filter for (e.g. mail, voice...)","examples":{"fields":{"value":"mail","summary":"A call returning only queues for channel = mail"}}}],"responses":{"200":{"description":"user queues list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user queues list","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/VoiceQueue"},{"$ref":"#/components/schemas/MailQueue"},{"$ref":"#/components/schemas/ChatQueue"},{"$ref":"#/components/schemas/FaxQueue"},{"$ref":"#/components/schemas/SmsQueue"},{"$ref":"#/components/schemas/OpenchannelQueue"},{"$ref":"#/components/schemas/WhatsappQueue"}]}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add queues to an agent","security":[{"BearerAuth":[]}],"operationId":"postAddQueuesToAgent","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"Add queues to an agent","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"queues added"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove one or more queues from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserQueues","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the voice queues to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove voice queues with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"queues deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/queues_rt":{"get":{"summary":"Gets a user UserVoiceQueuesRt list by user id","security":[{"BearerAuth":[]}],"operationId":"getUserVoiceQueuesRt","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user UserVoiceQueuesRt list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user UserVoiceQueueRt list","type":"array","items":{"$ref":"#/components/schemas/UserVoiceQueueRt"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/groups":{"get":{"summary":"Gets a user ChatGroups list by user id","security":[{"BearerAuth":[]}],"operationId":"getChatGroups","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user ChatGroups list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user ChatGroups list","type":"array","items":{"$ref":"#/components/schemas/ChatGroup"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/recordings":{"get":{"summary":"Gets a user VoiceRecording list by user id","security":[{"BearerAuth":[]}],"operationId":"getVoiceRecordings","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user VoiceRecording list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user VoiceRecording list","type":"array","items":{"$ref":"#/components/schemas/VoiceRecording"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/screen_recordings":{"get":{"summary":"Gets a user ScreenRecording list by user id","security":[{"BearerAuth":[]}],"operationId":"getScreenRecordings","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user ScreenRecording list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user ScreenRecording list","type":"array","items":{"$ref":"#/components/schemas/ScreenRecording"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/chat/interactions":{"get":{"summary":"Gets a user ChatInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getChatInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user ChatInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user ChatInteraction list","type":"array","items":{"$ref":"#/components/schemas/ChatInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/openchannel/interactions":{"get":{"summary":"Gets a user OpenchannelInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user OpenchannelInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user OpenchannelInteraction list","type":"array","items":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/mail/interactions":{"get":{"summary":"Gets a user MailInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getMailInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user MailInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user MailInteraction list","type":"array","items":{"$ref":"#/components/schemas/MailInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/sms/interactions":{"get":{"summary":"Gets a user SmsInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getSmsInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user SmsInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user SmsInteraction list","type":"array","items":{"$ref":"#/components/schemas/SmsInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/fax/interactions":{"get":{"summary":"Gets a user FaxInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getFaxInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user FaxInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user FaxInteraction list","type":"array","items":{"$ref":"#/components/schemas/FaxInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/whatsapp/interactions":{"get":{"summary":"Gets a user WhatsappInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getWhatsappInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user WhatsappInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user WhatsappInteraction list","type":"array","items":{"$ref":"#/components/schemas/WhatsappInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/teams":{"get":{"summary":"Gets a user Teams list by user id","security":[{"BearerAuth":[]}],"operationId":"getTeamss","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user Teams list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user Teams list","type":"array","items":{"$ref":"#/components/schemas/Team"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to an agent","security":[{"BearerAuth":[]}],"operationId":"postPause","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"teams to be added","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"responses":{"201":{"description":"teams added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove one or more teams from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserTeams","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the teams to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove teams with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"teams deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/lists":{"get":{"summary":"Gets a user CmList list by user id","security":[{"BearerAuth":[]}],"operationId":"getCmLists","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user CmList list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user CmList list","type":"array","items":{"$ref":"#/components/schemas/CmList"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/agents":{"get":{"summary":"Gets a user Agents list by user id","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user Agents list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user Agents list","type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/prefixes":{"get":{"summary":"Gets a user VoicePrefix list by user id","security":[{"BearerAuth":[]}],"operationId":"getVoicePrefixes","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user VoicePrefix list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user VoicePrefix list","type":"array","items":{"$ref":"#/components/schemas/VoicePrefix"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/fax_accounts":{"get":{"summary":"Gets a user FaxAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getFaxAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user FaxAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user FaxAccount list","type":"array","items":{"$ref":"#/components/schemas/FaxAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a Fax Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserFaxAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"fax accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"fax accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"fax accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove fax accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserFaxAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the fax accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove fax accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"fax accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/mail_accounts":{"get":{"summary":"Gets a user MailAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getMailAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user MailAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user MailAccount list","type":"array","items":{"$ref":"#/components/schemas/MailAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a mail Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserMailAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"mail accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"mail accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"mail accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove mail accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserMailAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the mail accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove mail accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"mail accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/openchannel_accounts":{"get":{"summary":"Gets a user OpenchannelAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user OpenchannelAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user OpenchannelAccount list","type":"array","items":{"$ref":"#/components/schemas/OpenchannelAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a openchannel Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserOpenchannelAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"openchannel accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"openchannel accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"openchannel accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove openchannel accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserOpenchannelAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the openchannel accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove openchannel accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"openchannel accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/sms_accounts":{"get":{"summary":"Gets a user SmsAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getSmsAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user SmsAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user SmsAccount list","type":"array","items":{"$ref":"#/components/schemas/SmsAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a sms Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserSmsAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"sms accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"sms accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"sms accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove sms accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserSmsAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the sms accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove sms accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"sms accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/chat_websites":{"get":{"summary":"Gets a user ChatWebsite list by user id","security":[{"BearerAuth":[]}],"operationId":"getChatWebsites","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user ChatWebsite list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user ChatWebsite list","type":"array","items":{"$ref":"#/components/schemas/ChatWebsite"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a Chat Website to a user","security":[{"BearerAuth":[]}],"operationId":"postUserChatWebsites","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"chat websites to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"chat websites identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"chat websites added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove chat websites from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserChatWebsites","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the chat websites to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove chat websites with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"chat websites deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/whatsapp_accounts":{"get":{"summary":"Gets a user WhatsappAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getWhatsappAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user WhatsappAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user WhatsappAccount list","type":"array","items":{"$ref":"#/components/schemas/WhatsappAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a whatsapp Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserWhatsappAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"whatsapp accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"whatsapp accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"whatsapp accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove whatsapp accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserWhatsappAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the whatsapp accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove whatsapp accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"whatsapp accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/square_projects":{"get":{"summary":"Gets a user SquareProject list by user id","security":[{"BearerAuth":[]}],"operationId":"getSquareProjects","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user SquareProject list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user SquareProject list","type":"array","items":{"$ref":"#/components/schemas/SquareProject"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a Square Project to a user","security":[{"BearerAuth":[]}],"operationId":"postUserSquareProject","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"square project to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"square project identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"square project added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove one or more Square Project from a user","security":[{"BearerAuth":[]}],"operationId":"deleteSquareProjects","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the square project to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove square project with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"square project deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/scheduled_calls":{"get":{"summary":"Gets a user scheduled calls list by user id","security":[{"BearerAuth":[]}],"operationId":"getScheduledCalls","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user scheduled calls list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user scheduled calls list","type":"array","items":{"type":"object"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/api_key":{"get":{"summary":"Gets a user api key by user id","security":[{"BearerAuth":[]}],"operationId":"getApiKey","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user api keys list result","content":{"application/json":{"schema":{"type":"object","properties":{"api_key":{"type":"string","description":"api key token"}}}}}},"204":{"description":"No API access key found!","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"error message","default":"No API access key found!"}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Create a new API access key for the user","security":[{"BearerAuth":[]}],"operationId":"postCreateApiKey","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"tags":["Users"],"responses":{"201":{"description":"the api key that has been created","content":{"application/json":{"schema":{"type":"object","properties":{"api_key":{"type":"string","description":"api key token"}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove API access key for the user","security":[{"BearerAuth":[]}],"operationId":"deleteUserApiKey","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"204":{"description":"user apikey deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"user not found"}}}},"/users/create_many":{"post":{"summary":"Create several Users","security":[{"BearerAuth":[]}],"operationId":"postCreateUsers","tags":["Users"],"requestBody":{"required":true,"description":"users to be created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"responses":{"201":{"description":"users created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/login":{"post":{"summary":"perform SIP Login","security":[{"BearerAuth":[]}],"operationId":"postSipLogin","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"Login","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"SIP Login success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/logout":{"post":{"summary":"perform SIP logout","security":[{"BearerAuth":[]}],"operationId":"postSipLogout","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"201":{"description":"SIP logout success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/pause":{"post":{"summary":"set pause status","security":[{"BearerAuth":[]}],"operationId":"postPause","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"pause payload","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"status updated successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/unpause":{"post":{"summary":"unset pause status","security":[{"BearerAuth":[]}],"operationId":"postUnpause","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"unpause payload","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"status updated successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/chat_interactions":{"post":{"summary":"Add chat interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserChatInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"chat interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"chat interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"chat interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove chat interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserChatInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the chat interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove chat interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"chat interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/mail_interactions":{"post":{"summary":"Add mail interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserMailInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"mail interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"mail interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"mail interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove mail interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserMailInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the mail interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove mail interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"mail interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/fax_interactions":{"post":{"summary":"Add fax interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserFaxInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"fax interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"fax interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"fax interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove fax interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserFaxInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the fax interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove fax interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"fax interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/sms_interactions":{"post":{"summary":"Add sms interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserSmsInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"sms interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"sms interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"sms interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove sms_interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserSmsInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the sms interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove sms interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"sms interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/openchannel_interactions":{"post":{"summary":"Add openchannel interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserOpenchannelInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"openchannel interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"openchannel interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"openchannel interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove openchannel interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserOpenchannelInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the openchannel interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove openchannel interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"openchannel interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/whatsapp_interactions":{"post":{"summary":"Add whatsapp interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserWhatsappInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"whatsapp interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"whatsapp interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"whatsapp interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove whatsapp_interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserWhatsappInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the whatsapp interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove whatsapp interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"whatsapp interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/password":{"put":{"summary":"Update an existing User","security":[{"BearerAuth":[]}],"operationId":"putUpdateUser","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"old password and new password","content":{"application/json":{"schema":{"type":"object","properties":{"oldPassword":{"type":"string","format":"password","description":"old password"},"newPassword":{"type":"string","format":"password","description":"new password"}},"required":["oldPassword","newPassword"]}}}},"responses":{"200":{"description":"user password updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles":{"get":{"summary":"Gets a list of User Profiles","security":[{"BearerAuth":[]}],"operationId":"listAllUserProfile","tags":["User Profiles"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each UserProfile"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of User Profiles","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfile"}}}}},"206":{"description":"Partial (paged) collection of User Profiles","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfile"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new User Profile","security":[{"BearerAuth":[]}],"operationId":"createUserProfile","tags":["User Profiles"],"requestBody":{"required":true,"description":"data for creating a new User Profile","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"crudPermissions":{"type":"string","default":"r"},"description":{"type":"string"}},"required":["name","crudPermissions"]}}}},"responses":{"201":{"description":"UserProfile successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/describe":{"get":{"summary":"Gets table info about User Profiles","security":[{"BearerAuth":[]}],"operationId":"describeUserProfile","tags":["User Profiles"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/{id}":{"get":{"summary":"Gets a single User Profile","security":[{"BearerAuth":[]}],"operationId":"getUserProfileById","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile to get"}],"responses":{"200":{"description":"UserProfile with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfile not found"}}},"put":{"summary":"Update an existing User Profile","security":[{"BearerAuth":[]}],"operationId":"updateUserProfileById","tags":["User Profiles"],"requestBody":{"required":true,"description":"data for updating a new User Profile","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"crudPermissions":{"type":"string","default":"r"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfile not found"}}}},"/userProfiles/{id}/sections":{"get":{"summary":"Get sections associated to a User Profile","security":[{"BearerAuth":[]}],"operationId":"getSections","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add sections' permissions to User Profile","security":[{"BearerAuth":[]}],"operationId":"addSections","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes sections' permissions from User Profile","security":[{"BearerAuth":[]}],"operationId":"removeSections","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/{id}/resources":{"get":{"summary":"Get Resources assigned to a Section","security":[{"BearerAuth":[]}],"operationId":"getResources","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add resources' permissions to User Profile","security":[{"BearerAuth":[]}],"operationId":"addResources","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes resources' permissions from User Profile","security":[{"BearerAuth":[]}],"operationId":"removeResources","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/clone":{"post":{"summary":"Clone an existing User Profile","security":[{"BearerAuth":[]}],"operationId":"cloneUserProfile","tags":["User Profiles"],"requestBody":{"required":true,"description":"data for creating a new User Profile","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the User Profile to clone"},"name":{"type":"string"},"crudPermissions":{"type":"string","default":"r"},"description":{"type":"string"}},"required":["id"]}}}},"responses":{"201":{"description":"UserProfile successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/{id}/destroy_many":{"delete":{"summary":"Destroy an existing User Profile","security":[{"BearerAuth":[]}],"operationId":"deleteUserProfileById","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfile not found"}}}},"/userProfile/resources":{"get":{"summary":"Gets a list of User Profile Resources","security":[{"BearerAuth":[]}],"operationId":"listAllUserProfileResource","tags":["User Profile Resources"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each UserProfileResource"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of User Profile Resources","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileResource"}}}}},"206":{"description":"Partial (paged) collection of User Profile Resources","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileResource"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new User Profile Resource","security":[{"BearerAuth":[]}],"operationId":"createUserProfileResource","tags":["User Profile Resources"],"requestBody":{"required":true,"description":"data for creating a new User Profile Resource","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"resourceId":{"type":"integer"},"type":{"type":"string"}},"required":["name","resourceId","type"]}}}},"responses":{"201":{"description":"UserProfileResource successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileResource"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfile/resources/describe":{"get":{"summary":"Gets table info about User Profile Resources","security":[{"BearerAuth":[]}],"operationId":"describeUserProfileResource","tags":["User Profile Resources"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfile/resources/{id}":{"get":{"summary":"Gets a single User Profile Resource","security":[{"BearerAuth":[]}],"operationId":"getUserProfileResourceById","tags":["User Profile Resources"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileResource to get"}],"responses":{"200":{"description":"UserProfileResource with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileResource"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileResource not found"}}},"put":{"summary":"Update an existing User Profile Resource","security":[{"BearerAuth":[]}],"operationId":"updateUserProfileResourceById","tags":["User Profile Resources"],"requestBody":{"required":true,"description":"data for updating a new User Profile Resource","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"resourceId":{"type":"integer"},"type":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileResource to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileResource not found"}}}},"/userProfile/resources/{id}/destroy_many":{"delete":{"summary":"Destroy an existing User Profile Resource","security":[{"BearerAuth":[]}],"operationId":"deleteUserProfileResourceById","tags":["User Profile Resources"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileResource to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileResource not found"}}}},"/userProfile/sections":{"get":{"summary":"Gets a list of User Profile Sections","security":[{"BearerAuth":[]}],"operationId":"listAllUserProfileSection","tags":["User Profile Sections"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each UserProfileSection"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of User Profile Sections","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileSection"}}}}},"206":{"description":"Partial (paged) collection of User Profile Sections","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileSection"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new User Profile Section","security":[{"BearerAuth":[]}],"operationId":"createUserProfileSection","tags":["User Profile Sections"],"requestBody":{"required":true,"description":"data for creating a new User Profile Section","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"sectionId":{"type":"integer"},"enabled":{"type":"boolean","default":null},"autoAssociation":{"type":"boolean","default":null},"crudPermissions":{"type":"string"}},"required":["name","category","sectionId"]}}}},"responses":{"201":{"description":"UserProfileSection successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileSection"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfile/sections/describe":{"get":{"summary":"Gets table info about User Profile Sections","security":[{"BearerAuth":[]}],"operationId":"describeUserProfileSection","tags":["User Profile Sections"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfile/sections/{id}":{"get":{"summary":"Gets a single User Profile Section","security":[{"BearerAuth":[]}],"operationId":"getUserProfileSectionById","tags":["User Profile Sections"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileSection to get"}],"responses":{"200":{"description":"UserProfileSection with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileSection"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileSection not found"}}},"put":{"summary":"Update an existing User Profile Section","security":[{"BearerAuth":[]}],"operationId":"updateUserProfileSectionById","tags":["User Profile Sections"],"requestBody":{"required":true,"description":"data for updating a new User Profile Section","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"sectionId":{"type":"integer"},"enabled":{"type":"boolean","default":null},"autoAssociation":{"type":"boolean","default":null},"crudPermissions":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileSection to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileSection not found"}}}},"/userProfile/sections/{id}/destroy_many":{"delete":{"summary":"Destroy an existing User Profile Section","security":[{"BearerAuth":[]}],"operationId":"deleteUserProfileSectionById","tags":["User Profile Sections"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileSection to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileSection not found"}}}},"/variables":{"get":{"summary":"Gets a list of Variables","security":[{"BearerAuth":[]}],"operationId":"listAllVariable","tags":["Variables"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Variable"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Variables","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}}}}},"206":{"description":"Partial (paged) collection of Variables","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Variable","security":[{"BearerAuth":[]}],"operationId":"createVariable","tags":["Variables"],"requestBody":{"required":true,"description":"data for creating a new Variable","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Variable successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variable"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/variables/{id}":{"get":{"summary":"Gets a single Variable","security":[{"BearerAuth":[]}],"operationId":"getVariableById","tags":["Variables"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Variable to get"}],"responses":{"200":{"description":"Variable with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variable"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Variable not found"}}},"put":{"summary":"Update an existing Variable","security":[{"BearerAuth":[]}],"operationId":"updateVariableById","tags":["Variables"],"requestBody":{"required":true,"description":"data for updating a new Variable","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Variable to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Variable not found"}}}},"/variables/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Variable","security":[{"BearerAuth":[]}],"operationId":"deleteVariableById","tags":["Variables"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Variable to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Variable not found"}}}},"/version":{"get":{"summary":"Gets version","operationId":"getVersion","tags":["Version"],"responses":{"200":{"description":"full server version infomation","content":{"application/json":{"schema":{"type":"object","properties":{"current":{"type":"string","description":"current product version (semver)"},"phonebar":{"type":"string","description":"current phonebar version (semver)"},"shortHash":{"type":"string","description":"latest server git sha hash"},"branch":{"type":"string","description":"server git branch"},"tag":{"type":"string","description":"server git tag (s)"},"committedOn":{"type":"string","format":"date","description":"last commit date"},"buildDate":{"type":"string","format":"date","description":"buildDate date"}},"required":["current","phonebar","shortHash","branch","tag","committedOn","buildDate"]}}}}}}},"/version/fetch":{"get":{"summary":"Fetch git version","security":[{"BearerAuth":[]}],"operationId":"fetchVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","default":"git fetch origin master","description":"current output"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/version/reset":{"get":{"summary":"Reset git version","security":[{"BearerAuth":[]}],"operationId":"resetVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","default":"git reset --hard","description":"current output"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/version/pull":{"get":{"summary":"Pull git version","security":[{"BearerAuth":[]}],"operationId":"pullVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","description":"current output"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/version/restart":{"get":{"summary":"Restart motion2 after update","security":[{"BearerAuth":[]}],"operationId":"restartVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","default":"Your system has been restarted successfully","description":"current output"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/version/migrations":{"get":{"summary":"Launch database migrations","security":[{"BearerAuth":[]}],"operationId":"migrateVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","default":"Database already up-to-date","description":"current output"},"migrations":{"type":"array","items":{"type":"string"},"description":"migrations that have been executed (version numbers)"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/agents/reports":{"get":{"summary":"Gets a list of Agent Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceAgentReport","tags":["Voice Agent Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceAgentReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Agent Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceAgentReport"}}}}},"206":{"description":"Partial (paged) collection of Agent Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceAgentReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/agents/reports/describe":{"get":{"summary":"Gets table info about Agent Reports","security":[{"BearerAuth":[]}],"operationId":"describeVoiceAgentReport","tags":["Voice Agent Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/agents/reports/{id}":{"get":{"summary":"Gets a single Agent Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceAgentReportById","tags":["Voice Agent Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceAgentReport to get"}],"responses":{"200":{"description":"VoiceAgentReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceAgentReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceAgentReport not found"}}}},"/voice/calls/reports":{"get":{"summary":"Gets a list of Call Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceCallReport","tags":["Voice Call Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceCallReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Call Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceCallReport"}}}}},"206":{"description":"Partial (paged) collection of Call Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceCallReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/calls/reports/describe":{"get":{"summary":"Gets table info about Call Reports","security":[{"BearerAuth":[]}],"operationId":"describeVoiceCallReport","tags":["Voice Call Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/calls/reports/{id}":{"get":{"summary":"Gets a single Call Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceCallReportById","tags":["Voice Call Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceCallReport to get"}],"responses":{"200":{"description":"VoiceCallReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceCallReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceCallReport not found"}}},"put":{"summary":"Update a single cdr","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Voice Call Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceCallReport"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/chanspy":{"get":{"summary":"Gets a list of Voice ChanSpy","security":[{"BearerAuth":[]}],"operationId":"listVoiceChanSpy","tags":["Voice ChanSpy"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each voice chanspy"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Voice ChanSpy","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceChanSpy"}}}}},"206":{"description":"Partial (paged) collection of Voice ChanSpy","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceChanSpy"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/chanspy/{id}":{"get":{"summary":"Get a ChanSpy by Id","security":[{"BearerAuth":[]}],"operationId":"getChanSpyById","tags":["Voice ChanSpy"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChanSpy"}],"responses":{"200":{"description":"the desired chanspy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceChanSpy"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"chanspy not found"}}},"post":{"summary":"create a ChanSpy","security":[{"BearerAuth":[]}],"operationId":"createChanSpy","tags":["Voice ChanSpy"],"requestBody":{"required":true,"description":"chanspy data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"chanspy name"},"prefix":{"type":"string","description":"chanspy prefix"},"options":{"type":"string","description":"chanspy preoptionsfix"},"auth":{"type":"boolean","description":"chanspy auth"},"password":{"type":"string","format":"password","description":"chanspy password"},"record":{"type":"boolean","description":"chanspy record"},"recordingFormat":{"type":"string","description":"chanspy recordingFormat"},"description":{"type":"string","description":"chanspy description"}},"required":["prefix"]}}}},"responses":{"201":{"description":"successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceChanSpy"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"chanspy not found"}}},"put":{"summary":"Update a ChanSpy","security":[{"BearerAuth":[]}],"operationId":"updateChanSpyById","tags":["Voice ChanSpy"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChanSpy"}],"requestBody":{"required":true,"description":"chanspy data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"chanspy name"},"prefix":{"type":"string","description":"chanspy prefix"},"options":{"type":"string","description":"chanspy preoptionsfix"},"auth":{"type":"boolean","description":"chanspy auth"},"password":{"type":"string","format":"password","description":"chanspy password"},"record":{"type":"boolean","description":"chanspy record"},"recordingFormat":{"type":"string","description":"chanspy recordingFormat"},"description":{"type":"string","description":"chanspy description"}},"required":["prefix"]}}}},"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"chanspy not found"}}},"delete":{"summary":"Delete a ChanSpy","security":[{"BearerAuth":[]}],"operationId":"deleteChanSpyById","tags":["Voice ChanSpy"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChanSpy"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"chanspy not found"}}}},"/voice/contexts":{"get":{"summary":"Gets a list of Contexts","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceContext","tags":["Voice Contexts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceContext"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Contexts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceContext"}}}}},"206":{"description":"Partial (paged) collection of Contexts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceContext"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/contexts/{id}":{"get":{"summary":"Gets a single Context","security":[{"BearerAuth":[]}],"operationId":"getVoiceContextById","tags":["Voice Contexts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceContext to get"}],"responses":{"200":{"description":"VoiceContext with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceContext"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceContext not found"}}},"put":{"summary":"Update an existing context","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Voice Contexts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceContext"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Deletes a context","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Voice Contexts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceContext"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/contexts/":{"post":{"summary":"Create a new context","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Voice Contexts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/dials/reports":{"get":{"summary":"Gets a list of Dial Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceDialReport","tags":["Voice Dial Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceDialReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dial Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceDialReport"}}}}},"206":{"description":"Partial (paged) collection of Dial Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceDialReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/dials/reports/describe":{"get":{"summary":"Gets table info about Dial Reports","security":[{"BearerAuth":[]}],"operationId":"describeVoiceDialReport","tags":["Voice Dial Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/dials/reports/{id}":{"get":{"summary":"Gets a single Dial Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceDialReportById","tags":["Voice Dial Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceDialReport to get"}],"responses":{"200":{"description":"VoiceDialReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceDialReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceDialReport not found"}}}},"/voice/extensions":{"get":{"summary":"Gets a list of Extensions","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceExtension","tags":["Voice Extensions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceExtension"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Extensions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceExtension"}}}}},"206":{"description":"Partial (paged) collection of Extensions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceExtension"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/extensions/{id}":{"get":{"summary":"Gets a single Extension","security":[{"BearerAuth":[]}],"operationId":"getVoiceExtensionById","tags":["Voice Extensions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceExtension to get"}],"responses":{"200":{"description":"VoiceExtension with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceExtension"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceExtension not found"}}},"put":{"summary":"Update an extension","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Voice Extensions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceExtension"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/extensions/":{"post":{"summary":"Create an extension","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Voice Extensions"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/extensions/{id}/applications":{"post":{"summary":"Create new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Voice Extensions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceExtension"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/extensions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Extension","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceExtensionById","tags":["Voice Extensions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceExtension to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceExtension not found"}}}},"/voice/mails":{"get":{"summary":"Gets a list of Mails","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceMail","tags":["Voice Mails"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceMail"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Mails","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMail"}}}}},"206":{"description":"Partial (paged) collection of Mails","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMail"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Mail","security":[{"BearerAuth":[]}],"operationId":"createVoiceMail","tags":["Voice Mails"],"requestBody":{"required":true,"description":"data for creating a new Mail","content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string"},"context":{"type":"string","default":"from-voicemail"},"mailbox":{"type":"string","default":""},"password":{"type":"string"},"fullname":{"type":"string"},"email":{"type":"string"},"pager":{"type":"string"},"tz":{"type":"string","default":"central"},"attach":{"type":"string","enum":["yes","no"],"default":"yes"},"saycid":{"type":"string","enum":["yes","no"],"default":"yes"},"dialout":{"type":"string"},"callback":{"type":"string"},"review":{"type":"string","enum":["yes","no"],"default":"no"},"operator":{"type":"string","enum":["yes","no"],"default":"no"},"envelope":{"type":"string","enum":["yes","no"],"default":"no"},"sayduration":{"type":"string","enum":["yes","no"],"default":"no"},"saydurationm":{"type":"string","default":1},"sendvoicemail":{"type":"string","enum":["yes","no"],"default":"no"},"delete":{"type":"string","enum":["yes","no"],"default":"no"},"nextaftercmd":{"type":"string","enum":["yes","no"],"default":"yes"},"forcename":{"type":"string","enum":["yes","no"],"default":"no"},"forcegreetings":{"type":"string","enum":["yes","no"],"default":"no"},"hidefromdir":{"type":"string","enum":["yes","no"],"default":"yes"},"stamp":{"type":"string"},"emailsubject":{"type":"string"},"emailbody":{"type":"string"},"maxsecs":{"type":"integer","default":180},"maxmsg":{"type":"integer","default":100},"name":{"type":"string"}},"required":["mailbox","attach","saycid","review","operator","envelope","sayduration","saydurationm","sendvoicemail","delete","nextaftercmd","forcename","forcegreetings","hidefromdir","maxsecs","maxmsg"]}}}},"responses":{"201":{"description":"VoiceMail successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMail"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mails/{id}":{"get":{"summary":"Gets a single Mail","security":[{"BearerAuth":[]}],"operationId":"getVoiceMailById","tags":["Voice Mails"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMail to get"}],"responses":{"200":{"description":"VoiceMail with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMail"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMail not found"}}},"put":{"summary":"Update an existing Mail","security":[{"BearerAuth":[]}],"operationId":"updateVoiceMailById","tags":["Voice Mails"],"requestBody":{"required":true,"description":"data for updating a new Mail","content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string"},"context":{"type":"string","default":"from-voicemail"},"mailbox":{"type":"string","default":""},"password":{"type":"string"},"fullname":{"type":"string"},"email":{"type":"string"},"pager":{"type":"string"},"tz":{"type":"string","default":"central"},"attach":{"type":"string","enum":["yes","no"],"default":"yes"},"saycid":{"type":"string","enum":["yes","no"],"default":"yes"},"dialout":{"type":"string"},"callback":{"type":"string"},"review":{"type":"string","enum":["yes","no"],"default":"no"},"operator":{"type":"string","enum":["yes","no"],"default":"no"},"envelope":{"type":"string","enum":["yes","no"],"default":"no"},"sayduration":{"type":"string","enum":["yes","no"],"default":"no"},"saydurationm":{"type":"string","default":1},"sendvoicemail":{"type":"string","enum":["yes","no"],"default":"no"},"delete":{"type":"string","enum":["yes","no"],"default":"no"},"nextaftercmd":{"type":"string","enum":["yes","no"],"default":"yes"},"forcename":{"type":"string","enum":["yes","no"],"default":"no"},"forcegreetings":{"type":"string","enum":["yes","no"],"default":"no"},"hidefromdir":{"type":"string","enum":["yes","no"],"default":"yes"},"stamp":{"type":"string"},"emailsubject":{"type":"string"},"emailbody":{"type":"string"},"maxsecs":{"type":"integer","default":180},"maxmsg":{"type":"integer","default":100},"name":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMail to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMail not found"}}}},"/voice/mails/{id}/messages":{"get":{"summary":"Gets voice mail messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Voice Mails"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMail"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mails/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Mail","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceMailById","tags":["Voice Mails"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMail to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMail not found"}}}},"/voice/mails/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceMailMessage","tags":["Voice Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceMailMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMailMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMailMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createVoiceMailMessage","tags":["Voice Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"msgnum":{"type":"integer","default":0},"dir":{"type":"string","default":""},"context":{"type":"string","default":""},"macrocontext":{"type":"string","default":""},"callerid":{"type":"string","default":""},"origtime":{"type":"string","default":""},"duration":{"type":"string","default":""},"mailboxuser":{"type":"string","default":""},"mailboxcontext":{"type":"string","default":""},"recording":{"type":"object","default":null},"flag":{"type":"string","default":""},"msg_id":{"type":"string","default":""},"stamp":{"type":"string"}},"required":["msgnum","stamp"]}}}},"responses":{"201":{"description":"VoiceMailMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMailMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mails/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getVoiceMailMessageById","tags":["Voice Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMailMessage to get"}],"responses":{"200":{"description":"VoiceMailMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMailMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMailMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateVoiceMailMessageById","tags":["Voice Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"msgnum":{"type":"integer","default":0},"dir":{"type":"string","default":""},"context":{"type":"string","default":""},"macrocontext":{"type":"string","default":""},"callerid":{"type":"string","default":""},"origtime":{"type":"string","default":""},"duration":{"type":"string","default":""},"mailboxuser":{"type":"string","default":""},"mailboxcontext":{"type":"string","default":""},"recording":{"type":"object","default":null},"flag":{"type":"string","default":""},"msg_id":{"type":"string","default":""},"stamp":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMailMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMailMessage not found"}}}},"/voice/mails/messages/{id}/download":{"get":{"summary":"Download Voice Message","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Voice Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMailMessage"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mails/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceMailMessageById","tags":["Voice Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMailMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMailMessage not found"}}}},"/voice/mohs":{"get":{"summary":"Gets a list of Music On Holds","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceMusicOnHold","tags":["Voice MOHs"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceMusicOnHold"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Music On Holds","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMusicOnHold"}}}}},"206":{"description":"Partial (paged) collection of Music On Holds","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMusicOnHold"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mohs/{id}":{"get":{"summary":"Gets a single Music On Hold","security":[{"BearerAuth":[]}],"operationId":"getVoiceMusicOnHoldById","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold to get"}],"responses":{"200":{"description":"VoiceMusicOnHold with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMusicOnHold"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMusicOnHold not found"}}},"put":{"summary":"Update an existing Music On Hold","security":[{"BearerAuth":[]}],"operationId":"updateVoiceMusicOnHoldById","tags":["Voice MOHs"],"requestBody":{"required":true,"description":"data for updating a new Music On Hold","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"mode":{"type":"string","enum":["custom","files","mp3nb","quietmp3nb","quietmp3","mp3"],"default":"files"},"directory":{"type":"string"},"application":{"type":"string"},"digit":{"type":"string"},"sort":{"type":"string","default":"alpha"},"format":{"type":"string"},"stamp":{"type":"string"},"defaultEntry":{"type":"boolean","default":0}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMusicOnHold not found"}}},"delete":{"summary":"Deletes an MOH","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mohs/{id}/sounds":{"get":{"summary":"Gets sounds from MOH","security":[{"BearerAuth":[]}],"operationId":"getSounds","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add sound to MOH","security":[{"BearerAuth":[]}],"operationId":"addSound","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mohs/":{"post":{"summary":"Create a new a new MOH","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Voice MOHs"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mohs/{id}/sounds/:id2":{"delete":{"summary":"Remove sound from MOH","security":[{"BearerAuth":[]}],"operationId":"removeSound","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes":{"get":{"summary":"Gets a list of Prefixes","security":[{"BearerAuth":[]}],"operationId":"listAllVoicePrefix","tags":["Voice Prefixes"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoicePrefix"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Prefixes","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoicePrefix"}}}}},"206":{"description":"Partial (paged) collection of Prefixes","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoicePrefix"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/describe":{"get":{"summary":"Gets table info about Prefixes","security":[{"BearerAuth":[]}],"operationId":"describeVoicePrefix","tags":["Voice Prefixes"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/{id}":{"get":{"summary":"Gets a single Prefix","security":[{"BearerAuth":[]}],"operationId":"getVoicePrefixById","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix to get"}],"responses":{"200":{"description":"VoicePrefix with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoicePrefix"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoicePrefix not found"}}},"put":{"summary":"Update an existing prefix","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/{id}/users":{"get":{"summary":"Gets agents from prefix","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a prefix","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a prefix","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/":{"post":{"summary":"Create a prefix","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Voice Prefixes"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Prefix","security":[{"BearerAuth":[]}],"operationId":"deleteVoicePrefixById","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoicePrefix not found"}}}},"/voice/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceQueue","tags":["Voice Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createVoiceQueue","tags":["Voice Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["inbound","outbound"],"default":"inbound"},"musiconhold":{"type":"string","default":"default"},"announce":{"type":"string","default":""},"strategy":{"type":"string","enum":["rr","ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"],"default":"ringall"},"servicelevel":{"type":"integer","default":0},"context":{"type":"string","default":null},"penaltymemberslimit":{"type":"integer"},"timeout":{"type":"integer","default":15},"retry":{"type":"integer","default":2},"timeoutpriority":{"type":"string"},"weight":{"type":"integer","default":0},"wrapuptime":{"type":"integer","default":0},"autofill":{"type":"string","enum":["yes","no"],"default":"yes"},"autopause":{"type":"string","enum":["yes","no","all"],"default":"no"},"autopausedelay":{"type":"integer"},"autopausebusy":{"type":"string","enum":["yes","no"],"default":"no"},"autopauseunavail":{"type":"string","enum":["yes","no"],"default":"no"},"maxlen":{"type":"integer","default":0},"setinterfacevar":{"type":"string","enum":["yes","no"],"default":"no"},"setqueueentryvar":{"type":"string","enum":["yes","no"]},"setqueuevar":{"type":"string","enum":["yes","no"],"default":"no"},"eventmemberstatus":{"type":"string","enum":["yes","no"],"default":"no"},"membermacro":{"type":"string"},"membergosub":{"type":"string"},"announce_frequency":{"type":"integer","default":0},"min_announce_frequency":{"type":"integer","default":0},"periodic_announce_frequency":{"type":"integer","default":0},"random_periodic_announce":{"type":"string","enum":["yes","no"],"default":"no"},"relative_periodic_announce":{"type":"string","enum":["yes","no"],"default":"yes"},"announce_holdtime":{"type":"string","enum":["yes","no","once"],"default":"no"},"announce_position":{"type":"string","default":"no"},"announce_to_first_user":{"type":"string","enum":["yes","no"]},"announce_position_limit":{"type":"integer"},"announce_round_seconds":{"type":"string","enum":["0","5","10","15","20","30"],"default":"0"},"monitor_format":{"type":"string","default":""},"monitor_type":{"type":"string"},"queue_youarenext":{"type":"string","default":null},"queue_thereare":{"type":"string","default":null},"queue_callswaiting":{"type":"string","default":null},"queue_holdtime":{"type":"string","default":null},"queue_minute":{"type":"string","default":null},"queue_minutes":{"type":"string","default":null},"queue_seconds":{"type":"string","default":null},"queue_thankyou":{"type":"string","default":null},"queue_reporthold":{"type":"string"},"queue_quantity1":{"type":"string"},"queue_quantity2":{"type":"string"},"queue_periodic_announce":{"type":"string"},"queue_less_than":{"type":"string"},"periodic_announce":{"type":"string"},"joinempty":{"type":"string","default":"yes"},"leavewhenempty":{"type":"string","default":"no"},"reportholdtime":{"type":"string","enum":["yes","no"],"default":"no"},"ringinuse":{"type":"string","enum":["yes","no"],"default":"no"},"memberdelay":{"type":"integer","default":0},"timeoutrestart":{"type":"string","enum":["yes","no"],"default":"no"},"defaultrule":{"type":"string"},"description":{"type":"string"},"acw":{"type":"boolean","default":0},"acwTimeout":{"type":"integer","default":10},"dialActive":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"dialMethod":{"type":"string","enum":["preview","progressive","power","predictive","booked"],"description":"Dial Method.","default":"progressive"},"dialLimitChannel":{"type":"integer","description":"Max 9999 channels, 0 means unlimited.","default":0},"dialLimitQueue":{"type":"integer","description":"Max 9999 member in queue(min:1, max:9999), 0 means unlimited.","default":0},"dialPowerLevel":{"type":"number","description":"Power Level: Calls for agents (min:1, max:10).","default":1},"dialPredictiveOptimization":{"type":"string","enum":["agentBusyFactor","dropRate"],"description":"Only for predictive method.","default":"dropRate"},"dialPredictiveOptimizationPercentage":{"type":"number","description":"Predictive Optimization Percentage (min: 1, max: 95)","default":3},"dialPredictiveInterval":{"type":"integer","description":"Interval Predictive Minutes (min:5 max:30)","default":10},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialQueueOptions":{"type":"string","description":"https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue","default":"tTxX"},"dialQueueTimeout":{"type":"integer","description":"Queue Timeout Seconds (min:1, max:999)","default":3},"dialQueueProject":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialPrefix":{"type":"string","default":null},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialRecallMeTimeout":{"type":"integer","description":"#RecallMe Timeout (min:1)","default":30},"dialRecallInQueue":{"type":"boolean","description":"Active/Disactive Recall In Queue","default":0},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialQueueProject2":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialAgiAfterHangupClient":{"type":"boolean","default":false},"dialAgiAfterHangupAgent":{"type":"boolean","default":false},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"dialPredictiveIntervalMaxThreshold":{"type":"integer","default":20},"dialPredictiveIntervalMinThreshold":{"type":"integer","default":10}},"required":["name","type","strategy"]}}}},"responses":{"201":{"description":"VoiceQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getVoiceQueueById","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue to get"}],"responses":{"200":{"description":"VoiceQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateVoiceQueueById","tags":["Voice Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["inbound","outbound"],"default":"inbound"},"musiconhold":{"type":"string","default":"default"},"announce":{"type":"string","default":""},"strategy":{"type":"string","enum":["rr","ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"],"default":"ringall"},"servicelevel":{"type":"integer","default":0},"context":{"type":"string","default":null},"penaltymemberslimit":{"type":"integer"},"timeout":{"type":"integer","default":15},"retry":{"type":"integer","default":2},"timeoutpriority":{"type":"string"},"weight":{"type":"integer","default":0},"wrapuptime":{"type":"integer","default":0},"autofill":{"type":"string","enum":["yes","no"],"default":"yes"},"autopause":{"type":"string","enum":["yes","no","all"],"default":"no"},"autopausedelay":{"type":"integer"},"autopausebusy":{"type":"string","enum":["yes","no"],"default":"no"},"autopauseunavail":{"type":"string","enum":["yes","no"],"default":"no"},"maxlen":{"type":"integer","default":0},"setinterfacevar":{"type":"string","enum":["yes","no"],"default":"no"},"setqueueentryvar":{"type":"string","enum":["yes","no"]},"setqueuevar":{"type":"string","enum":["yes","no"],"default":"no"},"eventmemberstatus":{"type":"string","enum":["yes","no"],"default":"no"},"membermacro":{"type":"string"},"membergosub":{"type":"string"},"announce_frequency":{"type":"integer","default":0},"min_announce_frequency":{"type":"integer","default":0},"periodic_announce_frequency":{"type":"integer","default":0},"random_periodic_announce":{"type":"string","enum":["yes","no"],"default":"no"},"relative_periodic_announce":{"type":"string","enum":["yes","no"],"default":"yes"},"announce_holdtime":{"type":"string","enum":["yes","no","once"],"default":"no"},"announce_position":{"type":"string","default":"no"},"announce_to_first_user":{"type":"string","enum":["yes","no"]},"announce_position_limit":{"type":"integer"},"announce_round_seconds":{"type":"string","enum":["0","5","10","15","20","30"],"default":"0"},"monitor_format":{"type":"string","default":""},"monitor_type":{"type":"string"},"queue_youarenext":{"type":"string","default":null},"queue_thereare":{"type":"string","default":null},"queue_callswaiting":{"type":"string","default":null},"queue_holdtime":{"type":"string","default":null},"queue_minute":{"type":"string","default":null},"queue_minutes":{"type":"string","default":null},"queue_seconds":{"type":"string","default":null},"queue_thankyou":{"type":"string","default":null},"queue_reporthold":{"type":"string"},"queue_quantity1":{"type":"string"},"queue_quantity2":{"type":"string"},"queue_periodic_announce":{"type":"string"},"queue_less_than":{"type":"string"},"periodic_announce":{"type":"string"},"joinempty":{"type":"string","default":"yes"},"leavewhenempty":{"type":"string","default":"no"},"reportholdtime":{"type":"string","enum":["yes","no"],"default":"no"},"ringinuse":{"type":"string","enum":["yes","no"],"default":"no"},"memberdelay":{"type":"integer","default":0},"timeoutrestart":{"type":"string","enum":["yes","no"],"default":"no"},"defaultrule":{"type":"string"},"description":{"type":"string"},"acw":{"type":"boolean","default":0},"acwTimeout":{"type":"integer","default":10},"dialActive":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"dialMethod":{"type":"string","enum":["preview","progressive","power","predictive","booked"],"description":"Dial Method.","default":"progressive"},"dialLimitChannel":{"type":"integer","description":"Max 9999 channels, 0 means unlimited.","default":0},"dialLimitQueue":{"type":"integer","description":"Max 9999 member in queue(min:1, max:9999), 0 means unlimited.","default":0},"dialPowerLevel":{"type":"number","description":"Power Level: Calls for agents (min:1, max:10).","default":1},"dialPredictiveOptimization":{"type":"string","enum":["agentBusyFactor","dropRate"],"description":"Only for predictive method.","default":"dropRate"},"dialPredictiveOptimizationPercentage":{"type":"number","description":"Predictive Optimization Percentage (min: 1, max: 95)","default":3},"dialPredictiveInterval":{"type":"integer","description":"Interval Predictive Minutes (min:5 max:30)","default":10},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialQueueOptions":{"type":"string","description":"https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue","default":"tTxX"},"dialQueueTimeout":{"type":"integer","description":"Queue Timeout Seconds (min:1, max:999)","default":3},"dialQueueProject":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialPrefix":{"type":"string","default":null},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialRecallMeTimeout":{"type":"integer","description":"#RecallMe Timeout (min:1)","default":30},"dialRecallInQueue":{"type":"boolean","description":"Active/Disactive Recall In Queue","default":0},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialQueueProject2":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialAgiAfterHangupClient":{"type":"boolean","default":false},"dialAgiAfterHangupAgent":{"type":"boolean","default":false},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"dialPredictiveIntervalMaxThreshold":{"type":"integer","default":20},"dialPredictiveIntervalMinThreshold":{"type":"integer","default":10}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueue not found"}}}},"/voice/queues/{id}/hoppers":{"get":{"summary":"Gets queue hoppers","security":[{"BearerAuth":[]}],"operationId":"getHoppers","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/hopper_histories":{"get":{"summary":"Gets queue hopper histories","security":[{"BearerAuth":[]}],"operationId":"getHopperHistories","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/hopper_finals":{"get":{"summary":"Gets queue hopper finals","security":[{"BearerAuth":[]}],"operationId":"getHopperFinals","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/hopper_black":{"get":{"summary":"Gets queue hopper blacks","security":[{"BearerAuth":[]}],"operationId":"getHopperBlacks","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/teams":{"get":{"summary":"Gets queue team","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/members":{"get":{"summary":"Gets queue members","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/lists":{"get":{"summary":"Get queue lists","security":[{"BearerAuth":[]}],"operationId":"getLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add lists to a queue","security":[{"BearerAuth":[]}],"operationId":"addLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove lists from a queue","security":[{"BearerAuth":[]}],"operationId":"removeLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/blacklists":{"get":{"summary":"Get queue blacklists","security":[{"BearerAuth":[]}],"operationId":"getBlackLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add blacklists to a queue","security":[{"BearerAuth":[]}],"operationId":"addBlackLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove blacklists from a queue","security":[{"BearerAuth":[]}],"operationId":"removeBlackLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/clone":{"post":{"summary":"Clone an existing Queue","security":[{"BearerAuth":[]}],"operationId":"cloneVoiceQueue","tags":["Voice Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Queue to clone"},"name":{"type":"string"},"type":{"type":"string","enum":["inbound","outbound"],"default":"inbound"},"musiconhold":{"type":"string","default":"default"},"announce":{"type":"string","default":""},"strategy":{"type":"string","enum":["rr","ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"],"default":"ringall"},"servicelevel":{"type":"integer","default":0},"context":{"type":"string","default":null},"penaltymemberslimit":{"type":"integer"},"timeout":{"type":"integer","default":15},"retry":{"type":"integer","default":2},"timeoutpriority":{"type":"string"},"weight":{"type":"integer","default":0},"wrapuptime":{"type":"integer","default":0},"autofill":{"type":"string","enum":["yes","no"],"default":"yes"},"autopause":{"type":"string","enum":["yes","no","all"],"default":"no"},"autopausedelay":{"type":"integer"},"autopausebusy":{"type":"string","enum":["yes","no"],"default":"no"},"autopauseunavail":{"type":"string","enum":["yes","no"],"default":"no"},"maxlen":{"type":"integer","default":0},"setinterfacevar":{"type":"string","enum":["yes","no"],"default":"no"},"setqueueentryvar":{"type":"string","enum":["yes","no"]},"setqueuevar":{"type":"string","enum":["yes","no"],"default":"no"},"eventmemberstatus":{"type":"string","enum":["yes","no"],"default":"no"},"membermacro":{"type":"string"},"membergosub":{"type":"string"},"announce_frequency":{"type":"integer","default":0},"min_announce_frequency":{"type":"integer","default":0},"periodic_announce_frequency":{"type":"integer","default":0},"random_periodic_announce":{"type":"string","enum":["yes","no"],"default":"no"},"relative_periodic_announce":{"type":"string","enum":["yes","no"],"default":"yes"},"announce_holdtime":{"type":"string","enum":["yes","no","once"],"default":"no"},"announce_position":{"type":"string","default":"no"},"announce_to_first_user":{"type":"string","enum":["yes","no"]},"announce_position_limit":{"type":"integer"},"announce_round_seconds":{"type":"string","enum":["0","5","10","15","20","30"],"default":"0"},"monitor_format":{"type":"string","default":""},"monitor_type":{"type":"string"},"queue_youarenext":{"type":"string","default":null},"queue_thereare":{"type":"string","default":null},"queue_callswaiting":{"type":"string","default":null},"queue_holdtime":{"type":"string","default":null},"queue_minute":{"type":"string","default":null},"queue_minutes":{"type":"string","default":null},"queue_seconds":{"type":"string","default":null},"queue_thankyou":{"type":"string","default":null},"queue_reporthold":{"type":"string"},"queue_quantity1":{"type":"string"},"queue_quantity2":{"type":"string"},"queue_periodic_announce":{"type":"string"},"queue_less_than":{"type":"string"},"periodic_announce":{"type":"string"},"joinempty":{"type":"string","default":"yes"},"leavewhenempty":{"type":"string","default":"no"},"reportholdtime":{"type":"string","enum":["yes","no"],"default":"no"},"ringinuse":{"type":"string","enum":["yes","no"],"default":"no"},"memberdelay":{"type":"integer","default":0},"timeoutrestart":{"type":"string","enum":["yes","no"],"default":"no"},"defaultrule":{"type":"string"},"description":{"type":"string"},"acw":{"type":"boolean","default":0},"acwTimeout":{"type":"integer","default":10},"dialActive":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"dialMethod":{"type":"string","enum":["preview","progressive","power","predictive","booked"],"description":"Dial Method.","default":"progressive"},"dialLimitChannel":{"type":"integer","description":"Max 9999 channels, 0 means unlimited.","default":0},"dialLimitQueue":{"type":"integer","description":"Max 9999 member in queue(min:1, max:9999), 0 means unlimited.","default":0},"dialPowerLevel":{"type":"number","description":"Power Level: Calls for agents (min:1, max:10).","default":1},"dialPredictiveOptimization":{"type":"string","enum":["agentBusyFactor","dropRate"],"description":"Only for predictive method.","default":"dropRate"},"dialPredictiveOptimizationPercentage":{"type":"number","description":"Predictive Optimization Percentage (min: 1, max: 95)","default":3},"dialPredictiveInterval":{"type":"integer","description":"Interval Predictive Minutes (min:5 max:30)","default":10},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialQueueOptions":{"type":"string","description":"https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue","default":"tTxX"},"dialQueueTimeout":{"type":"integer","description":"Queue Timeout Seconds (min:1, max:999)","default":3},"dialQueueProject":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialPrefix":{"type":"string","default":null},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialRecallMeTimeout":{"type":"integer","description":"#RecallMe Timeout (min:1)","default":30},"dialRecallInQueue":{"type":"boolean","description":"Active/Disactive Recall In Queue","default":0},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialQueueProject2":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialAgiAfterHangupClient":{"type":"boolean","default":false},"dialAgiAfterHangupAgent":{"type":"boolean","default":false},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"dialPredictiveIntervalMaxThreshold":{"type":"integer","default":20},"dialPredictiveIntervalMinThreshold":{"type":"integer","default":10}},"required":["id"]}}}},"responses":{"201":{"description":"VoiceQueue successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceQueueById","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueue not found"}}}},"/voice/queues/reports":{"get":{"summary":"Gets a list of Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceQueueReport","tags":["Voice Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/reports/describe":{"get":{"summary":"Gets table info about Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeVoiceQueueReport","tags":["Voice Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/reports/index":{"get":{"summary":"Get Voice Queues Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceQueuesReport","tags":["Voice Queue Reports"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/reports/{id}":{"get":{"summary":"Gets a single Queue Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceQueueReportById","tags":["Voice Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueueReport to get"}],"responses":{"200":{"description":"VoiceQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueueReport not found"}}}},"/voiceQueuesLog":{"get":{"summary":"Gets a list of VoiceQueuesLogs","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceQueuesLog","tags":["voiceQueuesLog"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceQueuesLog"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of VoiceQueuesLogs","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueuesLog"}}}}},"206":{"description":"Partial (paged) collection of VoiceQueuesLogs","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueuesLog"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new VoiceQueuesLog","security":[{"BearerAuth":[]}],"operationId":"createVoiceQueuesLog","tags":["voiceQueuesLog"],"requestBody":{"required":true,"description":"data for creating a new VoiceQueuesLog","content":{"application/json":{"schema":{"type":"object","properties":{"time":{"type":"string"},"callid":{"type":"string","default":""},"queuename":{"type":"string","default":""},"agent":{"type":"string","default":""},"event":{"type":"string","default":""},"data":{"type":"string","default":""},"data1":{"type":"string","default":""},"data2":{"type":"string","default":""},"data3":{"type":"string","default":""},"data4":{"type":"string","default":""},"data5":{"type":"string","default":""},"dtm":{"type":"string","default":"2020-11-27 10:41:25"}},"required":["callid","queuename","agent","event","data","data1","data2","data3","data4","data5","dtm"]}}}},"responses":{"201":{"description":"VoiceQueuesLog successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueuesLog"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voiceQueuesLog/{id}":{"get":{"summary":"Gets a single VoiceQueuesLog","security":[{"BearerAuth":[]}],"operationId":"getVoiceQueuesLogById","tags":["voiceQueuesLog"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueuesLog to get"}],"responses":{"200":{"description":"VoiceQueuesLog with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueuesLog"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueuesLog not found"}}},"put":{"summary":"Update an existing VoiceQueuesLog","security":[{"BearerAuth":[]}],"operationId":"updateVoiceQueuesLogById","tags":["voiceQueuesLog"],"requestBody":{"required":true,"description":"data for updating a new VoiceQueuesLog","content":{"application/json":{"schema":{"type":"object","properties":{"time":{"type":"string"},"callid":{"type":"string","default":""},"queuename":{"type":"string","default":""},"agent":{"type":"string","default":""},"event":{"type":"string","default":""},"data":{"type":"string","default":""},"data1":{"type":"string","default":""},"data2":{"type":"string","default":""},"data3":{"type":"string","default":""},"data4":{"type":"string","default":""},"data5":{"type":"string","default":""},"dtm":{"type":"string","default":"2020-11-27 10:41:25"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueuesLog to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueuesLog not found"}}}},"/voiceQueuesLog/{id}/destroy_many":{"delete":{"summary":"Destroy an existing VoiceQueuesLog","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceQueuesLogById","tags":["voiceQueuesLog"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueuesLog to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueuesLog not found"}}}},"/voice/recordings":{"get":{"summary":"Gets a list of Recordings","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceRecording","tags":["Voice Recordings"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceRecording"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceRecording"}}}}},"206":{"description":"Partial (paged) collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceRecording"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Recording","security":[{"BearerAuth":[]}],"operationId":"createVoiceRecording","tags":["Voice Recordings"],"requestBody":{"required":true,"description":"data for creating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string"},"uniqueid":{"type":"string"},"channel":{"type":"string"},"membername":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"connectedlinenum":{"type":"string"},"connectedlinename":{"type":"string"},"accountcode":{"type":"string"},"context":{"type":"string"},"exten":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"rating":{"type":"integer"},"queue":{"type":"string"},"userDisposition":{"type":"string"},"userSecondDisposition":{"type":"string"},"userThirdDisposition":{"type":"string"},"location":{"type":"string"},"transcribeName":{"type":"string"},"transcribeStatus":{"type":"string","default":"NEW"},"fileUri":{"type":"string"},"fileText":{"type":"string"},"failureReason":{"type":"string"},"sentiment":{"type":"string"},"sPositive":{"type":"number"},"sNegative":{"type":"number"},"sNeutral":{"type":"number"},"sMixed":{"type":"number"},"tempSentiment":{"type":"boolean","default":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"responses":{"201":{"description":"VoiceRecording successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/recordings/describe":{"get":{"summary":"Gets table info about Recordings","security":[{"BearerAuth":[]}],"operationId":"describeVoiceRecording","tags":["Voice Recordings"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/recordings/{id}":{"get":{"summary":"Gets a single Recording","security":[{"BearerAuth":[]}],"operationId":"getVoiceRecordingById","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording to get"}],"responses":{"200":{"description":"VoiceRecording with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceRecording not found"}}},"put":{"summary":"Update an existing Recording","security":[{"BearerAuth":[]}],"operationId":"updateVoiceRecordingById","tags":["Voice Recordings"],"requestBody":{"required":true,"description":"data for updating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string"},"uniqueid":{"type":"string"},"channel":{"type":"string"},"membername":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"connectedlinenum":{"type":"string"},"connectedlinename":{"type":"string"},"accountcode":{"type":"string"},"context":{"type":"string"},"exten":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"rating":{"type":"integer"},"queue":{"type":"string"},"userDisposition":{"type":"string"},"userSecondDisposition":{"type":"string"},"userThirdDisposition":{"type":"string"},"location":{"type":"string"},"transcribeName":{"type":"string"},"transcribeStatus":{"type":"string","default":"NEW"},"fileUri":{"type":"string"},"fileText":{"type":"string"},"failureReason":{"type":"string"},"sentiment":{"type":"string"},"sPositive":{"type":"number"},"sNegative":{"type":"number"},"sNeutral":{"type":"number"},"sMixed":{"type":"number"},"tempSentiment":{"type":"boolean","default":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceRecording not found"}}},"delete":{"summary":"Delete voice recording","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/recordings/{id}/download":{"get":{"summary":"Download Recording","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/recordings/{id}/downloads":{"get":{"summary":"Download Recording","operationId":"downloads","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/voice/recordings/{id}/transcribe":{"get":{"summary":"Run Transcribe Recording","security":[{"BearerAuth":[]}],"operationId":"downloadTranscribe","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Run Transcribe Recording","security":[{"BearerAuth":[]}],"operationId":"runTranscribe","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/transfers/reports":{"get":{"summary":"Gets a list of Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceTransferReport","tags":["Voice Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createVoiceTransferReport","tags":["Voice Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["blind","attended"]},"result":{"type":"string"},"transfererchannel":{"type":"string"},"transferercalleridnum":{"type":"string"},"transferercalleridname":{"type":"string"},"transfererconnectedlinenum":{"type":"string"},"transfererconnectedlinename":{"type":"string"},"transfereraccountcode":{"type":"string"},"transferercontext":{"type":"string"},"transfererexten":{"type":"string"},"transfererlinkedid":{"type":"string"},"transfereechannel":{"type":"string"},"transfereecalleridnum":{"type":"string"},"transfereecalleridname":{"type":"string"},"transfereeconnectedlinenum":{"type":"string"},"transfereeconnectedlinename":{"type":"string"},"transfereeaccountcode":{"type":"string"},"transfereecontext":{"type":"string"},"transfereeexten":{"type":"string"},"transfereelinkedid":{"type":"string"},"isexternal":{"type":"string","enum":["Yes","No"]},"context":{"type":"string"},"extension":{"type":"string"}}}}}},"responses":{"201":{"description":"VoiceTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/transfers/reports/{id}":{"get":{"summary":"Gets a single Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceTransferReportById","tags":["Voice Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceTransferReport to get"}],"responses":{"200":{"description":"VoiceTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceTransferReport not found"}}},"put":{"summary":"Update an existing Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateVoiceTransferReportById","tags":["Voice Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["blind","attended"]},"result":{"type":"string"},"transfererchannel":{"type":"string"},"transferercalleridnum":{"type":"string"},"transferercalleridname":{"type":"string"},"transfererconnectedlinenum":{"type":"string"},"transfererconnectedlinename":{"type":"string"},"transfereraccountcode":{"type":"string"},"transferercontext":{"type":"string"},"transfererexten":{"type":"string"},"transfererlinkedid":{"type":"string"},"transfereechannel":{"type":"string"},"transfereecalleridnum":{"type":"string"},"transfereecalleridname":{"type":"string"},"transfereeconnectedlinenum":{"type":"string"},"transfereeconnectedlinename":{"type":"string"},"transfereeaccountcode":{"type":"string"},"transfereecontext":{"type":"string"},"transfereeexten":{"type":"string"},"transfereelinkedid":{"type":"string"},"isexternal":{"type":"string","enum":["Yes","No"]},"context":{"type":"string"},"extension":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceTransferReport not found"}}}},"/voice/transfers/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceTransferReportById","tags":["Voice Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceTransferReport not found"}}}},"/webbar/originate":{"post":{"summary":"Originate new webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarOriginate","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"callNumber":{"type":"string","description":"call number"},"userId":{"type":"integer","description":"user id"},"callerId":{"type":"string","description":"caller id"},"callbackUrl":{"type":"string","format":"uri","description":"callback uri"}},"required":["callNumber","userId","callerId","callbackUrl"]}}}},"responses":{"200":{"description":"web call originated successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/hangup":{"post":{"summary":"hangup call","security":[{"BearerAuth":[]}],"operationId":"webBarHangup","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"session id"},"userId":{"type":"integer","description":"user id"}},"required":["sessionId","userId"]}}}},"responses":{"200":{"description":"Hangup success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/answer":{"post":{"summary":"answer new webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarAnswer","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"session id"},"userId":{"type":"integer","description":"user id"}},"required":["sessionId","userId"]}}}},"responses":{"200":{"description":"Answer success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/hold":{"post":{"summary":"hold webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarHold","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"session id"},"userId":{"type":"integer","description":"user id"}},"required":["userId"]}}}},"responses":{"200":{"description":"Hold success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/unhold":{"post":{"summary":"unhold webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarUnhold","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"session id"},"userId":{"type":"integer","description":"user id"}},"required":["sessionId","userId"]}}}},"responses":{"200":{"description":"Unhold success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/calls":{"post":{"summary":"retrieve webrtc call list for a user","security":[{"BearerAuth":[]}],"operationId":"webBarCalls","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload containing the user","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","description":"user id"}},"required":["userId"]}}}},"responses":{"200":{"description":"list of calls","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/transfer":{"post":{"summary":"blind transfer webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarTransfer","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","description":"user id"},"sessionId":{"type":"string","description":"session id"},"transferNumber":{"type":"string","description":"transfer number"}},"required":["userId","sessionId","transferNumber"]}}}},"responses":{"200":{"description":"Transfer success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappAccount","tags":["Whatsapp Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Account","security":[{"BearerAuth":[]}],"operationId":"createWhatsappAccount","tags":["Whatsapp Accounts"],"requestBody":{"required":true,"description":"data for creating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","default":"RR1qO3WWSMLNOqQM8V3jP6ZqLmuIDDnf"},"phone":{"type":"string"},"type":{"type":"string","enum":["twilio"]},"accountSid":{"type":"string"},"authToken":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":false},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"description":{"type":"string"}},"required":["name","key","remote"]}}}},"responses":{"201":{"description":"WhatsappAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappAccount","tags":["Whatsapp Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getWhatsappAccountById","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount to get"}],"responses":{"200":{"description":"WhatsappAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappAccountById","tags":["Whatsapp Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","default":"FMf1MjzZO3wZH7rudjIGZiO6b2Q6vmOz"},"phone":{"type":"string"},"type":{"type":"string","enum":["twilio"]},"accountSid":{"type":"string"},"authToken":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":false},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappAccount not found"}}}},"/whatsapp/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/users":{"get":{"summary":"Gets agents from whatsapp account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a whatsapp account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a whatsapp account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/applications":{"get":{"summary":"Gets account applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/notify":{"post":{"summary":"Notify new message","operationId":"notify","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"}}}},"/whatsapp/accounts/{id}/send":{"post":{"summary":"Send new whatsapp message","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Account","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappAccountById","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappAccount not found"}}}},"/whatsapp/applications":{"get":{"summary":"Gets a list of Applications","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappApplication","tags":["Whatsapp Applications"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappApplication"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappApplication"}}}}},"206":{"description":"Partial (paged) collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappApplication"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Application","security":[{"BearerAuth":[]}],"operationId":"createWhatsappApplication","tags":["Whatsapp Applications"],"requestBody":{"required":true,"description":"data for creating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}},"required":["priority","app"]}}}},"responses":{"201":{"description":"WhatsappApplication successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getWhatsappApplicationById","tags":["Whatsapp Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappApplication to get"}],"responses":{"200":{"description":"WhatsappApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappApplicationById","tags":["Whatsapp Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappApplication not found"}}}},"/whatsapp/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappApplicationById","tags":["Whatsapp Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappApplication not found"}}}},"/whatsapp/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappInteraction","tags":["Whatsapp Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createWhatsappInteraction","tags":["Whatsapp Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"phone":{"type":"string"},"read1stAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}},"required":["firstMsgDirection","lastMsgDirection"]}}}},"responses":{"201":{"description":"WhatsappInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappInteraction","tags":["Whatsapp Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getWhatsappInteractionById","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction to get"}],"responses":{"200":{"description":"WhatsappInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappInteractionById","tags":["Whatsapp Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"phone":{"type":"string"},"read1stAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappInteraction not found"}}}},"/whatsapp/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappInteractionById","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappInteraction not found"}}}},"/whatsapp/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappMessage","tags":["Whatsapp Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createWhatsappMessage","tags":["Whatsapp Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"phone":{"type":"string"},"readAt":{"type":"string"},"secret":{"type":"boolean","default":false},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"WhatsappMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappMessage","tags":["Whatsapp Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getWhatsappMessageById","tags":["Whatsapp Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage to get"}],"responses":{"200":{"description":"WhatsappMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappMessageById","tags":["Whatsapp Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"phone":{"type":"string"},"readAt":{"type":"string"},"secret":{"type":"boolean","default":false},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappMessage not found"}}}},"/whatsapp/messages/{id}/status":{"post":{"summary":"Receive message status","operationId":"status","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage"}],"responses":{"201":{"description":"successfully created"}}}},"/whatsapp/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappMessageById","tags":["Whatsapp Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappMessage not found"}}}},"/whatsapp/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappQueue","tags":["Whatsapp Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createWhatsappQueue","tags":["Whatsapp Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"WhatsappQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappQueue","tags":["Whatsapp Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getWhatsappQueueById","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue to get"}],"responses":{"200":{"description":"WhatsappQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappQueueById","tags":["Whatsapp Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueue not found"}}}},"/whatsapp/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappQueueById","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueue not found"}}}},"/whatsapp/reports/queue":{"get":{"summary":"Gets a list of Whatsapp Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappQueueReport","tags":["Whatsapp Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Whatsapp Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Whatsapp Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Whatsapp Queue Report","security":[{"BearerAuth":[]}],"operationId":"createWhatsappQueueReport","tags":["Whatsapp Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Whatsapp Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"WhatsappQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/reports/queue/describe":{"get":{"summary":"Gets table info about Whatsapp Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappQueueReport","tags":["Whatsapp Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/reports/queue/{id}":{"get":{"summary":"Gets a single Whatsapp Queue Report","security":[{"BearerAuth":[]}],"operationId":"getWhatsappQueueReportById","tags":["Whatsapp Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueueReport to get"}],"responses":{"200":{"description":"WhatsappQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueueReport not found"}}},"put":{"summary":"Update an existing Whatsapp Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappQueueReportById","tags":["Whatsapp Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Whatsapp Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueueReport not found"}}}},"/whatsapp/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Whatsapp Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappQueueReportById","tags":["Whatsapp Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueueReport not found"}}}},"/whatsapp/reports/transfer":{"get":{"summary":"Gets a list of Whatsapp Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappTransferReport","tags":["Whatsapp Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Whatsapp Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Whatsapp Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Whatsapp Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createWhatsappTransferReport","tags":["Whatsapp Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Whatsapp Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"]},"transferredAt":{"type":"string"}},"required":["uniqueid","type"]}}}},"responses":{"201":{"description":"WhatsappTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/reports/transfer/describe":{"get":{"summary":"Gets table info about Whatsapp Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappTransferReport","tags":["Whatsapp Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/reports/transfer/{id}":{"get":{"summary":"Gets a single Whatsapp Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getWhatsappTransferReportById","tags":["Whatsapp Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappTransferReport to get"}],"responses":{"200":{"description":"WhatsappTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappTransferReport not found"}}},"put":{"summary":"Update an existing Whatsapp Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappTransferReportById","tags":["Whatsapp Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Whatsapp Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"]},"transferredAt":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappTransferReport not found"}}}},"/whatsapp/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Whatsapp Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappTransferReportById","tags":["Whatsapp Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappTransferReport not found"}}}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"User":{"title":"User","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"fullname":{"type":"string"},"alias":{"type":"string","nullable":true},"email":{"type":"string"},"role":{"type":"string","enum":["admin","user","agent","telephone"]},"password":{"type":"string"},"provider":{"type":"string","nullable":true,"default":"local"},"internal":{"type":"integer","format":"int32"},"salt":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"userpic":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"online":{"type":"boolean","nullable":true,"default":false},"lastLoginAt":{"type":"string","format":"date-time","nullable":true},"voicePause":{"type":"boolean","nullable":true,"default":false},"chatPause":{"type":"boolean","nullable":true,"default":false},"mailPause":{"type":"boolean","nullable":true,"default":false},"faxPause":{"type":"boolean","nullable":true,"default":false},"smsPause":{"type":"boolean","nullable":true,"default":false},"whatsappPause":{"type":"boolean","nullable":true,"default":false},"openchannelPause":{"type":"boolean","nullable":true,"default":false},"pauseType":{"type":"string","nullable":true,"default":"DEFAULT PAUSE"},"lastPauseAt":{"type":"string","format":"date-time","nullable":true},"chatCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"mailCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"faxCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"smsCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"whatsappCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"openchannelCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"phoneBarAutoAnswer":{"type":"boolean","nullable":true,"default":false},"phoneBarEnableSettings":{"type":"boolean","nullable":true,"default":true},"phoneBarListenPort":{"type":"integer","format":"int32","nullable":true,"default":5160},"phoneBarExpires":{"type":"integer","format":"int32","nullable":true,"default":120},"phoneBarRemoteControl":{"type":"boolean","nullable":true,"default":false},"phoneBarRemoteControlPort":{"type":"integer","format":"int32","nullable":true,"default":9888},"phoneBarEnableRecording":{"type":"boolean","nullable":true,"default":false},"phoneBarRingInUse":{"type":"boolean","nullable":true,"default":false},"chanspy":{"type":"boolean","nullable":true,"default":false},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true,"default":"dynamic"},"ipaddr":{"type":"string","nullable":true},"port":{"type":"integer","format":"int32","nullable":true},"regseconds":{"type":"integer","format":"int32","nullable":true},"fullcontact":{"type":"string","nullable":true},"regserver":{"type":"string","nullable":true},"useragent":{"type":"string","nullable":true},"lastms":{"type":"integer","format":"int32","nullable":true},"type":{"type":"string","enum":["friend","user","peer"],"nullable":true,"default":"friend"},"context":{"type":"string","nullable":true,"default":"from-sip"},"callingpres":{"type":"string","enum":["ALLOWED_NOT_SCREENED","ALLOWED_PASSED_SCREEN","ALLOWED_FAILED_SCREEN","ALLOWED","PROHIB_NOT_SCREENED","PROHIB_PASSED_SCREEN","PROHIB_FAILED_SCREEN","PROHIB"],"nullable":true},"deny":{"type":"string","nullable":true},"permit":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"md5secret":{"type":"string","nullable":true},"remotesecret":{"type":"string","nullable":true},"transport":{"type":"string","nullable":true,"default":"udp"},"dtmfmode":{"type":"string","enum":["rfc2833","info","shortinfo","inband","auto"],"nullable":true,"default":"rfc2833"},"directmedia":{"type":"string","enum":["yes","no","nonat","update","outgoing"],"nullable":true,"default":"no"},"directrtpsetup":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"directmediapermit":{"type":"string","nullable":true},"directmediadeny":{"type":"string","nullable":true},"nat":{"type":"string","nullable":true,"default":"force_rport,comedia"},"callgroup":{"type":"string","nullable":true},"namedcallgroup":{"type":"string","nullable":true},"pickupgroup":{"type":"string","nullable":true},"namedpickupgroup":{"type":"string","nullable":true},"language":{"type":"string","nullable":true,"default":"en"},"tonezone":{"type":"string","nullable":true},"disallow":{"type":"string","default":"all"},"allow":{"type":"string","default":"ulaw;alaw;gsm"},"autoframing":{"type":"string","enum":["yes","no"],"nullable":true},"insecure":{"type":"string","nullable":true},"trustrpid":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"trust_id_outbound":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"progressinband":{"type":"string","enum":["yes","no","never"],"nullable":true},"promiscredir":{"type":"string","enum":["yes","no"],"nullable":true},"useclientcode":{"type":"string","enum":["yes","no"],"nullable":true},"accountcode":{"type":"integer","format":"int32","nullable":true},"setvar":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true,"default":"\"\" <>"},"amaflags":{"type":"string","nullable":true},"callcounter":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"busylevel":{"type":"integer","format":"int32","nullable":true},"allowoverlap":{"type":"string","enum":["yes","no"],"nullable":true},"allowsubscribe":{"type":"string","enum":["yes","no"],"nullable":true},"allowtransfer":{"type":"string","enum":["yes","no"],"nullable":true},"ignoresdpversion":{"type":"string","enum":["yes","no"],"nullable":true},"subscribecontext":{"type":"string","nullable":true},"template":{"type":"string","nullable":true},"videosupport":{"type":"string","enum":["yes","no","always"],"nullable":true,"default":"no"},"maxcallbitrate":{"type":"integer","format":"int32","nullable":true},"rfc2833compensate":{"type":"string","enum":["yes","no"],"nullable":true},"mailbox":{"type":"string","nullable":true},"session_timers":{"type":"string","enum":["accept","refuse","originate"],"nullable":true},"session_expires":{"type":"integer","format":"int32","nullable":true},"session_minse":{"type":"integer","format":"int32","nullable":true},"session_refresher":{"type":"string","enum":["uac","uas"],"nullable":true,"default":"uas"},"t38pt_usertpsource":{"type":"string","nullable":true},"regexten":{"type":"string","nullable":true},"fromdomain":{"type":"string","nullable":true},"fromuser":{"type":"string","nullable":true},"qualify":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"keepalive":{"type":"integer","format":"int32","nullable":true},"defaultip":{"type":"string","nullable":true},"defaultuser":{"type":"string","nullable":true},"rtptimeout":{"type":"integer","format":"int32","nullable":true},"rtpholdtimeout":{"type":"integer","format":"int32","nullable":true},"rtpkeepalive":{"type":"integer","format":"int32","nullable":true},"sendrpid":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"outboundproxy":{"type":"string","nullable":true},"callbackextension":{"type":"string","nullable":true},"timert1":{"type":"integer","format":"int32","nullable":true},"timerb":{"type":"integer","format":"int32","nullable":true},"qualifyfreq":{"type":"integer","format":"int32","nullable":true},"contactpermit":{"type":"string","nullable":true},"contactdeny":{"type":"string","nullable":true},"contactacl":{"type":"string","nullable":true},"unsolicited_mailbox":{"type":"string","nullable":true},"use_q850_reason":{"type":"string","nullable":true},"maxforwards":{"type":"integer","format":"int32","nullable":true},"encryption":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"avpf":{"type":"string","enum":["yes","no"],"nullable":true},"force_avp":{"type":"string","enum":["yes","no"],"nullable":true},"icesupport":{"type":"string","enum":["yes","no"],"nullable":true},"dtlsenable":{"type":"string","enum":["yes","no"],"nullable":true},"dtlsverify":{"type":"string","enum":["yes","no","fingerprint","certificate"],"nullable":true},"dtlsrekey":{"type":"integer","format":"int32","nullable":true},"dtlscertfile":{"type":"string","nullable":true},"dtlsprivatekey":{"type":"string","nullable":true},"dtlscipher":{"type":"string","nullable":true},"dtlscafile":{"type":"string","nullable":true},"dtlscapath":{"type":"string","nullable":true},"dtlssetup":{"type":"string","enum":["active","passive","actpass"],"nullable":true},"dtlsfingerprint":{"type":"string","nullable":true},"usereqphone":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"recordonfeature":{"type":"string","nullable":true},"recordofffeature":{"type":"string","nullable":true},"call_limit":{"type":"integer","format":"int32","nullable":true,"default":10},"registertrying":{"type":"string","enum":["yes","no"],"nullable":true},"subscribemwi":{"type":"string","enum":["yes","no"],"nullable":true},"vmexten":{"type":"string","nullable":true},"mohinterpret":{"type":"string","nullable":true},"mohsuggest":{"type":"string","nullable":true},"parkinglot":{"type":"string","nullable":true},"canreinvite":{"type":"string","enum":["yes","no","nonat","update","update,nonat"],"nullable":true,"default":"no"},"loginInPause":{"type":"boolean","nullable":true,"default":false},"resetPasswordToken":{"type":"string","nullable":true},"resetPasswordExpires":{"type":"string","format":"date-time","nullable":true},"passwordResetAt":{"type":"string","format":"date-time","nullable":true,"default":null},"previousPasswords":{"type":"string","nullable":true},"showWebBar":{"type":"integer","format":"int32","nullable":true,"default":0},"permissions":{"type":"string","nullable":true},"phoneBarUnconditionalNumber":{"type":"string","nullable":true},"phoneBarNoReplyNumber":{"type":"string","nullable":true},"phoneBarBusyNumber":{"type":"string","nullable":true},"phoneBarUnconditional":{"type":"boolean","nullable":true,"default":false},"phoneBarNoReply":{"type":"boolean","nullable":true,"default":false},"phoneBarBusy":{"type":"boolean","nullable":true,"default":false},"phoneBarDnd":{"type":"boolean","nullable":true,"default":true},"phoneBarUnansweredCallBadge":{"type":"boolean","nullable":true,"default":true},"phoneBarEnableDtmfTone":{"type":"boolean","nullable":true,"default":false},"phoneBarAutoAnswerDelay":{"type":"integer","format":"int32","nullable":true,"default":0},"extensionMonitor":{"type":"string","nullable":true,"default":""},"crudPermissions":{"type":"integer","format":"int32","nullable":true,"default":0},"rtcp_mux":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"allowmessenger":{"type":"boolean","nullable":true,"default":true},"phoneBarOutboundProxy":{"type":"string","nullable":true},"phoneBarEnableJaws":{"type":"boolean","nullable":true,"default":false},"phoneBarEnableScreenRecordingByAgent":{"type":"boolean","nullable":true,"default":false},"phoneBarEnableVideoRecording":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"phoneBarEnableAutomaticScreenRecording":{"type":"boolean","nullable":true,"default":false},"phoneBarPrefixRequired":{"type":"boolean","nullable":true,"default":false},"hotdesk":{"type":"boolean","nullable":true,"default":false},"interface":{"type":"string","nullable":true,"default":null},"privacyEnabled":{"type":"boolean","nullable":true,"default":false},"apiKeyNonce":{"type":"string","nullable":true},"apiKeyIat":{"type":"string","nullable":true},"screenrecording":{"type":"boolean","nullable":true,"default":false},"blocked":{"type":"boolean","nullable":true,"default":false},"blockedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"loginAttempts":{"type":"integer","format":"int32","nullable":true,"default":0},"disabled":{"type":"boolean","nullable":true,"default":false},"settingsEnabled":{"type":"boolean","nullable":true,"default":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userProfileId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","fullname","email","role","password","provider","internal","online","voicePause","chatPause","mailPause","faxPause","smsPause","whatsappPause","openchannelPause","pauseType","chatCapacity","mailCapacity","faxCapacity","smsCapacity","whatsappCapacity","openchannelCapacity","phoneBarAutoAnswer","phoneBarEnableSettings","phoneBarListenPort","phoneBarExpires","phoneBarRemoteControl","phoneBarRemoteControlPort","phoneBarEnableRecording","phoneBarRingInUse","chanspy","host","type","context","transport","dtmfmode","directmedia","directrtpsetup","nat","language","disallow","allow","trustrpid","trust_id_outbound","callerid","callcounter","videosupport","session_refresher","qualify","sendrpid","encryption","usereqphone","call_limit","canreinvite","loginInPause","passwordResetAt","showWebBar","phoneBarUnconditional","phoneBarNoReply","phoneBarBusy","phoneBarDnd","phoneBarUnansweredCallBadge","phoneBarEnableDtmfTone","phoneBarAutoAnswerDelay","extensionMonitor","crudPermissions","rtcp_mux","allowmessenger","phoneBarEnableJaws","phoneBarEnableScreenRecordingByAgent","phoneBarEnableAutomaticScreenRecording","phoneBarPrefixRequired","hotdesk","interface","privacyEnabled","screenrecording","blocked","blockedAt","loginAttempts","disabled","settingsEnabled","createdAt","updatedAt"]},"VoiceChanSpy":{"title":"VoiceChanSpy","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"prefix":{"type":"string"},"options":{"type":"string","nullable":true},"auth":{"type":"boolean","nullable":true,"default":false},"password":{"type":"string","nullable":true},"record":{"type":"boolean","nullable":true,"default":false},"recordingFormat":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","prefix","auth","record","createdAt","updatedAt"]},"VoiceContext":{"title":"VoiceContext","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"defaultEntry":{"type":"boolean","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","defaultEntry","createdAt","updatedAt"]},"VoiceExtension":{"title":"VoiceExtension","type":"object","properties":{"id":{"type":"integer","format":"int32"},"context":{"type":"string"},"exten":{"type":"string"},"priority":{"type":"string","default":"1"},"tag":{"type":"string","default":"--"},"app":{"type":"string","default":"NoOp"},"appdata":{"type":"string","maxLength":4096,"nullable":true,"default":""},"type":{"type":"string","enum":["inbound","outbound","internal","inbound-fax","outbound-fax","system","any"]},"description":{"type":"string","nullable":true},"interval":{"type":"string","default":"*,*,*,*"},"IntervalId":{"type":"integer","format":"int32","nullable":true},"isApp":{"type":"boolean","default":false},"appType":{"type":"string","nullable":true,"default":null},"callerID":{"type":"string","nullable":true},"record":{"type":"boolean","nullable":true,"default":false},"cutdigits":{"type":"integer","format":"int32","nullable":true},"recordingFormat":{"type":"string","nullable":true,"default":"wav"},"answer":{"type":"boolean","nullable":true,"default":true},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"ChanSpyId":{"type":"integer","format":"int32","nullable":true},"VoiceContextId":{"type":"integer","format":"int32","nullable":true},"VoiceExtensionId":{"type":"integer","format":"int32","nullable":true},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"VoicePrefixId":{"type":"integer","format":"int32","nullable":true}},"required":["id","context","exten","priority","tag","app","appdata","type","interval","isApp","appType","record","recordingFormat","answer","createdAt","updatedAt"]},"VoiceMusicOnHold":{"title":"VoiceMusicOnHold","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"mode":{"type":"string","enum":["custom","files","mp3nb","quietmp3nb","quietmp3","mp3"],"nullable":true,"default":"files"},"directory":{"type":"string","nullable":true},"application":{"type":"string","nullable":true},"digit":{"type":"string","nullable":true},"sort":{"type":"string","nullable":true,"default":"alpha"},"format":{"type":"string","nullable":true},"stamp":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"defaultEntry":{"type":"boolean","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","mode","sort","defaultEntry","createdAt","updatedAt"]},"VoiceQueue":{"title":"VoiceQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["inbound","outbound"],"default":"inbound"},"musiconhold":{"type":"string","nullable":true,"default":"default"},"announce":{"type":"string","nullable":true,"default":""},"strategy":{"type":"string","enum":["rr","ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"],"default":"ringall"},"servicelevel":{"type":"integer","format":"int32","nullable":true,"default":0},"context":{"type":"string","nullable":true,"default":null},"penaltymemberslimit":{"type":"integer","format":"int32","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true,"default":15},"retry":{"type":"integer","format":"int32","nullable":true,"default":2},"timeoutpriority":{"type":"string","nullable":true},"weight":{"type":"integer","format":"int32","nullable":true,"default":0},"wrapuptime":{"type":"integer","format":"int32","nullable":true,"default":0},"autofill":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"autopause":{"type":"string","enum":["yes","no","all"],"nullable":true,"default":"no"},"autopausedelay":{"type":"integer","format":"int32","nullable":true},"autopausebusy":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"autopauseunavail":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"maxlen":{"type":"integer","format":"int32","nullable":true,"default":0},"setinterfacevar":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"setqueueentryvar":{"type":"string","enum":["yes","no"],"nullable":true},"setqueuevar":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"eventmemberstatus":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"membermacro":{"type":"string","nullable":true},"membergosub":{"type":"string","nullable":true},"announce_frequency":{"type":"integer","format":"int32","nullable":true,"default":0},"min_announce_frequency":{"type":"integer","format":"int32","nullable":true,"default":0},"periodic_announce_frequency":{"type":"integer","format":"int32","nullable":true,"default":0},"random_periodic_announce":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"relative_periodic_announce":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"announce_holdtime":{"type":"string","enum":["yes","no","once"],"nullable":true,"default":"no"},"announce_position":{"type":"string","nullable":true,"default":"no"},"announce_to_first_user":{"type":"string","enum":["yes","no"],"nullable":true},"announce_position_limit":{"type":"integer","format":"int32","nullable":true},"announce_round_seconds":{"type":"string","enum":["0","5","10","15","20","30"],"nullable":true,"default":"0"},"monitor_format":{"type":"string","nullable":true,"default":""},"monitor_type":{"type":"string","nullable":true},"queue_youarenext":{"type":"string","nullable":true,"default":null},"queue_thereare":{"type":"string","nullable":true,"default":null},"queue_callswaiting":{"type":"string","nullable":true,"default":null},"queue_holdtime":{"type":"string","nullable":true,"default":null},"queue_minute":{"type":"string","nullable":true,"default":null},"queue_minutes":{"type":"string","nullable":true,"default":null},"queue_seconds":{"type":"string","nullable":true,"default":null},"queue_thankyou":{"type":"string","nullable":true,"default":null},"queue_reporthold":{"type":"string","nullable":true},"queue_quantity1":{"type":"string","nullable":true},"queue_quantity2":{"type":"string","nullable":true},"queue_periodic_announce":{"type":"string","nullable":true},"queue_less_than":{"type":"string","nullable":true},"periodic_announce":{"type":"string","nullable":true},"joinempty":{"type":"string","nullable":true,"default":"yes"},"leavewhenempty":{"type":"string","nullable":true,"default":"no"},"reportholdtime":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"ringinuse":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"memberdelay":{"type":"integer","format":"int32","nullable":true,"default":0},"timeoutrestart":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"defaultrule":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"acw":{"type":"boolean","nullable":true,"default":0},"acwTimeout":{"type":"integer","format":"int32","nullable":true,"default":10},"dialActive":{"type":"boolean","nullable":true,"default":0},"dialMethod":{"type":"string","enum":["preview","progressive","power","predictive","booked"],"nullable":true,"default":"progressive"},"dialLimitChannel":{"type":"integer","format":"int32","nullable":true,"default":0},"dialLimitQueue":{"type":"integer","format":"int32","nullable":true,"default":0},"dialPowerLevel":{"type":"number","format":"float","nullable":true,"default":1},"dialPredictiveOptimization":{"type":"string","enum":["agentBusyFactor","dropRate"],"nullable":true,"default":"dropRate"},"dialPredictiveOptimizationPercentage":{"type":"number","format":"float","nullable":true,"default":3},"dialPredictiveInterval":{"type":"integer","format":"int32","nullable":true,"default":10},"dialOriginateCallerIdName":{"type":"string","nullable":true},"dialOriginateCallerIdNumber":{"type":"string","nullable":true},"dialOriginateTimeout":{"type":"integer","format":"int32","nullable":true,"default":30},"dialQueueOptions":{"type":"string","nullable":true,"default":"tTxX"},"dialQueueTimeout":{"type":"integer","format":"int32","nullable":true,"default":3},"dialQueueProject":{"type":"string","nullable":true},"dialCongestionMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialCongestionRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialBusyMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialBusyRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialNoAnswerMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialNoAnswerRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialGlobalMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":4},"dialTimezone":{"type":"string","nullable":true,"default":null},"dialGlobalInterval":{"type":"string","nullable":true,"default":"07:00-22:00,*,*,*"},"dialPrefix":{"type":"string","nullable":true,"default":null},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"nullable":true,"default":"always"},"dialAMDActive":{"type":"boolean","nullable":true,"default":0},"dialAMDInitialSilence":{"type":"integer","format":"int32","nullable":true,"default":2500},"dialAMDGreeting":{"type":"integer","format":"int32","nullable":true,"default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","format":"int32","nullable":true,"default":800},"dialAMDTotalAnalysisTime":{"type":"integer","format":"int32","nullable":true,"default":5000},"dialAMDMinWordLength":{"type":"integer","format":"int32","nullable":true,"default":100},"dialAMDBetweenWordsSilence":{"type":"integer","format":"int32","nullable":true,"default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAMDSilenceThreshold":{"type":"integer","format":"int32","nullable":true,"default":256},"dialAMDMaximumWordLength":{"type":"integer","format":"int32","nullable":true,"default":5000},"dialRecallMeTimeout":{"type":"integer","format":"int32","nullable":true,"default":30},"dialRecallInQueue":{"type":"boolean","nullable":true,"default":0},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"nullable":true,"default":"DESC"},"dialQueueProject2":{"type":"string","nullable":true},"dialAgiAfterHangupClient":{"type":"boolean","nullable":true,"default":false},"dialAgiAfterHangupAgent":{"type":"boolean","nullable":true,"default":false},"dialRandomLastDigitCallerIdNumber":{"type":"integer","format":"int32","nullable":true,"default":0},"dialCutDigit":{"type":"integer","format":"int32","nullable":true,"default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialDropMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialDropRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialAbandonedMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAbandonedRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialMachineMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialMachineRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialAgentRejectMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAgentRejectRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"dialPredictiveIntervalMaxThreshold":{"type":"integer","format":"int32","nullable":true,"default":20},"dialPredictiveIntervalMinThreshold":{"type":"integer","format":"int32","nullable":true,"default":10},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TrunkId":{"type":"integer","format":"int32","nullable":true},"TrunkBackupId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","type","musiconhold","announce","strategy","servicelevel","context","timeout","retry","weight","wrapuptime","autofill","autopause","autopausebusy","autopauseunavail","maxlen","setinterfacevar","setqueuevar","eventmemberstatus","announce_frequency","min_announce_frequency","periodic_announce_frequency","random_periodic_announce","relative_periodic_announce","announce_holdtime","announce_position","announce_round_seconds","monitor_format","queue_youarenext","queue_thereare","queue_callswaiting","queue_holdtime","queue_minute","queue_minutes","queue_seconds","queue_thankyou","joinempty","leavewhenempty","reportholdtime","ringinuse","memberdelay","timeoutrestart","acw","acwTimeout","dialActive","dialMethod","dialLimitChannel","dialLimitQueue","dialPowerLevel","dialPredictiveOptimization","dialPredictiveOptimizationPercentage","dialPredictiveInterval","dialOriginateTimeout","dialQueueOptions","dialQueueTimeout","dialCongestionMaxRetry","dialCongestionRetryFrequency","dialBusyMaxRetry","dialBusyRetryFrequency","dialNoAnswerMaxRetry","dialNoAnswerRetryFrequency","dialGlobalMaxRetry","dialTimezone","dialGlobalInterval","dialPrefix","dialCheckDuplicateType","dialAMDActive","dialAMDInitialSilence","dialAMDGreeting","dialAMDAfterGreetingSilence","dialAMDTotalAnalysisTime","dialAMDMinWordLength","dialAMDBetweenWordsSilence","dialAMDMaximumNumberOfWords","dialAMDSilenceThreshold","dialAMDMaximumWordLength","dialRecallMeTimeout","dialRecallInQueue","dialOrderByScheduledAt","dialAgiAfterHangupClient","dialAgiAfterHangupAgent","dialRandomLastDigitCallerIdNumber","dialCutDigit","dialNoSuchNumberMaxRetry","dialNoSuchNumberRetryFrequency","dialDropMaxRetry","dialDropRetryFrequency","dialAbandonedMaxRetry","dialAbandonedRetryFrequency","dialMachineMaxRetry","dialMachineRetryFrequency","dialAgentRejectMaxRetry","dialAgentRejectRetryFrequency","mandatoryDisposition","dialPredictiveIntervalMaxThreshold","dialPredictiveIntervalMinThreshold","createdAt","updatedAt"]},"VoiceRecording":{"title":"VoiceRecording","type":"object","properties":{"id":{"type":"integer","format":"int32"},"format":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"uniqueid":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"rating":{"type":"integer","format":"int32","nullable":true},"queue":{"type":"string","nullable":true},"userDisposition":{"type":"string","nullable":true},"userSecondDisposition":{"type":"string","nullable":true},"userThirdDisposition":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"transcribeName":{"type":"string","nullable":true},"transcribeStatus":{"type":"string","nullable":true,"default":"NEW"},"fileUri":{"type":"string","nullable":true},"fileText":{"type":"string","nullable":true},"failureReason":{"type":"string","nullable":true},"sentiment":{"type":"string","nullable":true},"sPositive":{"type":"number","format":"float","nullable":true},"sNegative":{"type":"number","format":"float","nullable":true},"sNeutral":{"type":"number","format":"float","nullable":true},"sMixed":{"type":"number","format":"float","nullable":true},"tempSentiment":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true}},"required":["id","transcribeStatus","tempSentiment"]},"ScreenRecording":{"title":"ScreenRecording","type":"object","properties":{"id":{"type":"integer","format":"int32"},"format":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"interactionid":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"rating":{"type":"integer","format":"int32","nullable":true},"duration":{"type":"integer","format":"int32","nullable":true},"startedAt":{"type":"string","format":"date-time","nullable":true},"closedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true}},"required":["id"]},"VoiceMail":{"title":"VoiceMail","type":"object","properties":{"id":{"type":"integer","format":"int32"},"customer_id":{"type":"string","nullable":true},"context":{"type":"string","nullable":true,"default":"from-voicemail"},"mailbox":{"type":"string","default":""},"password":{"type":"string","nullable":true},"fullname":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"pager":{"type":"string","nullable":true},"tz":{"type":"string","nullable":true,"default":"central"},"attach":{"type":"string","enum":["yes","no"],"default":"yes"},"saycid":{"type":"string","enum":["yes","no"],"default":"yes"},"dialout":{"type":"string","nullable":true},"callback":{"type":"string","nullable":true},"review":{"type":"string","enum":["yes","no"],"default":"no"},"operator":{"type":"string","enum":["yes","no"],"default":"no"},"envelope":{"type":"string","enum":["yes","no"],"default":"no"},"sayduration":{"type":"string","enum":["yes","no"],"default":"no"},"saydurationm":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"default":1},"sendvoicemail":{"type":"string","enum":["yes","no"],"default":"no"},"delete":{"type":"string","enum":["yes","no"],"default":"no"},"nextaftercmd":{"type":"string","enum":["yes","no"],"default":"yes"},"forcename":{"type":"string","enum":["yes","no"],"default":"no"},"forcegreetings":{"type":"string","enum":["yes","no"],"default":"no"},"hidefromdir":{"type":"string","enum":["yes","no"],"default":"yes"},"stamp":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"emailsubject":{"type":"string","nullable":true},"emailbody":{"type":"string","nullable":true},"maxsecs":{"type":"integer","format":"int32","default":180},"maxmsg":{"type":"integer","format":"int32","default":100},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true}},"required":["id","context","mailbox","tz","attach","saycid","review","operator","envelope","sayduration","saydurationm","sendvoicemail","delete","nextaftercmd","forcename","forcegreetings","hidefromdir","maxsecs","maxmsg","createdAt","updatedAt"]},"VoiceMailMessage":{"title":"VoiceMailMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"msgnum":{"type":"integer","format":"int32","default":0},"dir":{"type":"string","nullable":true,"default":""},"context":{"type":"string","nullable":true,"default":""},"macrocontext":{"type":"string","nullable":true,"default":""},"callerid":{"type":"string","nullable":true,"default":""},"origtime":{"type":"string","nullable":true,"default":""},"duration":{"type":"string","nullable":true,"default":""},"mailboxuser":{"type":"string","nullable":true,"default":""},"mailboxcontext":{"type":"string","nullable":true,"default":""},"recording":{"type":"string","format":"byte","nullable":true,"default":null},"flag":{"type":"string","nullable":true,"default":""},"msg_id":{"type":"string","nullable":true,"default":""},"stamp":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]}},"required":["id","msgnum","dir","context","macrocontext","callerid","origtime","duration","mailboxuser","mailboxcontext","recording","flag","msg_id","stamp"]},"VoiceCallReport":{"title":"VoiceCallReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string","nullable":true},"type":{"type":"string","enum":["inbound","internal","outbound","inbound-fax","outbound-fax","dialer"],"nullable":true},"tag":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"destination":{"type":"string","nullable":true},"destinationcontext":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"destinationchannel":{"type":"string","nullable":true},"lastapplication":{"type":"string","nullable":true},"lastdata":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"systemanswertime":{"type":"string","format":"date-time","nullable":true},"answertime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"duration":{"type":"integer","format":"int32","nullable":true},"billableseconds":{"type":"integer","format":"int32","nullable":true},"mohtime":{"type":"integer","format":"int32","nullable":true,"default":0},"disposition":{"type":"string","nullable":true},"amaflags":{"type":"string","nullable":true},"userfield":{"type":"string","nullable":true},"userDisposition":{"type":"string","nullable":true},"userSecondDisposition":{"type":"string","nullable":true},"userThirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"prefix":{"type":"string","nullable":true},"routeid":{"type":"integer","format":"int32","nullable":true},"sipcallid":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","mohtime","createdAt","updatedAt"]},"VoiceDialReport":{"title":"VoiceDialReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"privilege":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"channelstate":{"type":"integer","format":"int32","nullable":true},"channelstatedesc":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"priority":{"type":"integer","format":"int32","nullable":true},"uniqueid":{"type":"string","nullable":true},"linkedid":{"type":"string","nullable":true},"destchannel":{"type":"string","nullable":true},"destchannelstate":{"type":"integer","format":"int32","nullable":true},"destchannelstatedesc":{"type":"string","nullable":true},"destcalleridnum":{"type":"string","nullable":true},"destcalleridname":{"type":"string","nullable":true},"destconnectedlinenum":{"type":"string","nullable":true},"destconnectedlinename":{"type":"string","nullable":true},"destlanguage":{"type":"string","nullable":true},"destaccountcode":{"type":"string","nullable":true},"destcontext":{"type":"string","nullable":true},"destexten":{"type":"string","nullable":true},"destpriority":{"type":"integer","format":"int32","nullable":true},"destuniqueid":{"type":"string","nullable":true},"destlinkedid":{"type":"string","nullable":true},"dialstring":{"type":"string","nullable":true},"dialstatus":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"answertime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"lastevent":{"type":"string","nullable":true},"routeId":{"type":"integer","format":"int32","nullable":true},"duration":{"type":"integer","format":"int32","nullable":true},"holdtime":{"type":"integer","format":"int32","nullable":true},"billableseconds":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"VoiceAgentReport":{"title":"VoiceAgentReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"interface":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"agentcalledAt":{"type":"string","format":"date-time","nullable":true},"agentconnectAt":{"type":"string","format":"date-time","nullable":true},"agentcompleteAt":{"type":"string","format":"date-time","nullable":true},"agentringnoanswerAt":{"type":"string","format":"date-time","nullable":true},"agentdumpAt":{"type":"string","format":"date-time","nullable":true},"holdtime":{"type":"integer","format":"int32","nullable":true},"agentcomplete":{"type":"boolean","nullable":true,"default":false},"agentringnoanswer":{"type":"boolean","nullable":true,"default":false},"agentdump":{"type":"boolean","nullable":true,"default":false},"talktime":{"type":"integer","format":"int32","nullable":true},"agentacw":{"type":"boolean","nullable":true,"default":false},"acwtime":{"type":"integer","format":"int32","nullable":true},"reason":{"type":"string","nullable":true},"lastevent":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"channelstate":{"type":"integer","format":"int32","nullable":true},"channelstatedesc":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"destchannel":{"type":"string","nullable":true},"destchannelstate":{"type":"integer","format":"int32","nullable":true},"destchannelstatedesc":{"type":"string","nullable":true},"destcalleridnum":{"type":"string","nullable":true},"destcalleridname":{"type":"string","nullable":true},"destconnectedlinenum":{"type":"string","nullable":true},"destconnectedlinename":{"type":"string","nullable":true},"destlanguage":{"type":"string","nullable":true},"destaccountcode":{"type":"string","nullable":true},"destcontext":{"type":"string","nullable":true},"destexten":{"type":"string","nullable":true},"destpriority":{"type":"string","nullable":true},"destuniqueid":{"type":"string","nullable":true},"answeredelsewheredestinationuniqueid":{"type":"string","nullable":true},"answeredelsewheremembername":{"type":"string","nullable":true},"transfer":{"type":"boolean","nullable":true,"default":false},"transfertype":{"type":"string","nullable":true},"transferexten":{"type":"string","nullable":true},"transferuniqueid":{"type":"string","nullable":true},"agententerreason":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","agentcomplete","agentringnoanswer","agentdump","agentacw","transfer","agententerreason","createdAt","updatedAt"]},"VoiceQueueReport":{"title":"VoiceQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"queuecallerjoinAt":{"type":"string","format":"date-time","nullable":true},"queuecallerleaveAt":{"type":"string","format":"date-time","nullable":true},"position":{"type":"integer","format":"int32","nullable":true},"count":{"type":"integer","format":"int32","nullable":true},"queuecallerabandon":{"type":"boolean","nullable":true,"default":false},"queuecallerabandonAt":{"type":"string","format":"date-time","nullable":true},"queuecallercomplete":{"type":"boolean","nullable":true,"default":false},"queuecallercompleteAt":{"type":"string","format":"date-time","nullable":true},"queuecallerexit":{"type":"boolean","nullable":true,"default":false},"queuecallerexitAt":{"type":"string","format":"date-time","nullable":true},"queuecallerexitreason":{"type":"string","nullable":true},"originalposition":{"type":"integer","format":"int32","nullable":true},"channel":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"holdtime":{"type":"integer","format":"int32","nullable":true},"mohtime":{"type":"integer","format":"int32","nullable":true,"default":0},"assigned":{"type":"boolean","nullable":true,"default":false},"lastAssignedTo":{"type":"string","nullable":true},"transfer":{"type":"boolean","nullable":true,"default":false},"transfertype":{"type":"string","nullable":true},"transferexten":{"type":"string","nullable":true},"transferuniqueid":{"type":"string","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"queuecallerenterreason":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","queuecallerabandon","queuecallercomplete","queuecallerexit","mohtime","assigned","transfer","queuecallerenterreason","createdAt","updatedAt"]},"MemberReport":{"title":"MemberReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"channel":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"interface":{"type":"string","nullable":true},"type":{"type":"string","nullable":true,"default":"DEFAULT PAUSE"},"duration":{"type":"integer","format":"int32","nullable":true},"enterAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"data1":{"type":"string","nullable":true},"data2":{"type":"string","nullable":true},"data3":{"type":"string","nullable":true},"data4":{"type":"string","nullable":true},"data5":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"internal":{"type":"integer","format":"int32","nullable":true},"uniqueid":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","createdAt","updatedAt"]},"Trunk":{"title":"Trunk","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["friend","user","peer"],"default":"friend"},"context":{"type":"string","default":"from-voip-provider"},"callingpres":{"type":"string","enum":["ALLOWED_NOT_SCREENED","ALLOWED_PASSED_SCREEN","ALLOWED_FAILED_SCREEN","ALLOWED","PROHIB_NOT_SCREENED","PROHIB_PASSED_SCREEN","PROHIB_FAILED_SCREEN","PROHIB"],"nullable":true},"deny":{"type":"string","nullable":true},"permit":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"md5secret":{"type":"string","nullable":true},"remotesecret":{"type":"string","nullable":true},"transport":{"type":"string","nullable":true,"default":"udp"},"dtmfmode":{"type":"string","enum":["rfc2833","info","shortinfo","inband","auto"],"nullable":true,"default":"rfc2833"},"directmedia":{"type":"string","enum":["yes","no","nonat","update","outgoing"],"nullable":true,"default":"no"},"directrtpsetup":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"directmediapermit":{"type":"string","nullable":true},"directmediadeny":{"type":"string","nullable":true},"nat":{"type":"string","nullable":true,"default":"force_rport,comedia"},"callgroup":{"type":"string","nullable":true},"namedcallgroup":{"type":"string","nullable":true},"pickupgroup":{"type":"string","nullable":true},"namedpickupgroup":{"type":"string","nullable":true},"language":{"type":"string","nullable":true,"default":"en"},"tonezone":{"type":"string","nullable":true},"disallow":{"type":"string","nullable":true,"default":"all"},"allow":{"type":"string","default":"ulaw;alaw;gsm"},"autoframing":{"type":"string","enum":["yes","no"],"nullable":true},"insecure":{"type":"string","nullable":true,"default":"port,invite"},"trustrpid":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"trust_id_outbound":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"progressinband":{"type":"string","enum":["yes","no","never"],"nullable":true},"promiscredir":{"type":"string","enum":["yes","no"],"nullable":true},"useclientcode":{"type":"string","enum":["yes","no"],"nullable":true},"accountcode":{"type":"integer","format":"int32","nullable":true},"setvar":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true,"default":"\"\" <>"},"amaflags":{"type":"string","nullable":true},"callcounter":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"busylevel":{"type":"integer","format":"int32","nullable":true},"allowoverlap":{"type":"string","enum":["yes","no"],"nullable":true},"allowsubscribe":{"type":"string","enum":["yes","no"],"nullable":true},"allowtransfer":{"type":"string","enum":["yes","no"],"nullable":true},"ignoresdpversion":{"type":"string","enum":["yes","no"],"nullable":true},"subscribecontext":{"type":"string","nullable":true},"template":{"type":"string","nullable":true},"videosupport":{"type":"string","enum":["yes","no","always"],"nullable":true,"default":"no"},"maxcallbitrate":{"type":"integer","format":"int32","nullable":true},"rfc2833compensate":{"type":"string","enum":["yes","no"],"nullable":true},"mailbox":{"type":"string","nullable":true},"session_timers":{"type":"string","enum":["accept","refuse","originate"],"nullable":true},"session_expires":{"type":"integer","format":"int32","nullable":true},"session_minse":{"type":"integer","format":"int32","nullable":true},"session_refresher":{"type":"string","enum":["uac","uas"],"nullable":true,"default":"uas"},"t38pt_usertpsource":{"type":"string","nullable":true},"regexten":{"type":"string","nullable":true},"fromdomain":{"type":"string","nullable":true},"fromuser":{"type":"string","nullable":true},"port":{"type":"integer","format":"int32","nullable":true},"qualify":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"keepalive":{"type":"integer","format":"int32","nullable":true},"defaultip":{"type":"string","nullable":true},"defaultuser":{"type":"string","nullable":true},"rtptimeout":{"type":"integer","format":"int32","nullable":true},"rtpholdtimeout":{"type":"integer","format":"int32","nullable":true},"rtpkeepalive":{"type":"integer","format":"int32","nullable":true},"sendrpid":{"type":"string","enum":["yes","no","pai"],"nullable":true,"default":"no"},"outboundproxy":{"type":"string","nullable":true},"callbackextension":{"type":"string","nullable":true},"timert1":{"type":"integer","format":"int32","nullable":true},"timerb":{"type":"integer","format":"int32","nullable":true},"qualifyfreq":{"type":"integer","format":"int32","nullable":true},"contactpermit":{"type":"string","nullable":true},"contactdeny":{"type":"string","nullable":true},"contactacl":{"type":"string","nullable":true},"unsolicited_mailbox":{"type":"string","nullable":true},"use_q850_reason":{"type":"string","nullable":true},"maxforwards":{"type":"integer","format":"int32","nullable":true},"encryption":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"avpf":{"type":"string","enum":["yes","no"],"nullable":true},"force_avp":{"type":"string","enum":["yes","no"],"nullable":true},"icesupport":{"type":"string","enum":["yes","no"],"nullable":true},"dtlsenable":{"type":"string","enum":["yes","no"],"nullable":true},"dtlsverify":{"type":"string","enum":["yes","no","fingerprint","certificate"],"nullable":true},"dtlsrekey":{"type":"integer","format":"int32","nullable":true},"dtlscertfile":{"type":"string","nullable":true},"dtlsprivatekey":{"type":"string","nullable":true},"dtlscipher":{"type":"string","nullable":true},"dtlscafile":{"type":"string","nullable":true},"dtlscapath":{"type":"string","nullable":true},"dtlssetup":{"type":"string","enum":["active","passive","actpass"],"nullable":true},"dtlsfingerprint":{"type":"string","nullable":true},"usereqphone":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"recordonfeature":{"type":"string","nullable":true},"recordofffeature":{"type":"string","nullable":true},"call_limit":{"type":"integer","format":"int32","nullable":true,"default":1000},"registertrying":{"type":"string","enum":["yes","no"],"nullable":true},"subscribemwi":{"type":"string","enum":["yes","no"],"nullable":true},"vmexten":{"type":"string","nullable":true},"mohinterpret":{"type":"string","nullable":true},"mohsuggest":{"type":"string","nullable":true},"parkinglot":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true,"default":"dynamic"},"canreinvite":{"type":"string","enum":["yes","no","nonat","update","update,nonat"],"nullable":true,"default":"no"},"registry":{"type":"string","nullable":true},"otherFields":{"type":"string","nullable":true},"active":{"type":"boolean","default":true},"t38pt_udptl":{"type":"string","nullable":true,"default":"no"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","type","context","transport","dtmfmode","directmedia","directrtpsetup","nat","language","disallow","allow","insecure","trustrpid","trust_id_outbound","callerid","callcounter","videosupport","session_refresher","qualify","sendrpid","encryption","usereqphone","call_limit","host","canreinvite","active","t38pt_udptl","createdAt","updatedAt"]},"VoiceTransferReport":{"title":"VoiceTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["blind","attended"],"nullable":true},"result":{"type":"string","nullable":true},"transfererchannel":{"type":"string","nullable":true},"transferercalleridnum":{"type":"string","nullable":true},"transferercalleridname":{"type":"string","nullable":true},"transfererconnectedlinenum":{"type":"string","nullable":true},"transfererconnectedlinename":{"type":"string","nullable":true},"transfereraccountcode":{"type":"string","nullable":true},"transferercontext":{"type":"string","nullable":true},"transfererexten":{"type":"string","nullable":true},"transfererlinkedid":{"type":"string","nullable":true},"transfereechannel":{"type":"string","nullable":true},"transfereecalleridnum":{"type":"string","nullable":true},"transfereecalleridname":{"type":"string","nullable":true},"transfereeconnectedlinenum":{"type":"string","nullable":true},"transfereeconnectedlinename":{"type":"string","nullable":true},"transfereeaccountcode":{"type":"string","nullable":true},"transfereecontext":{"type":"string","nullable":true},"transfereeexten":{"type":"string","nullable":true},"transfereelinkedid":{"type":"string","nullable":true},"isexternal":{"type":"string","enum":["Yes","No"],"nullable":true},"context":{"type":"string","nullable":true},"extension":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"UserVoiceQueueRt":{"title":"UserVoiceQueueRt","type":"object","properties":{"uniqueid":{"type":"integer","format":"int32","nullable":true},"membername":{"type":"string"},"UserId":{"type":"integer","format":"int32"},"queue_name":{"type":"string"},"VoiceQueueId":{"type":"integer","format":"int32"},"interface":{"type":"string"},"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"paused":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["membername","UserId","queue_name","VoiceQueueId","interface","penalty","paused","createdAt","updatedAt"]},"UserVoiceQueue":{"title":"UserVoiceQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserChatQueue":{"title":"UserChatQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"ChatQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserMailQueue":{"title":"UserMailQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"MailQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserFaxQueue":{"title":"UserFaxQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"assigned":{"type":"integer","format":"int32","nullable":true,"default":0},"queue":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"FaxQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","assigned","createdAt","updatedAt"]},"UserSmsQueue":{"title":"UserSmsQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"SmsQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserOpenchannelQueue":{"title":"UserOpenchannelQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"OpenchannelQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserWhatsappQueue":{"title":"UserWhatsappQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"WhatsappQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"MailServerIn":{"title":"MailServerIn","type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true},"authentication":{"type":"boolean","nullable":true,"default":true},"user":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"port":{"type":"integer","format":"int32","nullable":true},"tls":{"type":"boolean","nullable":true,"default":true},"mailbox":{"type":"string","nullable":true,"default":"INBOX"},"connTimeout":{"type":"integer","format":"int32","nullable":true,"default":10},"authTimeout":{"type":"integer","format":"int32","nullable":true,"default":5},"service":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","authentication","tls","mailbox","connTimeout","authTimeout","createdAt","updatedAt"]},"MailServerOut":{"title":"MailServerOut","type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true},"user":{"type":"string","nullable":true},"pass":{"type":"string","nullable":true},"port":{"type":"integer","format":"int32","nullable":true},"secure":{"type":"boolean","nullable":true,"default":false},"service":{"type":"string","nullable":true},"authentication":{"type":"boolean","nullable":true,"default":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","secure","authentication","createdAt","updatedAt"]},"MailAccount":{"title":"MailAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"name":{"type":"string"},"service":{"type":"boolean","nullable":true,"default":false},"email":{"type":"string","nullable":true},"active":{"type":"boolean","nullable":true,"default":true},"key":{"type":"string"},"template":{"type":"string","nullable":true},"markAsUnread":{"type":"boolean","nullable":true,"default":false},"fontFamily":{"type":"string","default":"Arial,Helvetica,sans-serif"},"fontSize":{"type":"integer","format":"int32","nullable":true,"default":13},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true,"default":null},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true},"TemplateId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","service","active","key","markAsUnread","fontFamily","fontSize","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDispositionPauseId","mandatoryDisposition","createdAt","updatedAt"]},"MailQueue":{"title":"MailQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"MailSubstatus":{"title":"MailSubstatus","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"MailInteraction":{"title":"MailInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"inReplyTo":{"type":"string","maxLength":510,"nullable":true},"to":{"type":"string","nullable":true},"cc":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"attach":{"type":"boolean","nullable":true,"default":false},"read1stAt":{"type":"string","format":"date-time","nullable":true},"substatus":{"type":"string","maxLength":60,"nullable":true},"substatusAt":{"type":"string","format":"date-time","nullable":true},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgBody":{"type":"string","nullable":true},"lastMsgText":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","attach","firstMsgDirection","lastMsgDirection","createdAt","updatedAt"]},"MailMessage":{"title":"MailMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"plainBody":{"type":"string","nullable":true},"read":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string","maxLength":510,"nullable":true},"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true},"cc":{"type":"string","nullable":true},"bcc":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"sentAt":{"type":"string","format":"date-time","nullable":true},"attach":{"type":"integer","format":"int32","nullable":true,"default":0},"secret":{"type":"boolean","nullable":true,"default":false},"readAt":{"type":"string","format":"date-time","nullable":true},"originTo":{"type":"string","nullable":true},"originCc":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"MailInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","direction","attach","secret","createdAt","updatedAt"]},"MailApplication":{"title":"MailApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"MailQueueId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"MailQueueReport":{"title":"MailQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"MailInteractionId":{"type":"integer","format":"int32","nullable":true},"MailMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"MailQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"Dashboard":{"title":"Dashboard","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"DashboardItem":{"title":"DashboardItem","type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string","maxLength":20},"attrs":{"type":"string","nullable":true},"sizeX":{"type":"integer","format":"int32","default":1},"sizeY":{"type":"integer","format":"int32","default":1},"row":{"type":"integer","format":"int32","nullable":true},"col":{"type":"integer","format":"int32","nullable":true},"background":{"type":"string","default":"#ffffff"},"foreground":{"type":"string","default":"#2196f3"},"link":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"DashboardId":{"type":"integer","format":"int32","nullable":true}},"required":["id","title","type","sizeX","sizeY","background","foreground","createdAt","updatedAt"]},"FaxAccount":{"title":"FaxAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"ecm":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"headerinfo":{"type":"string","nullable":true,"default":"xCALLY Motion Fax"},"localstationid":{"type":"string","nullable":true},"minrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"nullable":true,"default":"4800"},"maxrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"nullable":true,"default":"14400"},"modem":{"type":"string","nullable":true,"default":"v17,v27,v29"},"gateway":{"type":"string","nullable":true,"default":"no"},"faxdetect":{"type":"string","nullable":true,"default":"no"},"t38timeout":{"type":"integer","format":"int32","nullable":true,"default":5000},"tech":{"type":"string","enum":["SIP","IAX","DADHI","KHOMP"],"nullable":true,"default":"SIP"},"key":{"type":"string"},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true,"default":null},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TrunkId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","ecm","headerinfo","minrate","maxrate","modem","gateway","faxdetect","t38timeout","tech","key","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDispositionPauseId","mandatoryDisposition","createdAt","updatedAt"]},"FaxApplication":{"title":"FaxApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"FaxQueueId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"FaxInteraction":{"title":"FaxInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"fax":{"type":"string","nullable":true},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","firstMsgDirection","lastMsgDirection","createdAt","updatedAt"]},"FaxMessage":{"title":"FaxMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"failMessage":{"type":"string","nullable":true,"default":null},"readAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"FaxInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"AttachmentId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","direction","failMessage","createdAt","updatedAt"]},"FaxQueue":{"title":"FaxQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"lastAgent":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","timeout","strategy","lastAgent","createdAt","updatedAt"]},"FaxQueueReport":{"title":"FaxQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"FaxInteractionId":{"type":"integer","format":"int32","nullable":true},"FaxMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"FaxQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"SmsAccount":{"title":"SmsAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"type":{"type":"string","enum":["twilio","skebby","connectel","clicksend","plivo","clickatell","csc","infobip","intelepeer"],"nullable":true},"accountSid":{"type":"string","nullable":true},"authId":{"type":"string","nullable":true},"authToken":{"type":"string","nullable":true},"smsMethod":{"type":"string","enum":["SI","TI","GP"],"nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"apiKey":{"type":"string","nullable":true},"senderString":{"type":"string","nullable":true},"deliveryReport":{"type":"boolean","nullable":true,"default":false},"description":{"type":"string","nullable":true},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"baseUrl":{"type":"string","nullable":true},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","key","remote","token","deliveryReport","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDisposition","createdAt","updatedAt"]},"SmsApplication":{"title":"SmsApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"SmsQueueId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"SmsInteraction":{"title":"SmsInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","firstMsgDirection","lastMsgDirection","createdAt","updatedAt"]},"SmsMessage":{"title":"SmsMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string","maxLength":190,"nullable":true},"phone":{"type":"string","nullable":true},"readAt":{"type":"string","format":"date-time","nullable":true},"secret":{"type":"boolean","nullable":true,"default":false},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"SmsInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","direction","secret","createdAt","updatedAt"]},"SmsQueue":{"title":"SmsQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"OpenchannelAccount":{"title":"OpenchannelAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"replyUri":{"type":"string","nullable":true},"key":{"type":"string"},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"mapKey":{"type":"string","nullable":true},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true,"default":null},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","token","key","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDispositionPauseId","mandatoryDisposition","createdAt","updatedAt"]},"OpenchannelApplication":{"title":"OpenchannelApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"OpenchannelQueueId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"OpenchannelInteraction":{"title":"OpenchannelInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"threadId":{"type":"string","nullable":true},"externalUrl":{"type":"string","nullable":true},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"from":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","lastMsgDirection","createdAt","updatedAt"]},"OpenchannelMessage":{"title":"OpenchannelMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"secret":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string","format":"date-time","nullable":true},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"OpenchannelInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"AttachmentId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","secret","direction","createdAt","updatedAt"]},"OpenchannelQueue":{"title":"OpenchannelQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"ChatWebsite":{"title":"ChatWebsite","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"address":{"type":"string"},"description":{"type":"string","nullable":true},"mapKey":{"type":"string","nullable":true,"default":"email"},"mapKeyOffline":{"type":"string","nullable":true,"default":"email"},"key":{"type":"string"},"agentAlias":{"type":"string","nullable":true,"default":"Agent"},"customerAlias":{"type":"string","nullable":true,"default":"Me"},"color":{"type":"string","default":"#011F6A"},"color_button":{"type":"string","default":"#011F6A"},"textColor":{"type":"string","default":"#ffffff"},"fontSize":{"type":"integer","format":"int32","nullable":true,"default":15},"remote":{"type":"string","nullable":true},"animation":{"type":"boolean","nullable":true,"default":true},"header_shape":{"type":"string","enum":["rounded","squared"],"nullable":true,"default":"rounded"},"header_online":{"type":"string","nullable":true,"default":"We are here!"},"start_chat_button":{"type":"string","nullable":true,"default":"Chat"},"offline_chat_button":{"type":"string","nullable":true,"default":"Send"},"header_offline":{"type":"string","nullable":true,"default":"Contact us"},"download_transcript":{"type":"boolean","nullable":true,"default":true},"timeout":{"type":"integer","format":"int32","nullable":true,"default":0},"whiteLabel":{"type":"string","nullable":true,"default":"Powered by xCALLY"},"defaultWhiteLabel":{"type":"boolean","nullable":true,"default":true},"sitepic":{"type":"string","nullable":true},"closingQuestion":{"type":"string","nullable":true,"default":"Do you want to close the interaction?"},"formSubmitSuccessMessage":{"type":"string","nullable":true,"default":"Form properly submitted"},"formSubmitFailureMessage":{"type":"string","nullable":true,"default":"Form submission error"},"noteTitle":{"type":"string","nullable":true,"default":"Note"},"placeholderMessage":{"type":"string","nullable":true,"default":"Type a message"},"closingMessage":{"type":"string","nullable":true,"default":"Thanks you for your time!"},"closingMessageButton":{"type":"string","nullable":true,"default":"Send"},"skipMessageButton":{"type":"string","nullable":true,"default":"Skip"},"conditionAgreement":{"type":"boolean","nullable":true,"default":false},"enableRating":{"type":"boolean","nullable":true,"default":false},"enableFeedback":{"type":"boolean","nullable":true,"default":false},"enableSendButton":{"type":"boolean","nullable":true,"default":false},"feedbackTitle":{"type":"string","nullable":true,"default":"Feedback"},"ratingType":{"type":"string","enum":["star","thumb"],"nullable":true,"default":"star"},"ratingStarsNumber":{"type":"integer","format":"int32","nullable":true,"default":5},"onlineForm":{"type":"string","nullable":true},"offlineForm":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"autoclose":{"type":"boolean","nullable":true,"default":true},"enableCustomerWriting":{"type":"boolean","nullable":true,"default":false},"forwardTranscript":{"type":"boolean","nullable":true,"default":false},"forwardTranscriptMessage":{"type":"string","nullable":true},"forwardOffline":{"type":"boolean","nullable":true,"default":false},"forwardOfflineAddress":{"type":"string","nullable":true},"waitingTitle":{"type":"string","nullable":true,"default":"All of our agents are busy at this time. Your chat is very important to us."},"waitingMessage":{"type":"string","nullable":true,"default":"Please hold and we will answer your request as soon as possible."},"offlineMessageSubject":{"type":"string","nullable":true,"default":"New offline message from websiteName"},"offlineMessageBody":{"type":"string","nullable":true,"default":"You received a new offline message from websiteName. Here you can find the details of the request:"},"enableUnmanagedNote":{"type":"boolean","nullable":true,"default":true},"unmanagedMessage":{"type":"string","nullable":true,"default":"Your request has not been processed."},"skipUnmanaged":{"type":"string","nullable":true,"default":"Skip"},"sendUnmanaged":{"type":"string","nullable":true,"default":"Send"},"enableCustomerAttachment":{"type":"boolean","nullable":true,"default":false},"enableCustomerCheckmarks":{"type":"boolean","nullable":true,"default":false},"agentAvatar":{"type":"string","nullable":true},"showAgentAvatar":{"type":"boolean","nullable":true,"default":false},"timezone":{"type":"string","nullable":true},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"hideWhenOffline":{"type":"boolean","nullable":true,"default":false},"agentIdentifier":{"type":"string","nullable":true,"default":"website_alias"},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"alignment":{"type":"string","nullable":true,"default":"bottom_right"},"verticalAlignment":{"type":"integer","format":"int32","nullable":true,"default":30},"messagesAlignment":{"type":"string","nullable":true,"default":"alternate"},"defaultTitle":{"type":"string","nullable":true},"customerAvatar":{"type":"string","nullable":true},"showCustomerAvatar":{"type":"boolean","nullable":true,"default":false},"messageFontSize":{"type":"integer","format":"int32","nullable":true,"default":12},"backgroundColor":{"type":"string","default":"#fafafa"},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"systemAlias":{"type":"string","nullable":true,"default":"System"},"systemAvatar":{"type":"string","nullable":true},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"vidaooEscalation":{"type":"boolean","nullable":true,"default":false},"vidaooApiKey":{"type":"string","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","address","mapKey","mapKeyOffline","key","agentAlias","customerAlias","color","color_button","textColor","fontSize","animation","header_shape","header_online","start_chat_button","offline_chat_button","header_offline","download_transcript","timeout","whiteLabel","defaultWhiteLabel","closingQuestion","formSubmitSuccessMessage","formSubmitFailureMessage","noteTitle","placeholderMessage","closingMessage","closingMessageButton","skipMessageButton","conditionAgreement","enableRating","enableFeedback","enableSendButton","feedbackTitle","ratingType","ratingStarsNumber","onlineForm","offlineForm","token","autoclose","enableCustomerWriting","forwardTranscript","forwardOffline","waitingTitle","waitingMessage","offlineMessageSubject","offlineMessageBody","enableUnmanagedNote","unmanagedMessage","skipUnmanaged","sendUnmanaged","enableCustomerAttachment","enableCustomerCheckmarks","showAgentAvatar","notificationTemplate","notificationSound","notificationShake","hideWhenOffline","agentIdentifier","waitForTheAssignedAgent","alignment","verticalAlignment","messagesAlignment","showCustomerAvatar","messageFontSize","backgroundColor","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","systemAlias","mandatoryDisposition","vidaooEscalation","vidaooApiKey","createdAt","updatedAt"]},"OpenchannelQueueReport":{"title":"OpenchannelQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"OpenchannelInteractionId":{"type":"integer","format":"int32","nullable":true},"OpenchannelMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"OpenchannelQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"ChatApplication":{"title":"ChatApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ChatQueueId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"ChatInteraction":{"title":"ChatInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"ratingValue":{"type":"integer","format":"int32","nullable":true},"ratingType":{"type":"string","enum":["star","thumb"],"nullable":true,"default":"star"},"ratingMessage":{"type":"string","nullable":true},"pathTranscript":{"type":"string","nullable":true},"mailTranscript":{"type":"string","nullable":true},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"browserName":{"type":"string","nullable":true},"browserVersion":{"type":"string","nullable":true},"osName":{"type":"string","nullable":true},"osVersion":{"type":"string","nullable":true},"deviceModel":{"type":"string","nullable":true},"deviceVendor":{"type":"string","nullable":true},"deviceType":{"type":"string","nullable":true},"referer":{"type":"string","nullable":true},"customerIp":{"type":"string","nullable":true},"formData":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"closeReason":{"type":"string","nullable":true},"customerPort":{"type":"string","nullable":true},"vidaooSessionId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","ratingType","lastMsgDirection","createdAt","updatedAt"]},"ChatMessage":{"title":"ChatMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"secret":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string","format":"date-time","nullable":true},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"ChatInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"AttachmentId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","secret","direction","createdAt","updatedAt"]},"ChatOfflineMessage":{"title":"ChatOfflineMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ContactId":{"type":"integer","format":"int32","nullable":true},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","createdAt","updatedAt"]},"ChatQueue":{"title":"ChatQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"ChatGroup":{"title":"ChatGroup","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"write":{"type":"boolean","nullable":true,"default":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","write","createdAt","updatedAt"]},"ChatProactiveAction":{"title":"ChatProactiveAction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["mouseOver","timeout"],"nullable":true,"default":"mouseOver"},"selector":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","type","createdAt","updatedAt"]},"CmCompany":{"title":"CmCompany","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"vat":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"emailDomain":{"type":"string","nullable":true},"sStreet":{"type":"string","nullable":true},"sPostalCode":{"type":"string","nullable":true},"sCity":{"type":"string","nullable":true},"sCountry":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"CmContact":{"title":"CmContact","type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"facebook":{"type":"string","nullable":true},"fb_data":{"type":"string","nullable":true},"twitter":{"type":"string","nullable":true},"skype":{"type":"string","nullable":true},"teams":{"type":"string","nullable":true},"viber":{"type":"string","nullable":true},"line":{"type":"string","nullable":true},"wechat":{"type":"string","nullable":true},"telegram":{"type":"string","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"priority":{"type":"integer","format":"int32","nullable":true,"default":2},"scheduledat":{"type":"string","format":"date-time","nullable":true,"default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time","nullable":true},"CompanyId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","firstName","priority","scheduledat","createdAt","updatedAt"]},"CmHopper":{"title":"CmHopper","type":"object","properties":{"id":{"type":"integer","format":"int32"},"phone":{"type":"string"},"active":{"type":"boolean","nullable":true,"default":false},"scheduledat":{"type":"string","format":"date-time","nullable":true,"default":"2020-12-04 19:45:06"},"countbusyretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countcongestionretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countnoanswerretry":{"type":"integer","format":"int32","nullable":true,"default":0},"callback":{"type":"boolean","nullable":true,"default":false},"callbackuniqueid":{"type":"string","nullable":true,"default":null},"callbackat":{"type":"string","format":"date-time","nullable":true},"priority":{"type":"integer","format":"int32","nullable":true,"default":2},"recallme":{"type":"boolean","nullable":true,"default":false},"ContactId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"CampaignId":{"type":"integer","format":"int32","nullable":true},"countnosuchnumberretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countdropretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countabandonedretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countmachineretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countagentrejectretry":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OwnerId":{"type":"integer","format":"int32","nullable":true}},"required":["id","phone","active","scheduledat","countbusyretry","countcongestionretry","countnoanswerretry","callback","callbackuniqueid","priority","recallme","countnosuchnumberretry","countdropretry","countabandonedretry","countmachineretry","countagentrejectretry","createdAt","updatedAt"]},"CmHopperBlack":{"title":"CmHopperBlack","type":"object","properties":{"id":{"type":"integer","format":"int32"},"phone":{"type":"string"},"ContactId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"CampaignId":{"type":"integer","format":"int32","nullable":true}},"required":["id","phone","createdAt","updatedAt"]},"CmHopperFinal":{"title":"CmHopperFinal","type":"object","properties":{"id":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32","nullable":true},"statedesc":{"type":"string","nullable":true},"scheduledat":{"type":"string","format":"date-time","nullable":true},"countbusyretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countcongestionretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countnoanswerretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countglobal":{"type":"integer","format":"int32","nullable":true,"default":0},"uniqueid":{"type":"string","nullable":true},"originatecalleridnum":{"type":"string","nullable":true},"originatecalleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"responsetime":{"type":"string","format":"date-time","nullable":true},"answertime":{"type":"string","format":"date-time","nullable":true},"droptime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"ringtime":{"type":"integer","format":"int32","nullable":true,"default":0},"holdtime":{"type":"integer","format":"int32","nullable":true,"default":0},"talktime":{"type":"integer","format":"int32","nullable":true,"default":0},"followuptime":{"type":"integer","format":"int32","nullable":true,"default":0},"dropreason":{"type":"string","nullable":true},"campaign":{"type":"string","nullable":true},"campaigntype":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"dispositionat":{"type":"string","format":"date-time","nullable":true},"amd":{"type":"boolean","nullable":true,"default":false},"fax":{"type":"boolean","nullable":true,"default":false},"blacklist":{"type":"boolean","nullable":true,"default":false},"rescheduled":{"type":"boolean","nullable":true,"default":false},"rescheduledat":{"type":"string","format":"date-time","nullable":true},"callback":{"type":"boolean","nullable":true,"default":false},"callbackuniqueid":{"type":"string","nullable":true,"default":null},"callbackat":{"type":"string","format":"date-time","nullable":true},"deleted":{"type":"string","nullable":true,"default":null},"deletedat":{"type":"string","format":"date-time","nullable":true},"recallme":{"type":"boolean","nullable":true,"default":false},"agiafterat":{"type":"string","format":"date-time","nullable":true},"countnosuchnumberretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countdropretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countabandonedretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countmachineretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countagentrejectretry":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"CampaignId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","countbusyretry","countcongestionretry","countnoanswerretry","countglobal","ringtime","holdtime","talktime","followuptime","amd","fax","blacklist","rescheduled","callback","callbackuniqueid","deleted","recallme","countnosuchnumberretry","countdropretry","countabandonedretry","countmachineretry","countagentrejectretry","createdAt","updatedAt"]},"CmHopperHistory":{"title":"CmHopperHistory","type":"object","properties":{"id":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32","nullable":true},"statedesc":{"type":"string","nullable":true},"scheduledat":{"type":"string","format":"date-time","nullable":true},"countbusyretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countcongestionretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countnoanswerretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countglobal":{"type":"integer","format":"int32","nullable":true,"default":0},"uniqueid":{"type":"string","nullable":true},"originatecalleridnum":{"type":"string","nullable":true},"originatecalleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"responsetime":{"type":"string","format":"date-time","nullable":true},"answertime":{"type":"string","format":"date-time","nullable":true},"droptime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"ringtime":{"type":"integer","format":"int32","nullable":true,"default":0},"holdtime":{"type":"integer","format":"int32","nullable":true,"default":0},"talktime":{"type":"integer","format":"int32","nullable":true,"default":0},"followuptime":{"type":"integer","format":"int32","nullable":true,"default":0},"dropreason":{"type":"string","nullable":true},"campaign":{"type":"string","nullable":true},"campaigntype":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"amd":{"type":"boolean","nullable":true,"default":false},"fax":{"type":"boolean","nullable":true,"default":false},"callback":{"type":"boolean","nullable":true,"default":false},"callbackuniqueid":{"type":"string","nullable":true,"default":null},"callbackat":{"type":"string","format":"date-time","nullable":true},"recallme":{"type":"boolean","nullable":true,"default":false},"editedat":{"type":"string","format":"date-time","nullable":true},"edited":{"type":"boolean","nullable":true,"default":false},"countnosuchnumberretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countdropretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countabandonedretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countmachineretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countagentrejectretry":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"CampaignId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","countbusyretry","countcongestionretry","countnoanswerretry","countglobal","ringtime","holdtime","talktime","followuptime","amd","fax","callback","callbackuniqueid","recallme","edited","countnosuchnumberretry","countdropretry","countabandonedretry","countmachineretry","countagentrejectretry","createdAt","updatedAt"]},"ReportAgentPreview":{"title":"ReportAgentPreview","type":"object","properties":{"id":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32","nullable":true},"statedesc":{"type":"string","nullable":true},"scheduledat":{"type":"string","format":"date-time","nullable":true},"uniqueid":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"responsetime":{"type":"string","format":"date-time","nullable":true},"ringtime":{"type":"integer","format":"int32","nullable":true,"default":0},"campaign":{"type":"string","nullable":true},"campaigntype":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","ringtime","createdAt","updatedAt"]},"CmCustomField":{"title":"CmCustomField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"alias":{"type":"string"},"type":{"type":"string"},"values":{"type":"string","nullable":true},"required":{"type":"boolean","nullable":true,"default":false},"clickToAction":{"type":"boolean","nullable":true,"default":false},"actionType":{"type":"string","enum":["voice"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","alias","type","required","clickToAction","createdAt","updatedAt"]},"Action":{"title":"Action","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"action":{"type":"string"},"data1":{"type":"string","maxLength":4096,"nullable":true},"data2":{"type":"string","maxLength":4096,"nullable":true},"data3":{"type":"string","maxLength":4096,"nullable":true},"data4":{"type":"string","maxLength":4096,"nullable":true},"data5":{"type":"string","maxLength":4096,"nullable":true},"data6":{"type":"string","nullable":true},"data7":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AutomationId":{"type":"integer","format":"int32","nullable":true},"TriggerId":{"type":"integer","format":"int32","nullable":true}},"required":["id","action","createdAt","updatedAt"]},"Automation":{"title":"Automation","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"channel":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"status":{"type":"boolean","nullable":true,"default":false},"timeout":{"type":"integer","format":"int32","nullable":true,"default":10},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","status","timeout","createdAt","updatedAt"]},"CannedAnswer":{"title":"CannedAnswer","type":"object","properties":{"id":{"type":"integer","format":"int32"},"key":{"type":"string"},"value":{"type":"string"},"description":{"type":"string","nullable":true},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","key","value","createdAt","updatedAt"]},"Disposition":{"title":"Disposition","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"level":{"type":"string","enum":["first","second","third"],"default":"first"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"ParentId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","level","createdAt","updatedAt"]},"Condition":{"title":"Condition","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AutomationAllId":{"type":"integer","format":"int32","nullable":true},"AutomationAnyId":{"type":"integer","format":"int32","nullable":true},"TriggerAllId":{"type":"integer","format":"int32","nullable":true},"TriggerAnyId":{"type":"integer","format":"int32","nullable":true}},"required":["id","field","operator","value","createdAt","updatedAt"]},"Interval":{"title":"Interval","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"Pause":{"title":"Pause","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"Cdr":{"title":"Cdr","type":"object","properties":{"id":{"type":"integer","format":"int32"},"calldate":{"type":"string","format":"date-time","default":"1970-01-01 00:00:01"},"clid":{"type":"string","nullable":true},"src":{"type":"string","nullable":true},"dst":{"type":"string","nullable":true},"dcontext":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"dstchannel":{"type":"string","nullable":true},"lastapp":{"type":"string","nullable":true},"lastdata":{"type":"string","nullable":true},"duration":{"type":"integer","format":"int32","default":0},"billsec":{"type":"integer","format":"int32","default":0},"disposition":{"type":"string","nullable":true},"amaflags":{"type":"integer","format":"int32","default":0},"accountcode":{"type":"string","nullable":true},"userfield":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"linkedid":{"type":"string","nullable":true},"sequence":{"type":"string","nullable":true},"peeraccount":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"tag":{"type":"string","nullable":true}},"required":["id","calldate","duration","billsec","amaflags"]},"VoiceQueuesLog":{"title":"VoiceQueuesLog","type":"object","properties":{"id":{"type":"integer","format":"int32"},"time":{"type":"string","nullable":true},"callid":{"type":"string","default":""},"queuename":{"type":"string","default":""},"agent":{"type":"string","default":""},"event":{"type":"string","default":""},"data":{"type":"string","default":""},"data1":{"type":"string","default":""},"data2":{"type":"string","default":""},"data3":{"type":"string","default":""},"data4":{"type":"string","default":""},"data5":{"type":"string","default":""},"dtm":{"type":"string","format":"date-time","default":"2020-12-04 19:45:06"}},"required":["id","callid","queuename","agent","event","data","data1","data2","data3","data4","data5","dtm"]},"Schedule":{"title":"Schedule","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"active":{"type":"boolean","default":false},"cron":{"type":"string","default":"0 0 * * *"},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"subtractNumber":{"type":"integer","format":"int32","default":1},"subtractUnit":{"type":"string","enum":["years","quarters","months","weeks","days","hours","minutes"],"default":"days"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"type":{"type":"string","enum":["custom","default"],"default":"custom"},"sendMail":{"type":"boolean","nullable":true,"default":false},"email":{"type":"string","nullable":true},"cc":{"type":"string","nullable":true},"bcc":{"type":"string","nullable":true},"sendIfEmpty":{"type":"boolean","nullable":true,"default":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"DefaultReportId":{"type":"integer","format":"int32","nullable":true},"CustomReportId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","active","cron","startAt","endAt","subtractNumber","subtractUnit","output","type","sendMail","sendIfEmpty","createdAt","updatedAt"]},"Sound":{"title":"Sound","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"save_name":{"type":"string","nullable":true},"display_name":{"type":"string","nullable":true,"default":""},"description":{"type":"string","nullable":true},"original_format":{"type":"string","nullable":true},"original_duration":{"type":"number","format":"float","nullable":true},"original_sampleCount":{"type":"integer","format":"int64","nullable":true},"original_channelCount":{"type":"integer","format":"int32","nullable":true},"original_bitRate":{"type":"integer","format":"int64","nullable":true},"original_sampleRate":{"type":"integer","format":"int32","nullable":true},"converted_format":{"type":"string","nullable":true},"converted_duration":{"type":"number","format":"float","nullable":true},"converted_sampleCount":{"type":"integer","format":"int64","nullable":true},"converted_channelCount":{"type":"integer","format":"int32","nullable":true},"converted_bitRate":{"type":"integer","format":"int64","nullable":true},"converted_sampleRate":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","display_name","createdAt","updatedAt"]},"Tag":{"title":"Tag","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"color":{"type":"string","nullable":true,"default":"#0091EA"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","color","createdAt","updatedAt"]},"Template":{"title":"Template","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"Trigger":{"title":"Trigger","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"status":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","status","createdAt","updatedAt"]},"Variable":{"title":"Variable","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"Integration":{"title":"Integration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"version":{"type":"string"},"main":{"type":"string","nullable":true,"default":"app.js"},"filename":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"size":{"type":"integer","format":"int32","nullable":true},"active":{"type":"boolean","nullable":true,"default":false},"author":{"type":"string","nullable":true},"logo":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"link":{"type":"string","nullable":true,"default":"#"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","version","main","active","link","createdAt","updatedAt"]},"IntegrationReport":{"title":"IntegrationReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"integration":{"type":"string","nullable":true},"eventChannel":{"type":"string","nullable":true},"exitStatus":{"type":"string","nullable":true},"ticketId":{"type":"string","nullable":true},"integrationId":{"type":"integer","format":"int32","nullable":true},"contacts":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"interface":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"agentcalledAt":{"type":"string","format":"date-time","nullable":true},"agentconnectAt":{"type":"string","format":"date-time","nullable":true},"holdtime":{"type":"integer","format":"int32","nullable":true},"agentcomplete":{"type":"boolean","nullable":true,"default":false},"agentcompleteAt":{"type":"string","format":"date-time","nullable":true},"talktime":{"type":"integer","format":"int32","nullable":true},"agentacw":{"type":"boolean","nullable":true,"default":false},"acwtime":{"type":"integer","format":"int32","nullable":true},"reason":{"type":"string","nullable":true},"agentringnoanswer":{"type":"boolean","nullable":true,"default":false},"agentringnoanswerAt":{"type":"string","format":"date-time","nullable":true},"agentdump":{"type":"boolean","nullable":true,"default":false},"agentdumpAt":{"type":"string","format":"date-time","nullable":true},"lastevent":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"channelstate":{"type":"integer","format":"int32","nullable":true},"channelstatedesc":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"destchannel":{"type":"string","nullable":true},"destchannelstate":{"type":"integer","format":"int32","nullable":true},"destchannelstatedesc":{"type":"string","nullable":true},"destcalleridnum":{"type":"string","nullable":true},"destcalleridname":{"type":"string","nullable":true},"destconnectedlinenum":{"type":"string","nullable":true},"destconnectedlinename":{"type":"string","nullable":true},"destlanguage":{"type":"string","nullable":true},"destaccountcode":{"type":"string","nullable":true},"destcontext":{"type":"string","nullable":true},"destexten":{"type":"string","nullable":true},"destpriority":{"type":"string","nullable":true},"destuniqueid":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true},"inReplyTo":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true},"cc":{"type":"string","nullable":true},"attachment":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"status":{"type":"string","enum":["SENT","SENDING","RECEIVED","FAILED"],"nullable":true},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appdata":{"type":"string","nullable":true},"projectId":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","agentcomplete","agentacw","agentringnoanswer","agentdump","createdAt","updatedAt"]},"AnalyticCustomReport":{"title":"AnalyticCustomReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"parent":{"type":"string","nullable":true},"table":{"type":"string","nullable":true},"conditions":{"type":"string","nullable":true},"joins":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time","nullable":true}},"required":["id","name","createdAt","updatedAt"]},"AnalyticDefaultReport":{"title":"AnalyticDefaultReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"parent":{"type":"string","nullable":true},"table":{"type":"string","nullable":true},"conditions":{"type":"string","nullable":true},"joins":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"AnalyticExtractedReport":{"title":"AnalyticExtractedReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"basename":{"type":"string"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"savename":{"type":"string"},"startDate":{"type":"string","format":"date-time","nullable":true},"endDate":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true,"default":"Loading"},"type":{"type":"string","enum":["manual","scheduled"],"default":"manual"},"reportId":{"type":"integer","format":"int32","nullable":true},"reportType":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","basename","output","savename","status","type","createdAt","updatedAt"]},"AnalyticMetric":{"title":"AnalyticMetric","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"table":{"type":"string","nullable":true},"metric":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"AnalyticFieldReport":{"title":"AnalyticFieldReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"field":{"type":"string","nullable":true},"alias":{"type":"string","nullable":true},"function":{"type":"string","nullable":true},"format":{"type":"string","nullable":true},"groupBy":{"type":"boolean","nullable":true,"default":false},"orderBy":{"type":"string","nullable":true},"custom":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"CustomReportId":{"type":"integer","format":"int32","nullable":true},"DefaultReportId":{"type":"integer","format":"int32","nullable":true},"MetricId":{"type":"integer","format":"int32","nullable":true}},"required":["id","groupBy","custom","createdAt","updatedAt"]},"AnalyticTreeReport":{"title":"AnalyticTreeReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"tree":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tree","createdAt","updatedAt"]},"SalesforceAccount":{"title":"SalesforceAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true},"clientSecret":{"type":"string","nullable":true},"securityToken":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"type":{"type":"string","enum":["integrationTab","newTab"],"nullable":true,"default":"integrationTab"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","createdAt","updatedAt"]},"SalesforceConfiguration":{"title":"SalesforceConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"ticketType":{"type":"string","enum":["Task","Case"],"nullable":true,"default":"Task"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"nullable":true,"default":"contact_lead"},"moduleCreate":{"type":"string","enum":["nothing","contact","lead"],"nullable":true,"default":"lead"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","ticketType","moduleSearch","moduleCreate","createdAt","updatedAt"]},"SalesforceField":{"title":"SalesforceField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","createdAt","updatedAt"]},"SugarcrmAccount":{"title":"SugarcrmAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"SugarcrmConfiguration":{"title":"SugarcrmConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"SugarcrmField":{"title":"SugarcrmField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"DeskAccount":{"title":"DeskAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"authType":{"type":"string","enum":["basic"],"nullable":true,"default":"basic"},"password":{"type":"string","nullable":true},"consumerKey":{"type":"string","nullable":true},"consumerSecret":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"tokenSecret":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"type":{"type":"string","enum":["integrationTab","newTab"],"nullable":true,"default":"integrationTab"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","authType","type","createdAt","updatedAt"]},"DeskConfiguration":{"title":"DeskConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"DeskField":{"title":"DeskField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"ZohoAccount":{"title":"ZohoAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true},"zone":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true},"clientSecret":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"refreshToken":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"ZohoConfiguration":{"title":"ZohoConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"moduleCreate":{"type":"string","enum":["lead","contact","nothing"],"nullable":true,"default":"lead"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"nullable":true,"default":"contact_lead"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","moduleCreate","moduleSearch","createdAt","updatedAt"]},"ZohoField":{"title":"ZohoField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"ZendeskAccount":{"title":"ZendeskAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"authType":{"type":"string","enum":["password","token"],"nullable":true,"default":"password"},"serverUrl":{"type":"string","nullable":true},"type":{"type":"string","enum":["integrationTab","newTab"],"nullable":true,"default":"integrationTab"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","authType","type","createdAt","updatedAt"]},"ZendeskConfiguration":{"title":"ZendeskConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"ZendeskField":{"title":"ZendeskField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"FreshdeskAccount":{"title":"FreshdeskAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"apiKey":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"FreshdeskConfiguration":{"title":"FreshdeskConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"FreshdeskField":{"title":"FreshdeskField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"VtigerAccount":{"title":"VtigerAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"username":{"type":"string"},"moduleName":{"type":"string","default":"HelpDesk"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string","nullable":true},"accessKey":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","username","moduleName","remoteUri","accessKey","createdAt","updatedAt"]},"VtigerConfiguration":{"title":"VtigerConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"VtigerField":{"title":"VtigerField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"ServicenowAccount":{"title":"ServicenowAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"ServicenowConfiguration":{"title":"ServicenowConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"ServicenowField":{"title":"ServicenowField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"Dynamics365Account":{"title":"Dynamics365Account","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true},"clientSecret":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"Dynamics365Configuration":{"title":"Dynamics365Configuration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"ticketType":{"type":"string","enum":["incident","phonecall"],"nullable":true,"default":"incident"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","ticketType","createdAt","updatedAt"]},"Dynamics365Field":{"title":"Dynamics365Field","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"FreshsalesAccount":{"title":"FreshsalesAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"apiKey":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"FreshsalesConfiguration":{"title":"FreshsalesConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"FreshsalesField":{"title":"FreshsalesField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"Network":{"title":"Network","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["localnet","externip","stun","turn"],"nullable":true},"value":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"ChatQueueReport":{"title":"ChatQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"ChatInteractionId":{"type":"integer","format":"int32","nullable":true},"ChatMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ChatQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"ChatInternalMessage":{"title":"ChatInternalMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"ChatInternalMessageId":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatGroupId":{"type":"integer","format":"int32","nullable":true},"FromId":{"type":"integer","format":"int32","nullable":true},"ToId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","createdAt","updatedAt"]},"JscriptyAnswerReport":{"title":"JscriptyAnswerReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"question":{"type":"string","nullable":true},"answer":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"projectname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"questionId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SessionId":{"type":"integer","format":"int32","nullable":true},"ProjectId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"JscriptyQuestionReport":{"title":"JscriptyQuestionReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"question":{"type":"string","nullable":true},"answer":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"projectname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"questionId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SessionId":{"type":"integer","format":"int32","nullable":true},"ProjectId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"JscriptySessionReport":{"title":"JscriptySessionReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"starttime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"membername":{"type":"string","nullable":true},"projectname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"completed":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"ProjectId":{"type":"integer","format":"int32","nullable":true}},"required":["id","completed","createdAt","updatedAt"]},"SmsQueueReport":{"title":"SmsQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"SmsInteractionId":{"type":"integer","format":"int32","nullable":true},"SmsMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"SmsQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"SquareReport":{"title":"SquareReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"network":{"type":"string","nullable":true},"network_script":{"type":"string","nullable":true},"request":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"callingpres":{"type":"string","nullable":true},"callingani2":{"type":"string","nullable":true},"callington":{"type":"string","nullable":true},"callingtns":{"type":"string","nullable":true},"dnid":{"type":"string","nullable":true},"rdnis":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"extension":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"enhanced":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"threadid":{"type":"string","nullable":true},"project_name":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"bot":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","bot","createdAt","updatedAt"]},"SquareDetailsReport":{"title":"SquareDetailsReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string","nullable":true},"node":{"type":"string","nullable":true},"application":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"project_name":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"JscriptyProject":{"title":"JscriptyProject","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"formData":{"type":"string","nullable":true},"enableUncompleteSave":{"type":"boolean","nullable":true,"default":true},"sendUnpauseOnSubmit":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","enableUncompleteSave","sendUnpauseOnSubmit","createdAt","updatedAt"]},"Setting":{"title":"Setting","type":"object","properties":{"id":{"type":"integer","format":"int32"},"min_internal":{"type":"integer","format":"int32","nullable":true,"default":1000},"min_mailbox":{"type":"integer","format":"int32","nullable":true,"default":1000},"agi_port":{"type":"integer","format":"int32","nullable":true,"default":4573},"soundPath":{"type":"string","nullable":true,"default":"/var/opt/motion2/server/files/sounds/converted"},"logo":{"type":"string","nullable":true},"defaultLogo":{"type":"boolean","nullable":true,"default":true},"loginLogo":{"type":"string","nullable":true},"defaultLoginLogo":{"type":"boolean","nullable":true,"default":true},"headerWhiteLabel":{"type":"string","nullable":true},"defaultHeaderWhiteLabel":{"type":"boolean","nullable":true,"default":true},"securePassword":{"type":"boolean","nullable":true,"default":true},"firstSetup":{"type":"boolean","nullable":true,"default":true},"stunaddr":{"type":"string","nullable":true},"turnaddr":{"type":"string","nullable":true},"turnusername":{"type":"string","nullable":true},"turnpassword":{"type":"string","nullable":true},"pageTitle":{"type":"string","nullable":true},"defaultPageTitle":{"type":"boolean","nullable":true,"default":true},"callRecordingEncryption":{"type":"boolean","nullable":true,"default":false},"passwordExpiresDays":{"type":"integer","format":"int32","nullable":true,"default":90},"phoneBarAutoUpdater":{"type":"boolean","nullable":true,"default":true},"phoneBarAutoUpdaterUrl":{"type":"string","nullable":true,"default":"https://www.xcally.com/bar/phonebar/autoupdater.xml"},"enableEmailPreview":{"type":"boolean","nullable":true,"default":false},"split":{"type":"boolean","nullable":true,"default":true},"splitSizeCsv":{"type":"integer","format":"int32","nullable":true,"default":5000},"splitSizePdf":{"type":"integer","format":"int32","nullable":true,"default":5000},"splitSizeXlsx":{"type":"integer","format":"int32","nullable":true,"default":5000},"messagesAlignment":{"type":"string","nullable":true,"default":"alternate"},"chatTimeout":{"type":"integer","format":"int32","nullable":true,"default":30},"phoneBarRememberMeEnabled":{"type":"boolean","nullable":true,"default":true},"preferred":{"type":"string","nullable":true},"defaultPreferred":{"type":"boolean","nullable":true,"default":true},"rtlSupport":{"type":"boolean","nullable":true,"default":false},"defaultScreenRecordingPath":{"type":"string","nullable":true},"allowedLoginAttempts":{"type":"integer","format":"int32","nullable":true,"default":5},"blockDuration":{"type":"integer","format":"int32","nullable":true,"default":10},"favicon":{"type":"string","nullable":true},"defaultFavicon":{"type":"boolean","nullable":true,"default":true},"loginMailFrequency":{"type":"integer","format":"int32","nullable":true,"default":10},"transcribe":{"type":"boolean","nullable":true,"default":false},"automaticTranscribe":{"type":"boolean","nullable":true,"default":false},"transcribeAccountId":{"type":"integer","format":"int32","nullable":true},"transcribeRegion":{"type":"string","nullable":true},"sentiment":{"type":"boolean","nullable":true,"default":false},"automaticSentiment":{"type":"boolean","nullable":true,"default":false},"sentimentAccountId":{"type":"integer","format":"int32","nullable":true},"sentimentRegion":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"bucket":{"type":"string","nullable":true},"googleSsoEnabled":{"type":"boolean","nullable":true,"default":false},"enforcePasswordHistory":{"type":"boolean","nullable":true,"default":true},"passwordHistoryLimit":{"type":"integer","format":"int32","nullable":true,"default":3},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","min_internal","min_mailbox","agi_port","soundPath","defaultLogo","defaultLoginLogo","defaultHeaderWhiteLabel","securePassword","firstSetup","defaultPageTitle","callRecordingEncryption","passwordExpiresDays","phoneBarAutoUpdater","phoneBarAutoUpdaterUrl","enableEmailPreview","split","splitSizeCsv","splitSizePdf","splitSizeXlsx","messagesAlignment","chatTimeout","phoneBarRememberMeEnabled","defaultPreferred","rtlSupport","allowedLoginAttempts","blockDuration","defaultFavicon","loginMailFrequency","transcribe","automaticTranscribe","sentiment","automaticSentiment","googleSsoEnabled","enforcePasswordHistory","passwordHistoryLimit","createdAt","updatedAt"]},"SquareOdbc":{"title":"SquareOdbc","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"dsn":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"SquareProject":{"title":"SquareProject","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"preproduction":{"type":"string","format":"byte","nullable":true},"production":{"type":"string","format":"byte","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"SquareRecording":{"title":"SquareRecording","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"extension":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"dnid":{"type":"string","nullable":true},"projectName":{"type":"string","nullable":true},"saveName":{"type":"string","nullable":true},"filename":{"type":"string","nullable":true},"savePath":{"type":"string","nullable":true},"format":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"SquareMessage":{"title":"SquareMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string","nullable":true},"body":{"type":"string"},"direction":{"type":"string","enum":["in","out"],"default":"out"},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","body","direction","createdAt","updatedAt"]},"Team":{"title":"Team","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"License":{"title":"License","type":"object","properties":{"id":{"type":"integer","format":"int32"},"license":{"type":"string","nullable":true},"data1":{"type":"string","nullable":true},"data2":{"type":"string","nullable":true},"chatLicenseExceeded":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","chatLicenseExceeded","createdAt","updatedAt"]},"Campaign":{"title":"Campaign","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["ivr"],"default":"ivr"},"description":{"type":"string","nullable":true},"active":{"type":"boolean","nullable":true,"default":0},"limitCalls":{"type":"integer","format":"int32","nullable":true,"default":30},"dialOriginateCallerIdName":{"type":"string","nullable":true},"dialOriginateCallerIdNumber":{"type":"string","nullable":true},"dialOriginateTimeout":{"type":"integer","format":"int32","nullable":true,"default":30},"dialCongestionMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialCongestionRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialBusyMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialBusyRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialNoAnswerMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialNoAnswerRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialGlobalMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":4},"dialTimezone":{"type":"string","nullable":true,"default":null},"dialGlobalInterval":{"type":"string","nullable":true,"default":"07:00-22:00,*,*,*"},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"nullable":true,"default":"always"},"dialAMDActive":{"type":"boolean","nullable":true,"default":0},"dialAMDInitialSilence":{"type":"integer","format":"int32","nullable":true,"default":2500},"dialAMDGreeting":{"type":"integer","format":"int32","nullable":true,"default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","format":"int32","nullable":true,"default":800},"dialAMDTotalAnalysisTime":{"type":"integer","format":"int32","nullable":true,"default":5000},"dialAMDMinWordLength":{"type":"integer","format":"int32","nullable":true,"default":100},"dialAMDBetweenWordsSilence":{"type":"integer","format":"int32","nullable":true,"default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAMDSilenceThreshold":{"type":"integer","format":"int32","nullable":true,"default":256},"dialAMDMaximumWordLength":{"type":"integer","format":"int32","nullable":true,"default":5000},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"nullable":true,"default":"DESC"},"dialPrefix":{"type":"string","nullable":true,"default":null},"dialRandomLastDigitCallerIdNumber":{"type":"integer","format":"int32","nullable":true,"default":0},"dialCutDigit":{"type":"integer","format":"int32","nullable":true,"default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialDropMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialDropRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialAbandonedMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAbandonedRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialMachineMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialMachineRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialAgentRejectMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAgentRejectRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TrunkId":{"type":"integer","format":"int32","nullable":true},"TrunkBackupId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"SquareProjectId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","type","active","limitCalls","dialOriginateTimeout","dialCongestionMaxRetry","dialCongestionRetryFrequency","dialBusyMaxRetry","dialBusyRetryFrequency","dialNoAnswerMaxRetry","dialNoAnswerRetryFrequency","dialGlobalMaxRetry","dialTimezone","dialGlobalInterval","dialCheckDuplicateType","dialAMDActive","dialAMDInitialSilence","dialAMDGreeting","dialAMDAfterGreetingSilence","dialAMDTotalAnalysisTime","dialAMDMinWordLength","dialAMDBetweenWordsSilence","dialAMDMaximumNumberOfWords","dialAMDSilenceThreshold","dialAMDMaximumWordLength","dialOrderByScheduledAt","dialPrefix","dialRandomLastDigitCallerIdNumber","dialCutDigit","dialNoSuchNumberMaxRetry","dialNoSuchNumberRetryFrequency","dialDropMaxRetry","dialDropRetryFrequency","dialAbandonedMaxRetry","dialAbandonedRetryFrequency","dialMachineMaxRetry","dialMachineRetryFrequency","dialAgentRejectMaxRetry","dialAgentRejectRetryFrequency","createdAt","updatedAt"]},"Migration":{"title":"Migration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"version":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"Attachment":{"title":"Attachment","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"basename":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailMessageId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"Plugin":{"title":"Plugin","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["html","script"],"nullable":true},"description":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"active":{"type":"boolean","nullable":true,"default":0},"sidebar":{"type":"string","enum":["adminOnly","agentOnly","always","never"],"nullable":true,"default":"always"},"icon":{"type":"string","nullable":true},"adminUrl":{"type":"string","nullable":true},"agentUrl":{"type":"string","nullable":true},"scriptName":{"type":"string","nullable":true},"scriptPath":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","active","sidebar","createdAt","updatedAt"]},"MailTransferReport":{"title":"MailTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailMessageId":{"type":"integer","format":"int32","nullable":true},"MailInteractionId":{"type":"integer","format":"int32","nullable":true},"FromMailAccountId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToMailQueueId":{"type":"integer","format":"int32","nullable":true},"ToMailAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"ChatTransferReport":{"title":"ChatTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatMessageId":{"type":"integer","format":"int32","nullable":true},"ChatInteractionId":{"type":"integer","format":"int32","nullable":true},"FromChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToChatQueueId":{"type":"integer","format":"int32","nullable":true},"ToChatWebsiteId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"FaxTransferReport":{"title":"FaxTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"FaxMessageId":{"type":"integer","format":"int32","nullable":true},"FaxInteractionId":{"type":"integer","format":"int32","nullable":true},"FromFaxAccountId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToFaxQueueId":{"type":"integer","format":"int32","nullable":true},"ToFaxAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"OpenchannelTransferReport":{"title":"OpenchannelTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OpenchannelMessageId":{"type":"integer","format":"int32","nullable":true},"OpenchannelInteractionId":{"type":"integer","format":"int32","nullable":true},"FromOpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToOpenchannelQueueId":{"type":"integer","format":"int32","nullable":true},"ToOpenchannelAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"SmsTransferReport":{"title":"SmsTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SmsMessageId":{"type":"integer","format":"int32","nullable":true},"SmsInteractionId":{"type":"integer","format":"int32","nullable":true},"FromSmsAccountId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToSmsQueueId":{"type":"integer","format":"int32","nullable":true},"ToSmsAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"CmList":{"title":"CmList","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"dialPrefix":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"VoicePrefix":{"title":"VoicePrefix","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"prefix":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"description":{"type":"string","nullable":true},"callerIdAll":{"type":"string","nullable":true},"VoiceExtensionId":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"UserProfile":{"title":"UserProfile","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"crudPermissions":{"type":"string","default":"r"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","crudPermissions","createdAt","updatedAt"]},"UserProfileSection":{"title":"UserProfileSection","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"category":{"type":"string"},"sectionId":{"type":"integer","format":"int32"},"enabled":{"type":"boolean","nullable":true,"default":null},"autoAssociation":{"type":"boolean","nullable":true,"default":null},"crudPermissions":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userProfileId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","category","sectionId","enabled","autoAssociation","createdAt","updatedAt"]},"UserProfileResource":{"title":"UserProfileResource","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"resourceId":{"type":"integer","format":"int32"},"type":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"sectionId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","resourceId","type","createdAt","updatedAt"]},"Notification":{"title":"Notification","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string","nullable":true},"senderName":{"type":"string","nullable":true},"recipientsId":{"type":"string","nullable":true},"recipientsDescription":{"type":"string","nullable":true},"beep":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SenderId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"WhatsappAccount":{"title":"WhatsappAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"type":{"type":"string","enum":["twilio"],"nullable":true},"accountSid":{"type":"string","nullable":true},"authToken":{"type":"string","nullable":true},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":false},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","key","remote","token","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDisposition","createdAt","updatedAt"]},"WhatsappApplication":{"title":"WhatsappApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"WhatsappQueueId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"WhatsappInteraction":{"title":"WhatsappInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","firstMsgDirection","lastMsgDirection","createdAt","updatedAt"]},"WhatsappMessage":{"title":"WhatsappMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string","maxLength":190,"nullable":true},"phone":{"type":"string","nullable":true},"readAt":{"type":"string","format":"date-time","nullable":true},"secret":{"type":"boolean","nullable":true,"default":false},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"WhatsappInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","direction","secret","createdAt","updatedAt"]},"WhatsappQueueReport":{"title":"WhatsappQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"WhatsappInteractionId":{"type":"integer","format":"int32","nullable":true},"WhatsappQueueId":{"type":"integer","format":"int32","nullable":true},"WhatsappMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"WhatsappTransferReport":{"title":"WhatsappTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"]},"transferredAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"WhatsappMessageId":{"type":"integer","format":"int32","nullable":true},"WhatsappInteractionId":{"type":"integer","format":"int32","nullable":true},"FromWhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"ToWhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"ToQueueId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","createdAt","updatedAt"]},"WhatsappQueue":{"title":"WhatsappQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"CloudProvider":{"title":"CloudProvider","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"service":{"type":"string","enum":["AmazonAWS","Google"]},"data1":{"type":"string","nullable":true},"data2":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","service","createdAt","updatedAt"]}}},"tags":[]}
+{"openapi":"3.0.3","info":{"title":"XCally Motion API","description":"OpenAPI document for XCally Motion API","termsOfService":"http://xcally.com/terms/","contact":{"name":"API Support","url":"http://www.xcally.com/support","email":"support@xcally.com"},"license":{"name":"XCally EULA","url":"http://xcally.com/eula/"},"version":"3.0.0.alpha"},"servers":[{"url":"http://localhost:9000/api","description":"Localhost instance"}],"paths":{"/actions/{id}":{"put":{"summary":"Update an existing Action","security":[{"BearerAuth":[]}],"operationId":"updateActionById","tags":["Actions"],"requestBody":{"required":true,"description":"data for updating a new Action","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"action":{"type":"string","description":"Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script"},"data1":{"type":"string","description":"contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]"},"data2":{"type":"string","description":"integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]"},"data3":{"type":"string","description":"motionbar[NULL,NULL,WinAppArguments]"},"data4":{"type":"string"},"data5":{"type":"string"},"data6":{"type":"string"},"data7":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Action to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Action not found"}}}},"/actions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Action","security":[{"BearerAuth":[]}],"operationId":"deleteActionById","tags":["Actions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Action to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Action not found"}}}},"/analytics/custom_reports":{"get":{"summary":"Gets a list of Analytic Custom Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticCustomReport","tags":["Analytic Custom Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticCustomReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Custom Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticCustomReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Custom Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticCustomReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Custom Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticCustomReport","tags":["Analytic Custom Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Custom Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"parent":{"type":"string"},"table":{"type":"string"},"conditions":{"type":"string"},"joins":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"AnalyticCustomReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticCustomReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/custom_reports/{id}":{"get":{"summary":"Gets a single Analytic Custom Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticCustomReportById","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport to get"}],"responses":{"200":{"description":"AnalyticCustomReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticCustomReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticCustomReport not found"}}},"put":{"summary":"Update an existing Analytic Custom Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticCustomReportById","tags":["Analytic Custom Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Custom Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"parent":{"type":"string"},"table":{"type":"string"},"conditions":{"type":"string"},"joins":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticCustomReport not found"}}}},"/analytics/custom_reports/{id}/preview":{"get":{"summary":"Report Preview","security":[{"BearerAuth":[]}],"operationId":"preview","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/custom_reports/{id}/run":{"get":{"summary":"Report Run","security":[{"BearerAuth":[]}],"operationId":"run","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/custom_reports/{id}/query":{"get":{"summary":"Report Query SQL","security":[{"BearerAuth":[]}],"operationId":"query","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/custom_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Custom Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticCustomReportById","tags":["Analytic Custom Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticCustomReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticCustomReport not found"}}}},"/analytics/default_reports":{"get":{"summary":"Gets a list of Analytic Default Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticDefaultReport","tags":["Analytic Default Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticDefaultReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Default Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticDefaultReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Default Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticDefaultReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Default Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticDefaultReport","tags":["Analytic Default Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Default Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"parent":{"type":"string"},"table":{"type":"string"},"conditions":{"type":"string"},"joins":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"AnalyticDefaultReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticDefaultReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/default_reports/{id}":{"get":{"summary":"Gets a single Analytic Default Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticDefaultReportById","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport to get"}],"responses":{"200":{"description":"AnalyticDefaultReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticDefaultReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticDefaultReport not found"}}},"put":{"summary":"Update an existing Analytic Default Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticDefaultReportById","tags":["Analytic Default Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Default Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"parent":{"type":"string"},"table":{"type":"string"},"conditions":{"type":"string"},"joins":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticDefaultReport not found"}}}},"/analytics/default_reports/{id}/preview":{"get":{"summary":"Report Preview","security":[{"BearerAuth":[]}],"operationId":"preview","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/default_reports/{id}/run":{"get":{"summary":"Report Run","security":[{"BearerAuth":[]}],"operationId":"run","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/default_reports/{id}/query":{"get":{"summary":"Report Query SQL","security":[{"BearerAuth":[]}],"operationId":"query","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/default_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Default Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticDefaultReportById","tags":["Analytic Default Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticDefaultReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticDefaultReport not found"}}}},"/analytics/extracted_reports":{"get":{"summary":"Gets a list of Analytic Extacted Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticExtractedReport","tags":["Analytic Extracted Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticExtractedReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Extacted Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticExtractedReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Extacted Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticExtractedReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Extracted Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticExtractedReport","tags":["Analytic Extracted Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Extracted Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"basename":{"type":"string"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"savename":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"status":{"type":"string","default":"Loading"},"type":{"type":"string","enum":["manual","scheduled"],"default":"manual"},"reportId":{"type":"integer"},"reportType":{"type":"string"}},"required":["name","basename","output","savename","type"]}}}},"responses":{"201":{"description":"AnalyticExtractedReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticExtractedReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/extracted_reports/{id}":{"get":{"summary":"Gets a single Analytic Extracted Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticExtractedReportById","tags":["Analytic Extracted Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticExtractedReport to get"}],"responses":{"200":{"description":"AnalyticExtractedReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticExtractedReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticExtractedReport not found"}}},"put":{"summary":"Update an existing Analytic Extracted Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticExtractedReportById","tags":["Analytic Extracted Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Extracted Report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"basename":{"type":"string"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"savename":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"status":{"type":"string","default":"Loading"},"type":{"type":"string","enum":["manual","scheduled"],"default":"manual"},"reportId":{"type":"integer"},"reportType":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticExtractedReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticExtractedReport not found"}}}},"/analytics/extracted_reports/{id}/download":{"get":{"summary":"Download Extracted Report","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Analytic Extracted Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticExtractedReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/extracted_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Extracted Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticExtractedReportById","tags":["Analytic Extracted Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticExtractedReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticExtractedReport not found"}}}},"/analytics/field_reports":{"get":{"summary":"Gets a list of Analytic Field Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticFieldReport","tags":["Analytic Field Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticFieldReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Field Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticFieldReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Field Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticFieldReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Field Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticFieldReport","tags":["Analytic Field Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Field Report","content":{"application/json":{"schema":{"type":"object","properties":{"field":{"type":"string"},"alias":{"type":"string"},"function":{"type":"string"},"format":{"type":"string"},"groupBy":{"type":"boolean","default":false},"orderBy":{"type":"string"},"custom":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"AnalyticFieldReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticFieldReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/field_reports/{id}":{"get":{"summary":"Gets a single Analytic Field Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticFieldReportById","tags":["Analytic Field Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticFieldReport to get"}],"responses":{"200":{"description":"AnalyticFieldReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticFieldReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticFieldReport not found"}}},"put":{"summary":"Update an existing Analytic Field Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticFieldReportById","tags":["Analytic Field Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Field Report","content":{"application/json":{"schema":{"type":"object","properties":{"field":{"type":"string"},"alias":{"type":"string"},"function":{"type":"string"},"format":{"type":"string"},"groupBy":{"type":"boolean","default":false},"orderBy":{"type":"string"},"custom":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticFieldReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticFieldReport not found"}}},"delete":{"summary":"Deletes many Analytic Field Reports","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticFieldReport","tags":["Analytic Field Reports"],"parameters":[{"in":"query","name":"ids","style":"form","explode":false,"schema":{"type":"integer"},"required":true,"description":"Numeric ids of the AnalyticFieldReport to be deleted, as a comma-separated list. E.g. `ids=1,2,3` deletes elements with id = 1, 2 and 3"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticFieldReport not found"}}}},"/analytics/field_reports/create_many":{"post":{"summary":"Creates many Analytic Field Reports","security":[{"BearerAuth":[]}],"operationId":"createManyAnalyticFieldReport","tags":["Analytic Field Reports"],"requestBody":{"required":true,"description":"data for the creation of many Analytic Field Reports","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"alias":{"type":"string"},"function":{"type":"string"},"format":{"type":"string"},"groupBy":{"type":"boolean","default":false},"orderBy":{"type":"string"},"custom":{"type":"boolean","default":false}}}}}}},"responses":{"201":{"description":"Successfully created."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/field_reports/{id}/create_many":{"post":{"summary":"Rewrite fields set","security":[{"BearerAuth":[]}],"operationId":"addFields","tags":["Analytic Field Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticFieldReport"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/field_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Field Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticFieldReportById","tags":["Analytic Field Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticFieldReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticFieldReport not found"}}}},"/analytics/metrics":{"get":{"summary":"Gets a list of Analytic Metric","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticMetric","tags":["Analytic Metrics"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticMetric"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Metric","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticMetric"}}}}},"206":{"description":"Partial (paged) collection of Analytic Metric","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticMetric"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Metrics","security":[{"BearerAuth":[]}],"operationId":"createAnalyticMetric","tags":["Analytic Metrics"],"requestBody":{"required":true,"description":"data for creating a new Analytic Metrics","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"table":{"type":"string"},"metric":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"AnalyticMetric successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticMetric"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/metrics/{id}":{"get":{"summary":"Gets a single Analytic Metrics","security":[{"BearerAuth":[]}],"operationId":"getAnalyticMetricById","tags":["Analytic Metrics"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticMetric to get"}],"responses":{"200":{"description":"AnalyticMetric with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticMetric"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticMetric not found"}}},"put":{"summary":"Update an existing Analytic Metrics","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticMetricById","tags":["Analytic Metrics"],"requestBody":{"required":true,"description":"data for updating a new Analytic Metrics","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"table":{"type":"string"},"metric":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticMetric to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticMetric not found"}}}},"/analytics/metrics/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Metrics","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticMetricById","tags":["Analytic Metrics"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticMetric to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticMetric not found"}}}},"/analytics/tree_reports":{"get":{"summary":"Gets a list of Analytic Tree Reports","security":[{"BearerAuth":[]}],"operationId":"listAllAnalyticTreeReport","tags":["Analytic Tree Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each AnalyticTreeReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Analytic Tree Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticTreeReport"}}}}},"206":{"description":"Partial (paged) collection of Analytic Tree Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticTreeReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Analytic Tree Report","security":[{"BearerAuth":[]}],"operationId":"createAnalyticTreeReport","tags":["Analytic Tree Reports"],"requestBody":{"required":true,"description":"data for creating a new Analytic Tree Report","content":{"application/json":{"schema":{"type":"object","properties":{"tree":{"type":"string"}},"required":["tree"]}}}},"responses":{"201":{"description":"AnalyticTreeReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticTreeReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/analytics/tree_reports/{id}":{"get":{"summary":"Gets a single Analytic Tree Report","security":[{"BearerAuth":[]}],"operationId":"getAnalyticTreeReportById","tags":["Analytic Tree Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticTreeReport to get"}],"responses":{"200":{"description":"AnalyticTreeReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticTreeReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticTreeReport not found"}}},"put":{"summary":"Update an existing Analytic Tree Report","security":[{"BearerAuth":[]}],"operationId":"updateAnalyticTreeReportById","tags":["Analytic Tree Reports"],"requestBody":{"required":true,"description":"data for updating a new Analytic Tree Report","content":{"application/json":{"schema":{"type":"object","properties":{"tree":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticTreeReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticTreeReport not found"}}}},"/analytics/tree_reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Analytic Tree Report","security":[{"BearerAuth":[]}],"operationId":"deleteAnalyticTreeReportById","tags":["Analytic Tree Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the AnalyticTreeReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"AnalyticTreeReport not found"}}}},"/attachments":{"get":{"summary":"Gets a list of Attachments","security":[{"BearerAuth":[]}],"operationId":"listAllAttachment","tags":["Attachments"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Attachment"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Attachments","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}},"206":{"description":"Partial (paged) collection of Attachments","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/attachments/{id}":{"get":{"summary":"Gets a single Attachment","security":[{"BearerAuth":[]}],"operationId":"getAttachmentById","tags":["Attachments"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Attachment to get"}],"responses":{"200":{"description":"Attachment with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attachment"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Attachment not found"}}},"put":{"summary":"Update an existing Attachment","security":[{"BearerAuth":[]}],"operationId":"updateAttachmentById","tags":["Attachments"],"requestBody":{"required":true,"description":"data for updating a new Attachment","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"basename":{"type":"string"},"type":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Attachment to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Attachment not found"}}}},"/attachments/{id}/download":{"get":{"summary":"Download attachment","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Attachments"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Attachment"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/attachments/clone":{"post":{"summary":"Clone an existing Attachment","security":[{"BearerAuth":[]}],"operationId":"cloneAttachment","tags":["Attachments"],"requestBody":{"required":true,"description":"data for creating a new Attachment","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Attachment to clone"},"name":{"type":"string"},"basename":{"type":"string"},"type":{"type":"string"}},"required":["id"]}}}},"responses":{"201":{"description":"Attachment successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attachment"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/attachments/":{"post":{"summary":"Add attachment","security":[{"BearerAuth":[]}],"operationId":"postcreate","tags":["Attachments"],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/attachments/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Attachment","security":[{"BearerAuth":[]}],"operationId":"deleteAttachmentById","tags":["Attachments"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Attachment to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Attachment not found"}}}},"/auth/google":{"post":{"summary":"Creates a new User token using Google login","operationId":"googleLogin","tags":["Authentication"],"requestBody":{"required":true,"description":"Google user credentials","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"the username"},"password":{"type":"string","format":"password","description":"the user password"}},"required":["name","password"]}}}},"responses":{"201":{"description":"login success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"user id"},"statusCall":{"type":"string","description":"user call status"},"token":{"type":"string","description":"jwt for authenticated calls"}}}}}},"401":{"description":"Not authenticated","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"the authentication error"}}}}}}}}},"/auth/local":{"post":{"summary":"Creates a new User token","operationId":"localLogin","tags":["Authentication"],"requestBody":{"required":true,"description":"user credentials","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"the username"},"password":{"type":"string","format":"password","description":"the user password"}},"required":["name","password"]}}}},"responses":{"201":{"description":"login success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"user id"},"statusCall":{"type":"string","description":"user call status"},"token":{"type":"string","description":"jwt for authenticated calls"}}}}}},"401":{"description":"Not authenticated","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"the authentication error"}}}}}}}}},"/auth/local/forgot":{"post":{"summary":"Creates a new password reset token","operationId":"localForgotPassword","tags":["Authentication"],"requestBody":{"required":true,"description":"the email to which the reset token will be sent","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"the user email used during registration"}},"required":["email"]}}}},"responses":{"201":{"description":"password reset token successfully issued"}}}},"/auth/local/reset/{token}":{"post":{"summary":"Reset user password","operationId":"localResetPassword","tags":["Authentication"],"parameters":[{"in":"path","name":"token","schema":{"type":"string"},"required":true,"description":"token issued by `/auth/local/forgot`"}],"requestBody":{"required":true,"description":"the new password for the user","content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","format":"password","description":"the new user password"}},"required":["password"]}}}},"responses":{"201":{"description":"password reset success"}}}},"/automations":{"get":{"summary":"Gets a list of Automations","security":[{"BearerAuth":[]}],"operationId":"listAllAutomation","tags":["Automations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Automation"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Automations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation"}}}}},"206":{"description":"Partial (paged) collection of Automations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Automation","security":[{"BearerAuth":[]}],"operationId":"createAutomation","tags":["Automations"],"requestBody":{"required":true,"description":"data for creating a new Automation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"string"},"description":{"type":"string"},"status":{"type":"boolean","default":false},"timeout":{"type":"integer","default":10}},"required":["name"]}}}},"responses":{"201":{"description":"Automation successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/automations/{id}":{"get":{"summary":"Gets a single Automation","security":[{"BearerAuth":[]}],"operationId":"getAutomationById","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation to get"}],"responses":{"200":{"description":"Automation with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Automation not found"}}},"put":{"summary":"Update an existing Automation","security":[{"BearerAuth":[]}],"operationId":"updateAutomationById","tags":["Automations"],"requestBody":{"required":true,"description":"data for updating a new Automation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"string"},"description":{"type":"string"},"status":{"type":"boolean","default":false},"timeout":{"type":"integer","default":10}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Automation not found"}}}},"/automations/{id}/conditions":{"get":{"summary":"Gets Automation Conditions","security":[{"BearerAuth":[]}],"operationId":"getConditions","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new conditions","security":[{"BearerAuth":[]}],"operationId":"addConditions","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/automations/{id}/actions":{"get":{"summary":"Gets Automation Actions","security":[{"BearerAuth":[]}],"operationId":"getActions","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new actions","security":[{"BearerAuth":[]}],"operationId":"addActions","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/automations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Automation","security":[{"BearerAuth":[]}],"operationId":"deleteAutomationById","tags":["Automations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Automation to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Automation not found"}}}},"/campaigns":{"get":{"summary":"Gets a list of IVR Campaigns","security":[{"BearerAuth":[]}],"operationId":"listAllCampaign","tags":["IVR Campaigns"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Campaign"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of IVR Campaigns","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}}}}},"206":{"description":"Partial (paged) collection of IVR Campaigns","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"createCampaign","tags":["IVR Campaigns"],"requestBody":{"required":true,"description":"data for creating a new IVR Campaign","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["ivr"],"default":"ivr"},"description":{"type":"string"},"active":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"limitCalls":{"type":"integer","description":"Max 200 calls.","default":30},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialPrefix":{"type":"string","default":null},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150}},"required":["name","type"]}}}},"responses":{"201":{"description":"Campaign successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}":{"get":{"summary":"Gets a single IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"getCampaignById","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign to get"}],"responses":{"200":{"description":"Campaign with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Campaign not found"}}},"put":{"summary":"Update an existing IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"updateCampaignById","tags":["IVR Campaigns"],"requestBody":{"required":true,"description":"data for updating a new IVR Campaign","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["ivr"],"default":"ivr"},"description":{"type":"string"},"active":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"limitCalls":{"type":"integer","description":"Max 200 calls.","default":30},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialPrefix":{"type":"string","default":null},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Campaign not found"}}}},"/campaigns/{id}/hoppers":{"get":{"summary":"Gets IVR campaign hoppers","security":[{"BearerAuth":[]}],"operationId":"getHoppers","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/hopper_histories":{"get":{"summary":"Gets IVR campaign hopper histories","security":[{"BearerAuth":[]}],"operationId":"getHopperHistories","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/hopper_finals":{"get":{"summary":"Gets IVR campaign hopper finals","security":[{"BearerAuth":[]}],"operationId":"getHopperFinals","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/hopper_black":{"get":{"summary":"Gets IVR campaign hopper blacks","security":[{"BearerAuth":[]}],"operationId":"getHopperBlacks","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/lists":{"get":{"summary":"Get IVR campaign lists","security":[{"BearerAuth":[]}],"operationId":"getLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add lists to an IVR campaign","security":[{"BearerAuth":[]}],"operationId":"addLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove lists from an IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"removeLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/blacklists":{"get":{"summary":"Get IVR campaign blacklists","security":[{"BearerAuth":[]}],"operationId":"getBlackLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add blacklists to an IVR campaign","security":[{"BearerAuth":[]}],"operationId":"addBlackLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove blacklists from an IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"removeBlackLists","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/clone":{"post":{"summary":"Clone an existing IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"cloneCampaign","tags":["IVR Campaigns"],"requestBody":{"required":true,"description":"data for creating a new IVR Campaign","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the IVR Campaign to clone"},"name":{"type":"string"},"type":{"type":"string","enum":["ivr"],"default":"ivr"},"description":{"type":"string"},"active":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"limitCalls":{"type":"integer","description":"Max 200 calls.","default":30},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialPrefix":{"type":"string","default":null},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150}},"required":["id"]}}}},"responses":{"201":{"description":"Campaign successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/campaigns/{id}/destroy_many":{"delete":{"summary":"Destroy an existing IVR Campaign","security":[{"BearerAuth":[]}],"operationId":"deleteCampaignById","tags":["IVR Campaigns"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Campaign to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Campaign not found"}}}},"/canned_answers":{"get":{"summary":"Gets a list of Canned Answers","security":[{"BearerAuth":[]}],"operationId":"listAllCannedAnswer","tags":["Canned Answers"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CannedAnswer"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Canned Answers","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CannedAnswer"}}}}},"206":{"description":"Partial (paged) collection of Canned Answers","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CannedAnswer"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/canned_answers/{id}":{"get":{"summary":"Gets a single Canned Answer","security":[{"BearerAuth":[]}],"operationId":"getCannedAnswerById","tags":["Canned Answers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CannedAnswer to get"}],"responses":{"200":{"description":"CannedAnswer with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CannedAnswer"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CannedAnswer not found"}}},"put":{"summary":"Update an existing Canned Answer","security":[{"BearerAuth":[]}],"operationId":"updateCannedAnswerById","tags":["Canned Answers"],"requestBody":{"required":true,"description":"data for updating a new Canned Answer","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CannedAnswer to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CannedAnswer not found"}}}},"/canned_answers/":{"post":{"summary":"Create a new canned answer","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Canned Answers"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/canned_answers/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Canned Answer","security":[{"BearerAuth":[]}],"operationId":"deleteCannedAnswerById","tags":["Canned Answers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CannedAnswer to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CannedAnswer not found"}}}},"/cdr":{"get":{"summary":"Gets a list of Cdrs","security":[{"BearerAuth":[]}],"operationId":"listAllCdr","tags":["cdr"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Cdr"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Cdrs","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cdr"}}}}},"206":{"description":"Partial (paged) collection of Cdrs","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cdr"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Cdr","security":[{"BearerAuth":[]}],"operationId":"createCdr","tags":["cdr"],"requestBody":{"required":true,"description":"data for creating a new Cdr","content":{"application/json":{"schema":{"type":"object","properties":{"calldate":{"type":"string","default":"1970-01-01 00:00:01"},"clid":{"type":"string"},"src":{"type":"string"},"dst":{"type":"string"},"dcontext":{"type":"string"},"channel":{"type":"string"},"dstchannel":{"type":"string"},"lastapp":{"type":"string"},"lastdata":{"type":"string"},"duration":{"type":"integer","default":0},"billsec":{"type":"integer","default":0},"disposition":{"type":"string"},"amaflags":{"type":"integer","default":0},"accountcode":{"type":"string"},"userfield":{"type":"string"},"uniqueid":{"type":"string"},"linkedid":{"type":"string"},"sequence":{"type":"string"},"peeraccount":{"type":"string"},"type":{"type":"string"},"tag":{"type":"string"}},"required":["calldate","duration","billsec","amaflags"]}}}},"responses":{"201":{"description":"Cdr successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cdr"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cdr/describe":{"get":{"summary":"Gets table info about Cdrs","security":[{"BearerAuth":[]}],"operationId":"describeCdr","tags":["cdr"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cdr/{id}":{"get":{"summary":"Gets a single Cdr","security":[{"BearerAuth":[]}],"operationId":"getCdrById","tags":["cdr"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Cdr to get"}],"responses":{"200":{"description":"Cdr with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cdr"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Cdr not found"}}},"put":{"summary":"Update an existing Cdr","security":[{"BearerAuth":[]}],"operationId":"updateCdrById","tags":["cdr"],"requestBody":{"required":true,"description":"data for updating a new Cdr","content":{"application/json":{"schema":{"type":"object","properties":{"calldate":{"type":"string","default":"1970-01-01 00:00:01"},"clid":{"type":"string"},"src":{"type":"string"},"dst":{"type":"string"},"dcontext":{"type":"string"},"channel":{"type":"string"},"dstchannel":{"type":"string"},"lastapp":{"type":"string"},"lastdata":{"type":"string"},"duration":{"type":"integer","default":0},"billsec":{"type":"integer","default":0},"disposition":{"type":"string"},"amaflags":{"type":"integer","default":0},"accountcode":{"type":"string"},"userfield":{"type":"string"},"uniqueid":{"type":"string"},"linkedid":{"type":"string"},"sequence":{"type":"string"},"peeraccount":{"type":"string"},"type":{"type":"string"},"tag":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Cdr to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Cdr not found"}}}},"/cdr/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Cdr","security":[{"BearerAuth":[]}],"operationId":"deleteCdrById","tags":["cdr"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Cdr to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Cdr not found"}}}},"/chat/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getChatApplicationById","tags":["Chat Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatApplication to get"}],"responses":{"200":{"description":"ChatApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateChatApplicationById","tags":["Chat Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatApplication not found"}}}},"/chat/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteChatApplicationById","tags":["Chat Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatApplication not found"}}}},"/chat/groups":{"get":{"summary":"Gets a list of Groups","security":[{"BearerAuth":[]}],"operationId":"listAllChatGroup","tags":["Chat Groups"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatGroup"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Groups","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatGroup"}}}}},"206":{"description":"Partial (paged) collection of Groups","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatGroup"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Group","security":[{"BearerAuth":[]}],"operationId":"createChatGroup","tags":["Chat Groups"],"requestBody":{"required":true,"description":"data for creating a new Group","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"write":{"type":"boolean","default":true}},"required":["name"]}}}},"responses":{"201":{"description":"ChatGroup successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatGroup"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/describe":{"get":{"summary":"Gets table info about Groups","security":[{"BearerAuth":[]}],"operationId":"describeChatGroup","tags":["Chat Groups"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/{id}":{"get":{"summary":"Gets a single Group","security":[{"BearerAuth":[]}],"operationId":"getChatGroupById","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup to get"}],"responses":{"200":{"description":"ChatGroup with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatGroup"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatGroup not found"}}},"put":{"summary":"Update an existing Group","security":[{"BearerAuth":[]}],"operationId":"updateChatGroupById","tags":["Chat Groups"],"requestBody":{"required":true,"description":"data for updating a new Group","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"write":{"type":"boolean","default":true}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatGroup not found"}}}},"/chat/groups/{id}/unread":{"get":{"summary":"Get unread chat group messages","security":[{"BearerAuth":[]}],"operationId":"getUnread","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/{id}/members":{"get":{"summary":"Gets Members","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add members to chat group","security":[{"BearerAuth":[]}],"operationId":"addMembers","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes members from a group","security":[{"BearerAuth":[]}],"operationId":"removeMembers","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/{id}/messages":{"get":{"summary":"Gets Messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new group message","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/groups/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Group","security":[{"BearerAuth":[]}],"operationId":"deleteChatGroupById","tags":["Chat Groups"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatGroup to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatGroup not found"}}}},"/chat/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllChatInteraction","tags":["Chat Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createChatInteraction","tags":["Chat Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"ratingValue":{"type":"integer"},"ratingType":{"type":"string","enum":["star","thumb"],"default":"star"},"ratingMessage":{"type":"string"},"pathTranscript":{"type":"string"},"mailTranscript":{"type":"string"},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"browserName":{"type":"string"},"browserVersion":{"type":"string"},"osName":{"type":"string"},"osVersion":{"type":"string"},"deviceModel":{"type":"string"},"deviceVendor":{"type":"string"},"deviceType":{"type":"string"},"referer":{"type":"string"},"customerIp":{"type":"string"},"formData":{"type":"string"},"read1stAt":{"type":"string"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"closeReason":{"type":"string"},"customerPort":{"type":"string"},"vidaooSessionId":{"type":"string"}},"required":["lastMsgDirection"]}}}},"responses":{"201":{"description":"ChatInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeChatInteraction","tags":["Chat Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/{id}":{"get":{"summary":"Gets a single Interaction","operationId":"getChatInteractionById","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction to get"}],"responses":{"200":{"description":"ChatInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInteraction"}}}},"404":{"description":"ChatInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateChatInteractionById","tags":["Chat Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"ratingValue":{"type":"integer"},"ratingType":{"type":"string","enum":["star","thumb"],"default":"star"},"ratingMessage":{"type":"string"},"pathTranscript":{"type":"string"},"mailTranscript":{"type":"string"},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"browserName":{"type":"string"},"browserVersion":{"type":"string"},"osName":{"type":"string"},"osVersion":{"type":"string"},"deviceModel":{"type":"string"},"deviceVendor":{"type":"string"},"deviceType":{"type":"string"},"referer":{"type":"string"},"customerIp":{"type":"string"},"formData":{"type":"string"},"read1stAt":{"type":"string"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"closeReason":{"type":"string"},"customerPort":{"type":"string"},"vidaooSessionId":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatInteraction not found"}}}},"/chat/interactions/{id}/attachment_download":{"get":{"summary":"Download attachment","operationId":"attachmentDownload","tags":["Attachments"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/chat/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","operationId":"addMessage","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"201":{"description":"successfully created"}}}},"/chat/interactions/{id}/my_messages":{"get":{"summary":"Gets interaction messages","operationId":"getMyMessages","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/chat/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/{id}/vidaoo":{"post":{"summary":"Create Vidaoo Session","security":[{"BearerAuth":[]}],"operationId":"createVidaooSession","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/{id}/attachment_upload":{"post":{"summary":"Add attachment","operationId":"postattachmentUpload","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."}}}},"/chat/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/interactions/{id}/custom_update":{"put":{"summary":"Update interaction","operationId":"customUpdate","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"successfully updated"}}}},"/chat/interactions/{id}/abandon":{"put":{"summary":"Abandon interaction","operationId":"abandon","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"successfully updated"}}}},"/chat/interactions/{id}/close":{"put":{"summary":"Close Interaction","operationId":"close","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction"}],"responses":{"200":{"description":"successfully updated"}}}},"/chat/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteChatInteractionById","tags":["Chat Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatInteraction not found"}}}},"/chat/internal/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllChatInternalMessage","tags":["Chat Internal Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatInternalMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatInternalMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatInternalMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createChatInternalMessage","tags":["Chat Internal Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"ChatInternalMessageId":{"type":"integer"}},"required":["body"]}}}},"responses":{"201":{"description":"ChatInternalMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInternalMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/internal/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeChatInternalMessage","tags":["Chat Internal Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/internal/messages/users":{"get":{"summary":"Gets Users Last Messages","security":[{"BearerAuth":[]}],"operationId":"getUsers","tags":["ChatInternalMessage"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/internal/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getChatInternalMessageById","tags":["Chat Internal Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInternalMessage to get"}],"responses":{"200":{"description":"ChatInternalMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatInternalMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatInternalMessage not found"}}},"put":{"summary":"Update an existing Message","operationId":"updateChatInternalMessageById","tags":["Chat Internal Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"ChatInternalMessageId":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInternalMessage to be updated"}],"responses":{"200":{"description":"successful update"},"404":{"description":"ChatInternalMessage not found"}}}},"/chat/internal/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteChatInternalMessageById","tags":["Chat Internal Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatInternalMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatInternalMessage not found"}}}},"/chat/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllChatMessage","tags":["Chat Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createChatMessage","tags":["Chat Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"secret":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"ChatMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeChatMessage","tags":["Chat Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getChatMessageById","tags":["Chat Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage to get"}],"responses":{"200":{"description":"ChatMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatMessage not found"}}},"put":{"summary":"Update an existing Message","operationId":"updateChatMessageById","tags":["Chat Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"secret":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage to be updated"}],"responses":{"200":{"description":"successful update"},"404":{"description":"ChatMessage not found"}}}},"/chat/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteChatMessageById","tags":["Chat Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatMessage not found"}}}},"/chat/offline_messages":{"get":{"summary":"Gets a list of OfflineMessages","security":[{"BearerAuth":[]}],"operationId":"listAllChatOfflineMessage","tags":["Chat Offline Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatOfflineMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of OfflineMessages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatOfflineMessage"}}}}},"206":{"description":"Partial (paged) collection of OfflineMessages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatOfflineMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new OfflineMessage","security":[{"BearerAuth":[]}],"operationId":"createChatOfflineMessage","tags":["Chat Offline Messages"],"requestBody":{"required":true,"description":"data for creating a new OfflineMessage","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"}},"required":["body"]}}}},"responses":{"201":{"description":"ChatOfflineMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatOfflineMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/offline_messages/describe":{"get":{"summary":"Gets table info about OfflineMessages","security":[{"BearerAuth":[]}],"operationId":"describeChatOfflineMessage","tags":["Chat Offline Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/offline_messages/{id}":{"get":{"summary":"Gets a single OfflineMessage","security":[{"BearerAuth":[]}],"operationId":"getChatOfflineMessageById","tags":["Chat Offline Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatOfflineMessage to get"}],"responses":{"200":{"description":"ChatOfflineMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatOfflineMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatOfflineMessage not found"}}},"put":{"summary":"Update an existing OfflineMessage","security":[{"BearerAuth":[]}],"operationId":"updateChatOfflineMessageById","tags":["Chat Offline Messages"],"requestBody":{"required":true,"description":"data for updating a new OfflineMessage","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatOfflineMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatOfflineMessage not found"}}}},"/chat/offline_messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing OfflineMessage","security":[{"BearerAuth":[]}],"operationId":"deleteChatOfflineMessageById","tags":["Chat Offline Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatOfflineMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatOfflineMessage not found"}}}},"/chat/proactive_actions/{id}":{"get":{"summary":"Gets a single Proactive Action","security":[{"BearerAuth":[]}],"operationId":"getChatProactiveActionById","tags":["Chat Proactive Actions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatProactiveAction to get"}],"responses":{"200":{"description":"ChatProactiveAction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatProactiveAction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatProactiveAction not found"}}},"put":{"summary":"Update an existing Proactive Action","security":[{"BearerAuth":[]}],"operationId":"updateChatProactiveActionById","tags":["Chat Proactive Actions"],"requestBody":{"required":true,"description":"data for updating a new Proactive Action","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["mouseOver","timeout"],"default":"mouseOver"},"selector":{"type":"string"},"timeout":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatProactiveAction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatProactiveAction not found"}}}},"/chat/proactive_actions":{"post":{"summary":"Creates a new Proactive Action","security":[{"BearerAuth":[]}],"operationId":"createChatProactiveAction","tags":["Chat Proactive Actions"],"requestBody":{"required":true,"description":"data for creating a new Proactive Action","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["mouseOver","timeout"],"default":"mouseOver"},"selector":{"type":"string"},"timeout":{"type":"integer"}},"required":["name"]}}}},"responses":{"201":{"description":"ChatProactiveAction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatProactiveAction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/proactive_actions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Proactive Action","security":[{"BearerAuth":[]}],"operationId":"deleteChatProactiveActionById","tags":["Chat Proactive Actions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatProactiveAction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatProactiveAction not found"}}}},"/chat/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllChatQueue","tags":["Chat Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createChatQueue","tags":["Chat Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}},"required":["name"]}}}},"responses":{"201":{"description":"ChatQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeChatQueue","tags":["Chat Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getChatQueueById","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue to get"}],"responses":{"200":{"description":"ChatQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateChatQueueById","tags":["Chat Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueue not found"}}}},"/chat/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteChatQueueById","tags":["Chat Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueue not found"}}}},"/chat/reports/queue":{"get":{"summary":"Gets a list of Chat Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllChatQueueReport","tags":["Chat Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Chat Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Chat Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Chat Queue Report","security":[{"BearerAuth":[]}],"operationId":"createChatQueueReport","tags":["Chat Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Chat Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"ChatQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/reports/queue/describe":{"get":{"summary":"Gets table info about Chat Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeChatQueueReport","tags":["Chat Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/reports/queue/{id}":{"get":{"summary":"Gets a single Chat Queue Report","security":[{"BearerAuth":[]}],"operationId":"getChatQueueReportById","tags":["Chat Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueueReport to get"}],"responses":{"200":{"description":"ChatQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueueReport not found"}}},"put":{"summary":"Update an existing Chat Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateChatQueueReportById","tags":["Chat Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Chat Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueueReport not found"}}}},"/chat/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Chat Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteChatQueueReportById","tags":["Chat Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatQueueReport not found"}}}},"/chat/reports/transfer":{"get":{"summary":"Gets a list of Chat Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllChatTransferReport","tags":["Chat Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Chat Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Chat Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Chat Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createChatTransferReport","tags":["Chat Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Chat Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"ChatTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/reports/transfer/describe":{"get":{"summary":"Gets table info about Chat Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeChatTransferReport","tags":["Chat Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/reports/transfer/{id}":{"get":{"summary":"Gets a single Chat Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getChatTransferReportById","tags":["Chat Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatTransferReport to get"}],"responses":{"200":{"description":"ChatTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatTransferReport not found"}}},"put":{"summary":"Update an existing Chat Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateChatTransferReportById","tags":["Chat Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Chat Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatTransferReport not found"}}}},"/chat/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Chat Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteChatTransferReportById","tags":["Chat Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatTransferReport not found"}}}},"/chat/websites":{"get":{"summary":"Gets a list of Websites","security":[{"BearerAuth":[]}],"operationId":"listAllChatWebsite","tags":["Chat Websites"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ChatWebsite"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Websites","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatWebsite"}}}}},"206":{"description":"Partial (paged) collection of Websites","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatWebsite"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Website","security":[{"BearerAuth":[]}],"operationId":"createChatWebsite","tags":["Chat Websites"],"requestBody":{"required":true,"description":"data for creating a new Website","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"description":{"type":"string"},"mapKey":{"type":"string","default":"email"},"mapKeyOffline":{"type":"string","default":"email"},"key":{"type":"string"},"agentAlias":{"type":"string","default":"Agent"},"customerAlias":{"type":"string","default":"Me"},"color":{"type":"string","default":"#011F6A"},"color_button":{"type":"string","default":"#011F6A"},"textColor":{"type":"string","default":"#ffffff"},"fontSize":{"type":"integer","default":15},"remote":{"type":"string"},"animation":{"type":"boolean","default":true},"header_shape":{"type":"string","enum":["rounded","squared"],"default":"rounded"},"header_online":{"type":"string","default":"We are here!"},"start_chat_button":{"type":"string","default":"Chat"},"offline_chat_button":{"type":"string","default":"Send"},"header_offline":{"type":"string","default":"Contact us"},"download_transcript":{"type":"boolean","default":true},"timeout":{"type":"integer","default":0},"whiteLabel":{"type":"string","default":"Powered by xCALLY"},"defaultWhiteLabel":{"type":"boolean","default":true},"sitepic":{"type":"string"},"closingQuestion":{"type":"string","default":"Do you want to close the interaction?"},"formSubmitSuccessMessage":{"type":"string","default":"Form properly submitted"},"formSubmitFailureMessage":{"type":"string","default":"Form submission error"},"noteTitle":{"type":"string","default":"Note"},"placeholderMessage":{"type":"string","default":"Type a message"},"closingMessage":{"type":"string","default":"Thanks you for your time!"},"closingMessageButton":{"type":"string","default":"Send"},"skipMessageButton":{"type":"string","default":"Skip"},"conditionAgreement":{"type":"boolean","default":false},"enableRating":{"type":"boolean","default":false},"enableFeedback":{"type":"boolean","default":false},"enableSendButton":{"type":"boolean","default":false},"feedbackTitle":{"type":"string","default":"Feedback"},"ratingType":{"type":"string","enum":["star","thumb"],"default":"star"},"ratingStarsNumber":{"type":"integer","default":5},"onlineForm":{"type":"string","default":"{\"items\":[{\"type\":\"input\",\"variable\":null,\"config\":{\"placeholder\":\"name\",\"type\":\"text\",\"required\":true},\"props\":{\"title\":\"name\",\"helpText\":\"\"}},{\"type\":\"input\",\"props\":{\"title\":\"email\",\"helpText\":\"\"},\"config\":{\"required\":true,\"placeholder\":\"email\",\"type\":\"email\"},\"variable\":null}],\"fromKey\":1}"},"offlineForm":{"type":"string","default":"{\"items\":[{\"type\":\"input\",\"props\":{\"title\":\"email\",\"helpText\":\"\"},\"config\":{\"required\":true,\"placeholder\":\"email\",\"type\":\"email\"},\"variable\":null},{\"type\":\"textarea\",\"config\":{\"placeholder\":\"Comments\"},\"props\":{\"title\":\"Comments\",\"helpText\":\"Leave your comments\"}}],\"fromKey\":0}"},"token":{"type":"string","default":"6NYikaKczHDsD4EV1s72ZpdP7g2lv37W"},"autoclose":{"type":"boolean","default":true},"enableCustomerWriting":{"type":"boolean","default":false},"forwardTranscript":{"type":"boolean","default":false},"forwardTranscriptMessage":{"type":"string"},"forwardOffline":{"type":"boolean","default":false},"forwardOfflineAddress":{"type":"string"},"waitingTitle":{"type":"string","default":"All of our agents are busy at this time. Your chat is very important to us."},"waitingMessage":{"type":"string","default":"Please hold and we will answer your request as soon as possible."},"offlineMessageSubject":{"type":"string","default":"New offline message from websiteName"},"offlineMessageBody":{"type":"string","default":"You received a new offline message from websiteName. Here you can find the details of the request:"},"enableUnmanagedNote":{"type":"boolean","default":true},"unmanagedMessage":{"type":"string","default":"Your request has not been processed."},"skipUnmanaged":{"type":"string","default":"Skip"},"sendUnmanaged":{"type":"string","default":"Send"},"enableCustomerAttachment":{"type":"boolean","default":false},"enableCustomerCheckmarks":{"type":"boolean","default":false},"agentAvatar":{"type":"string"},"showAgentAvatar":{"type":"boolean","default":false},"timezone":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"hideWhenOffline":{"type":"boolean","default":false},"agentIdentifier":{"type":"string","default":"website_alias"},"waitForTheAssignedAgent":{"type":"integer","default":10},"alignment":{"type":"string","default":"bottom_right"},"verticalAlignment":{"type":"integer","default":30},"messagesAlignment":{"type":"string","default":"alternate"},"defaultTitle":{"type":"string"},"customerAvatar":{"type":"string"},"showCustomerAvatar":{"type":"boolean","default":false},"messageFontSize":{"type":"integer","default":12},"backgroundColor":{"type":"string","default":"#fafafa"},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"systemAlias":{"type":"string","default":"System"},"systemAvatar":{"type":"string"},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"vidaooEscalation":{"type":"boolean","default":false},"vidaooApiKey":{"type":"string","default":false}},"required":["name","address","key","color","color_button","textColor","backgroundColor"]}}}},"responses":{"201":{"description":"ChatWebsite successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatWebsite"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/describe":{"get":{"summary":"Gets table info about Websites","security":[{"BearerAuth":[]}],"operationId":"describeChatWebsite","tags":["Chat Websites"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}":{"get":{"summary":"Gets a single Website","security":[{"BearerAuth":[]}],"operationId":"getChatWebsiteById","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite to get"}],"responses":{"200":{"description":"ChatWebsite with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatWebsite"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatWebsite not found"}}},"put":{"summary":"Update an existing Website","security":[{"BearerAuth":[]}],"operationId":"updateChatWebsiteById","tags":["Chat Websites"],"requestBody":{"required":true,"description":"data for updating a new Website","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"description":{"type":"string"},"mapKey":{"type":"string","default":"email"},"mapKeyOffline":{"type":"string","default":"email"},"key":{"type":"string"},"agentAlias":{"type":"string","default":"Agent"},"customerAlias":{"type":"string","default":"Me"},"color":{"type":"string","default":"#011F6A"},"color_button":{"type":"string","default":"#011F6A"},"textColor":{"type":"string","default":"#ffffff"},"fontSize":{"type":"integer","default":15},"remote":{"type":"string"},"animation":{"type":"boolean","default":true},"header_shape":{"type":"string","enum":["rounded","squared"],"default":"rounded"},"header_online":{"type":"string","default":"We are here!"},"start_chat_button":{"type":"string","default":"Chat"},"offline_chat_button":{"type":"string","default":"Send"},"header_offline":{"type":"string","default":"Contact us"},"download_transcript":{"type":"boolean","default":true},"timeout":{"type":"integer","default":0},"whiteLabel":{"type":"string","default":"Powered by xCALLY"},"defaultWhiteLabel":{"type":"boolean","default":true},"sitepic":{"type":"string"},"closingQuestion":{"type":"string","default":"Do you want to close the interaction?"},"formSubmitSuccessMessage":{"type":"string","default":"Form properly submitted"},"formSubmitFailureMessage":{"type":"string","default":"Form submission error"},"noteTitle":{"type":"string","default":"Note"},"placeholderMessage":{"type":"string","default":"Type a message"},"closingMessage":{"type":"string","default":"Thanks you for your time!"},"closingMessageButton":{"type":"string","default":"Send"},"skipMessageButton":{"type":"string","default":"Skip"},"conditionAgreement":{"type":"boolean","default":false},"enableRating":{"type":"boolean","default":false},"enableFeedback":{"type":"boolean","default":false},"enableSendButton":{"type":"boolean","default":false},"feedbackTitle":{"type":"string","default":"Feedback"},"ratingType":{"type":"string","enum":["star","thumb"],"default":"star"},"ratingStarsNumber":{"type":"integer","default":5},"onlineForm":{"type":"string","default":"{\"items\":[{\"type\":\"input\",\"variable\":null,\"config\":{\"placeholder\":\"name\",\"type\":\"text\",\"required\":true},\"props\":{\"title\":\"name\",\"helpText\":\"\"}},{\"type\":\"input\",\"props\":{\"title\":\"email\",\"helpText\":\"\"},\"config\":{\"required\":true,\"placeholder\":\"email\",\"type\":\"email\"},\"variable\":null}],\"fromKey\":1}"},"offlineForm":{"type":"string","default":"{\"items\":[{\"type\":\"input\",\"props\":{\"title\":\"email\",\"helpText\":\"\"},\"config\":{\"required\":true,\"placeholder\":\"email\",\"type\":\"email\"},\"variable\":null},{\"type\":\"textarea\",\"config\":{\"placeholder\":\"Comments\"},\"props\":{\"title\":\"Comments\",\"helpText\":\"Leave your comments\"}}],\"fromKey\":0}"},"token":{"type":"string","default":"sUS2aAfQTKplrp7C7e7Y0msoJi1Tvt11"},"autoclose":{"type":"boolean","default":true},"enableCustomerWriting":{"type":"boolean","default":false},"forwardTranscript":{"type":"boolean","default":false},"forwardTranscriptMessage":{"type":"string"},"forwardOffline":{"type":"boolean","default":false},"forwardOfflineAddress":{"type":"string"},"waitingTitle":{"type":"string","default":"All of our agents are busy at this time. Your chat is very important to us."},"waitingMessage":{"type":"string","default":"Please hold and we will answer your request as soon as possible."},"offlineMessageSubject":{"type":"string","default":"New offline message from websiteName"},"offlineMessageBody":{"type":"string","default":"You received a new offline message from websiteName. Here you can find the details of the request:"},"enableUnmanagedNote":{"type":"boolean","default":true},"unmanagedMessage":{"type":"string","default":"Your request has not been processed."},"skipUnmanaged":{"type":"string","default":"Skip"},"sendUnmanaged":{"type":"string","default":"Send"},"enableCustomerAttachment":{"type":"boolean","default":false},"enableCustomerCheckmarks":{"type":"boolean","default":false},"agentAvatar":{"type":"string"},"showAgentAvatar":{"type":"boolean","default":false},"timezone":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"hideWhenOffline":{"type":"boolean","default":false},"agentIdentifier":{"type":"string","default":"website_alias"},"waitForTheAssignedAgent":{"type":"integer","default":10},"alignment":{"type":"string","default":"bottom_right"},"verticalAlignment":{"type":"integer","default":30},"messagesAlignment":{"type":"string","default":"alternate"},"defaultTitle":{"type":"string"},"customerAvatar":{"type":"string"},"showCustomerAvatar":{"type":"boolean","default":false},"messageFontSize":{"type":"integer","default":12},"backgroundColor":{"type":"string","default":"#fafafa"},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"systemAlias":{"type":"string","default":"System"},"systemAvatar":{"type":"string"},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"vidaooEscalation":{"type":"boolean","default":false},"vidaooApiKey":{"type":"string","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatWebsite not found"}}}},"/chat/websites/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/logo":{"get":{"summary":"Get logo","operationId":"getLogo","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add logo","security":[{"BearerAuth":[]}],"operationId":"postaddLogo","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/avatar":{"get":{"summary":"Get avatar","operationId":"getAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add avatar","security":[{"BearerAuth":[]}],"operationId":"postaddAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/customer_avatar":{"get":{"summary":"Get Customer Avatar","operationId":"getCustomerAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add customer avatar","security":[{"BearerAuth":[]}],"operationId":"postaddCustomerAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/system_avatar":{"get":{"summary":"Get System Avatar","operationId":"getSystemAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add system avatar","security":[{"BearerAuth":[]}],"operationId":"postaddSystemAvatar","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/interactions":{"get":{"summary":"Gets Website Interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new interactions","security":[{"BearerAuth":[]}],"operationId":"addInteraction","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/snippet":{"get":{"summary":"Gets Website Snippet","operationId":"getSnippet","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/chat/websites/{id}/applications":{"get":{"summary":"Gets Website Applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/proactive_actions":{"get":{"summary":"Gets Website Proactive Actions","security":[{"BearerAuth":[]}],"operationId":"getProactiveActions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new Proactive Actions","security":[{"BearerAuth":[]}],"operationId":"addProactiveActions","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/fields":{"get":{"summary":"Gets Website Fields","operationId":"getFields","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/chat/websites/{id}/offline_messages":{"get":{"summary":"Gets Website Offline Messages","security":[{"BearerAuth":[]}],"operationId":"getOfflineMessages","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/users":{"get":{"summary":"Gets agents from website","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a website","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a website","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/chat/websites/{id}/notify":{"post":{"summary":"Notify new message","operationId":"notify","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"}}}},"/chat/websites/{id}/offline":{"post":{"summary":"Offline message","operationId":"offline","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite"}],"responses":{"201":{"description":"successfully created"}}}},"/chat/websites/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Website","security":[{"BearerAuth":[]}],"operationId":"deleteChatWebsiteById","tags":["Chat Websites"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChatWebsite to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ChatWebsite not found"}}}},"/cloudProviders":{"get":{"summary":"Gets a list of CloudProviders","security":[{"BearerAuth":[]}],"operationId":"listAllCloudProvider","tags":["CloudProviders"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CloudProvider"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of CloudProviders","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudProvider"}}}}},"206":{"description":"Partial (paged) collection of CloudProviders","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudProvider"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new CloudProvider","security":[{"BearerAuth":[]}],"operationId":"createCloudProvider","tags":["CloudProviders"],"requestBody":{"required":true,"description":"data for creating a new CloudProvider","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"service":{"type":"string","enum":["AmazonAWS","Google"]},"data1":{"type":"string"},"data2":{"type":"string"}},"required":["name","service"]}}}},"responses":{"201":{"description":"CloudProvider successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudProvider"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cloudProviders/{id}":{"get":{"summary":"Gets a single CloudProvider","security":[{"BearerAuth":[]}],"operationId":"getCloudProviderById","tags":["CloudProviders"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CloudProvider to get"}],"responses":{"200":{"description":"CloudProvider with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudProvider"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CloudProvider not found"}}},"put":{"summary":"Update an existing CloudProvider","security":[{"BearerAuth":[]}],"operationId":"updateCloudProviderById","tags":["CloudProviders"],"requestBody":{"required":true,"description":"data for updating a new CloudProvider","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"service":{"type":"string","enum":["AmazonAWS","Google"]},"data1":{"type":"string"},"data2":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CloudProvider to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CloudProvider not found"}}}},"/cloudProviders/{id}/destroy_many":{"delete":{"summary":"Destroy an existing CloudProvider","security":[{"BearerAuth":[]}],"operationId":"deleteCloudProviderById","tags":["CloudProviders"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CloudProvider to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CloudProvider not found"}}}},"/cm/companies":{"get":{"summary":"Gets a list of Companies","security":[{"BearerAuth":[]}],"operationId":"listAllCmCompany","tags":["Cm Companies"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmCompany"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Companies","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmCompany"}}}}},"206":{"description":"Partial (paged) collection of Companies","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmCompany"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Company","security":[{"BearerAuth":[]}],"operationId":"createCmCompany","tags":["Cm Companies"],"requestBody":{"required":true,"description":"data for creating a new Company","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"vat":{"type":"string"},"companyId":{"type":"string"},"website":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"type":{"type":"string"},"street":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"emailDomain":{"type":"string"},"sStreet":{"type":"string"},"sPostalCode":{"type":"string"},"sCity":{"type":"string"},"sCountry":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"CmCompany successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmCompany"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/companies/describe":{"get":{"summary":"Gets table info about Companies","security":[{"BearerAuth":[]}],"operationId":"describeCmCompany","tags":["Cm Companies"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/companies/{id}":{"get":{"summary":"Gets a single Company","security":[{"BearerAuth":[]}],"operationId":"getCmCompanyById","tags":["Cm Companies"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany to get"}],"responses":{"200":{"description":"CmCompany with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmCompany"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCompany not found"}}},"put":{"summary":"Update an existing Company","security":[{"BearerAuth":[]}],"operationId":"updateCmCompanyById","tags":["Cm Companies"],"requestBody":{"required":true,"description":"data for updating a new Company","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"vat":{"type":"string"},"companyId":{"type":"string"},"website":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"type":{"type":"string"},"street":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"emailDomain":{"type":"string"},"sStreet":{"type":"string"},"sPostalCode":{"type":"string"},"sCity":{"type":"string"},"sCountry":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCompany not found"}}}},"/cm/companies/{id}/contacts":{"get":{"summary":"Gets List Contacts","security":[{"BearerAuth":[]}],"operationId":"getContacts","tags":["Cm Companies"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new contacts","security":[{"BearerAuth":[]}],"operationId":"addContacts","tags":["Cm Companies"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/companies/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Company","security":[{"BearerAuth":[]}],"operationId":"deleteCmCompanyById","tags":["Cm Companies"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCompany to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCompany not found"}}}},"/cm/contacts":{"get":{"summary":"Gets a list of Contacts","security":[{"BearerAuth":[]}],"operationId":"listAllCmContact","tags":["Cm Contacts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmContact"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Contacts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmContact"}}}}},"206":{"description":"Partial (paged) collection of Contacts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmContact"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/describe":{"get":{"summary":"Gets table info about Contacts","security":[{"BearerAuth":[]}],"operationId":"describeCmContact","tags":["Cm Contacts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}":{"get":{"summary":"Gets a single Contact","security":[{"BearerAuth":[]}],"operationId":"show","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"put":{"summary":"Update a single Contact","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/tags":{"get":{"summary":"Gets configurations tags","security":[{"BearerAuth":[]}],"operationId":"getTags","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Sets new tags","security":[{"BearerAuth":[]}],"operationId":"setTags","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/hoppers":{"get":{"summary":"Gets contact hoppers","security":[{"BearerAuth":[]}],"operationId":"getHoppers","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/hopper_histories":{"get":{"summary":"Gets contact hopper histories","security":[{"BearerAuth":[]}],"operationId":"getHopperHistories","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/hopper_finals":{"get":{"summary":"Gets contact hopper finals","security":[{"BearerAuth":[]}],"operationId":"getHopperFinals","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/jscripty_sessions":{"get":{"summary":"Gets contact hopper blacks","security":[{"BearerAuth":[]}],"operationId":"getJscriptySessions","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/merge":{"post":{"summary":"Merge Contact","security":[{"BearerAuth":[]}],"operationId":"merge","tags":["Cm Contacts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/":{"post":{"summary":"Create Contact","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Cm Contacts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/create_many":{"post":{"summary":"Create Contacts","security":[{"BearerAuth":[]}],"operationId":"bulkCreate","tags":["Cm Contacts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/upload":{"post":{"summary":"Upload csv","security":[{"BearerAuth":[]}],"operationId":"postupload","tags":["Cm contacts"],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/upload/{id}":{"post":{"summary":"Import new contacts by csv","security":[{"BearerAuth":[]}],"operationId":"import","tags":["Cm contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/contacts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Contact","security":[{"BearerAuth":[]}],"operationId":"deleteCmContactById","tags":["Cm Contacts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmContact to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmContact not found"}}}},"/cm/custom_fields":{"get":{"summary":"Gets a list of Custom Fields","security":[{"BearerAuth":[]}],"operationId":"listAllCmCustomField","tags":["Cm Custom Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmCustomField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Custom Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmCustomField"}}}}},"206":{"description":"Partial (paged) collection of Custom Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmCustomField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/custom_fields/{id}":{"get":{"summary":"Gets a single Custom Field","security":[{"BearerAuth":[]}],"operationId":"getCmCustomFieldById","tags":["Cm Custom Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCustomField to get"}],"responses":{"200":{"description":"CmCustomField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmCustomField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCustomField not found"}}},"put":{"summary":"Update an existing Custom Field","security":[{"BearerAuth":[]}],"operationId":"updateCmCustomFieldById","tags":["Cm Custom Fields"],"requestBody":{"required":true,"description":"data for updating a new Custom Field","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"type":{"type":"string"},"values":{"type":"string"},"required":{"type":"boolean","default":false},"clickToAction":{"type":"boolean","default":false},"actionType":{"type":"string","enum":["voice"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCustomField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCustomField not found"}}}},"/cm/custom_fields/":{"post":{"summary":"Create a new custom field","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Custom Fields"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/custom_fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Custom Field","security":[{"BearerAuth":[]}],"operationId":"deleteCmCustomFieldById","tags":["Cm Custom Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmCustomField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmCustomField not found"}}}},"/cm/hopper":{"get":{"summary":"Gets a list of Hopper","security":[{"BearerAuth":[]}],"operationId":"listAllCmHopper","tags":["Cm Hopper"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmHopper"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Hopper","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopper"}}}}},"206":{"description":"Partial (paged) collection of Hopper","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopper"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Hopper","security":[{"BearerAuth":[]}],"operationId":"createCmHopper","tags":["Cm Hopper"],"requestBody":{"required":true,"description":"data for creating a new Hopper","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"active":{"type":"boolean","default":false},"scheduledat":{"type":"string","default":"2020-11-27 10:41:25"},"countbusyretry":{"type":"integer","default":0},"countcongestionretry":{"type":"integer","default":0},"countnoanswerretry":{"type":"integer","default":0},"callback":{"type":"boolean","default":false},"callbackuniqueid":{"type":"string","default":null},"callbackat":{"type":"string"},"priority":{"type":"integer","default":2},"recallme":{"type":"boolean","default":false},"ContactId":{"type":"integer"},"ListId":{"type":"integer"},"UserId":{"type":"integer"},"VoiceQueueId":{"type":"integer"},"CampaignId":{"type":"integer"},"countnosuchnumberretry":{"type":"integer","default":0},"countdropretry":{"type":"integer","default":0},"countabandonedretry":{"type":"integer","default":0},"countmachineretry":{"type":"integer","default":0},"countagentrejectretry":{"type":"integer","default":0}},"required":["phone"]}}}},"responses":{"201":{"description":"CmHopper successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopper"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper/describe":{"get":{"summary":"Gets table info about Hopper","security":[{"BearerAuth":[]}],"operationId":"describeCmHopper","tags":["Cm Hopper"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper/opencontacts":{"get":{"summary":"Gets Open Contacts","security":[{"BearerAuth":[]}],"operationId":"getOpenContacts","tags":["Cm Hopper"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper/{id}":{"get":{"summary":"Gets a single Hopper","security":[{"BearerAuth":[]}],"operationId":"getCmHopperById","tags":["Cm Hopper"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopper to get"}],"responses":{"200":{"description":"CmHopper with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopper"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopper not found"}}},"put":{"summary":"Update an existing Hopper","security":[{"BearerAuth":[]}],"operationId":"updateCmHopperById","tags":["Cm Hopper"],"requestBody":{"required":true,"description":"data for updating a new Hopper","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"active":{"type":"boolean","default":false},"scheduledat":{"type":"string","default":"2020-11-27 10:41:25"},"countbusyretry":{"type":"integer","default":0},"countcongestionretry":{"type":"integer","default":0},"countnoanswerretry":{"type":"integer","default":0},"callback":{"type":"boolean","default":false},"callbackuniqueid":{"type":"string","default":null},"callbackat":{"type":"string"},"priority":{"type":"integer","default":2},"recallme":{"type":"boolean","default":false},"ContactId":{"type":"integer"},"ListId":{"type":"integer"},"UserId":{"type":"integer"},"VoiceQueueId":{"type":"integer"},"CampaignId":{"type":"integer"},"countnosuchnumberretry":{"type":"integer","default":0},"countdropretry":{"type":"integer","default":0},"countabandonedretry":{"type":"integer","default":0},"countmachineretry":{"type":"integer","default":0},"countagentrejectretry":{"type":"integer","default":0}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopper to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopper not found"}}},"delete":{"summary":"Delete Hopper","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Cm Hopper"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopper"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper/preview":{"post":{"summary":"Gets Preview Dialer Contacts","security":[{"BearerAuth":[]}],"operationId":"getPreview","tags":["Cm Hopper"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_black":{"get":{"summary":"Gets a list of Hopper Black","security":[{"BearerAuth":[]}],"operationId":"listAllCmHopperBlack","tags":["Cm Hopper Black"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmHopperBlack"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Hopper Black","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperBlack"}}}}},"206":{"description":"Partial (paged) collection of Hopper Black","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperBlack"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_black/describe":{"get":{"summary":"Gets table info about Hopper Black","security":[{"BearerAuth":[]}],"operationId":"describeCmHopperBlack","tags":["Cm Hopper Black"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_black/{id}":{"get":{"summary":"Gets a single Hopper Black","security":[{"BearerAuth":[]}],"operationId":"getCmHopperBlackById","tags":["Cm Hopper Black"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperBlack to get"}],"responses":{"200":{"description":"CmHopperBlack with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopperBlack"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperBlack not found"}}},"put":{"summary":"Update an existing Hopper Black","security":[{"BearerAuth":[]}],"operationId":"updateCmHopperBlackById","tags":["Cm Hopper Black"],"requestBody":{"required":true,"description":"data for updating a new Hopper Black","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"ContactId":{"type":"integer"},"ListId":{"type":"integer"},"VoiceQueueId":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperBlack to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperBlack not found"}}}},"/cm/hopper_black/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Hopper Black","security":[{"BearerAuth":[]}],"operationId":"deleteCmHopperBlackById","tags":["Cm Hopper Black"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperBlack to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperBlack not found"}}}},"/cm/hopper_final":{"get":{"summary":"Gets a list of HopperFinal","security":[{"BearerAuth":[]}],"operationId":"listAllCmHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmHopperFinal"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of HopperFinal","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperFinal"}}}}},"206":{"description":"Partial (paged) collection of HopperFinal","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperFinal"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/describe":{"get":{"summary":"Gets table info about HopperFinal","security":[{"BearerAuth":[]}],"operationId":"describeCmHopperFinal","tags":["Cm Hopper Final"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/{id}":{"get":{"summary":"Gets a single HopperFinal","security":[{"BearerAuth":[]}],"operationId":"getCmHopperFinalById","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal to get"}],"responses":{"200":{"description":"CmHopperFinal with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopperFinal"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperFinal not found"}}},"put":{"summary":"Update a single hopper final","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/voice/queue/countAttributes/{id}":{"get":{"summary":"Return number contacts for attributes","security":[{"BearerAuth":[]}],"operationId":"countContactsQueueCampaignHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/campaign/countAttributes/{id}":{"get":{"summary":"Return number contacts for attributes","security":[{"BearerAuth":[]}],"operationId":"countContactsIvrCampaignHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/voice/queue/moveContacts/{id}":{"post":{"summary":"Move contacts in hopper","security":[{"BearerAuth":[]}],"operationId":"moveContactsQueueCampaignHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/voice/campaign/moveContacts/{id}":{"post":{"summary":"Move contacts in hopper","security":[{"BearerAuth":[]}],"operationId":"moveContactsIvrCampaignHopperFinal","tags":["Cm Hopper Final"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperFinal"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_final/checkContactHopper":{"post":{"summary":"Check if contact is in hopper","security":[{"BearerAuth":[]}],"operationId":"checkContactHopper","tags":["Cm Hopper Final"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_history":{"get":{"summary":"Gets a list of HopperHistory","security":[{"BearerAuth":[]}],"operationId":"listAllCmHopperHistory","tags":["Cm Hopper History"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmHopperHistory"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of HopperHistory","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperHistory"}}}}},"206":{"description":"Partial (paged) collection of HopperHistory","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmHopperHistory"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new HopperHistory","security":[{"BearerAuth":[]}],"operationId":"createCmHopperHistory","tags":["Cm Hopper History"],"requestBody":{"required":true,"description":"data for creating a new HopperHistory","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"integer"},"statedesc":{"type":"string"},"scheduledat":{"type":"string"},"countbusyretry":{"type":"integer","default":0},"countcongestionretry":{"type":"integer","default":0},"countnoanswerretry":{"type":"integer","default":0},"countglobal":{"type":"integer","default":0},"uniqueid":{"type":"string"},"originatecalleridnum":{"type":"string"},"originatecalleridname":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"starttime":{"type":"string"},"responsetime":{"type":"string"},"answertime":{"type":"string"},"droptime":{"type":"string"},"endtime":{"type":"string"},"ringtime":{"type":"integer","default":0},"holdtime":{"type":"integer","default":0},"talktime":{"type":"integer","default":0},"followuptime":{"type":"integer","default":0},"dropreason":{"type":"string"},"campaign":{"type":"string"},"campaigntype":{"type":"string"},"membername":{"type":"string"},"reason":{"type":"string"},"amd":{"type":"boolean","default":false},"fax":{"type":"boolean","default":false},"callback":{"type":"boolean","default":false},"callbackuniqueid":{"type":"string","default":null},"callbackat":{"type":"string"},"recallme":{"type":"boolean","default":false},"editedat":{"type":"string"},"edited":{"type":"boolean","default":false},"countnosuchnumberretry":{"type":"integer","default":0},"countdropretry":{"type":"integer","default":0},"countabandonedretry":{"type":"integer","default":0},"countmachineretry":{"type":"integer","default":0},"countagentrejectretry":{"type":"integer","default":0}}}}}},"responses":{"201":{"description":"CmHopperHistory successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopperHistory"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_history/describe":{"get":{"summary":"Gets table info about HopperHistory","security":[{"BearerAuth":[]}],"operationId":"describeCmHopperHistory","tags":["Cm Hopper History"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/hopper_history/{id}":{"get":{"summary":"Gets a single HopperHistory","security":[{"BearerAuth":[]}],"operationId":"getCmHopperHistoryById","tags":["Cm Hopper History"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperHistory to get"}],"responses":{"200":{"description":"CmHopperHistory with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmHopperHistory"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmHopperHistory not found"}}},"put":{"summary":"Update a single hopper history","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Cm Hopper History"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmHopperHistory"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists":{"get":{"summary":"Gets a list of Lists","security":[{"BearerAuth":[]}],"operationId":"listAllCmList","tags":["Cm Lists"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each CmList"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Lists","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmList"}}}}},"206":{"description":"Partial (paged) collection of Lists","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CmList"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new List","security":[{"BearerAuth":[]}],"operationId":"createCmList","tags":["Cm Lists"],"requestBody":{"required":true,"description":"data for creating a new List","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"dialPrefix":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"CmList successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmList"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/describe":{"get":{"summary":"Gets table info about Lists","security":[{"BearerAuth":[]}],"operationId":"describeCmList","tags":["Cm Lists"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}":{"get":{"summary":"Gets a single List","security":[{"BearerAuth":[]}],"operationId":"getCmListById","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList to get"}],"responses":{"200":{"description":"CmList with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmList"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmList not found"}}},"put":{"summary":"Update an existing List","security":[{"BearerAuth":[]}],"operationId":"updateCmListById","tags":["Cm Lists"],"requestBody":{"required":true,"description":"data for updating a new List","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"dialPrefix":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmList not found"}}}},"/cm/lists/{id}/dispositions":{"get":{"summary":"Gets list dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/contacts":{"get":{"summary":"Gets List Contacts","security":[{"BearerAuth":[]}],"operationId":"getContacts","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new contacts","security":[{"BearerAuth":[]}],"operationId":"addContacts","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/contacts/csv":{"get":{"summary":"Gets CSV List Contacts","security":[{"BearerAuth":[]}],"operationId":"getContactsCsv","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/fields":{"get":{"summary":"Gets Custom Fields","security":[{"BearerAuth":[]}],"operationId":"getCustomFields","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new custom field","security":[{"BearerAuth":[]}],"operationId":"addCustomField","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/users":{"get":{"summary":"Gets agents from list","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Adds agents to a list","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a list","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/cm/lists/{id}/destroy_many":{"delete":{"summary":"Destroy an existing List","security":[{"BearerAuth":[]}],"operationId":"deleteCmListById","tags":["Cm Lists"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the CmList to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"CmList not found"}}}},"/conditions/{id}":{"put":{"summary":"Update an existing Condition","security":[{"BearerAuth":[]}],"operationId":"updateConditionById","tags":["Conditions"],"requestBody":{"required":true,"description":"data for updating a new Condition","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Condition to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Condition not found"}}}},"/conditions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Condition","security":[{"BearerAuth":[]}],"operationId":"deleteConditionById","tags":["Conditions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Condition to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Condition not found"}}}},"/dashboards":{"get":{"summary":"Gets a list of Dashboards","security":[{"BearerAuth":[]}],"operationId":"listAllDashboard","tags":["Dashboards"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Dashboard"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dashboards","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}}}}},"206":{"description":"Partial (paged) collection of Dashboards","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Dashboard","security":[{"BearerAuth":[]}],"operationId":"createDashboard","tags":["Dashboards"],"requestBody":{"required":true,"description":"data for creating a new Dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Dashboard successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/{id}":{"get":{"summary":"Gets a single Dashboard","security":[{"BearerAuth":[]}],"operationId":"getDashboardById","tags":["Dashboards"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard to get"}],"responses":{"200":{"description":"Dashboard with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dashboard not found"}}},"put":{"summary":"Update an existing Dashboard","security":[{"BearerAuth":[]}],"operationId":"updateDashboardById","tags":["Dashboards"],"requestBody":{"required":true,"description":"data for updating a new Dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dashboard not found"}}}},"/dashboards/{id}/items":{"get":{"summary":"Gets items","security":[{"BearerAuth":[]}],"operationId":"getItems","tags":["Dashboards"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new item","security":[{"BearerAuth":[]}],"operationId":"addItem","tags":["Dashboards"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/clone":{"post":{"summary":"Clone an existing Dashboard","security":[{"BearerAuth":[]}],"operationId":"cloneDashboard","tags":["Dashboards"],"requestBody":{"required":true,"description":"data for creating a new Dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Dashboard to clone"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id"]}}}},"responses":{"201":{"description":"Dashboard successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dashboard","security":[{"BearerAuth":[]}],"operationId":"deleteDashboardById","tags":["Dashboards"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dashboard to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dashboard not found"}}}},"/dashboards/items/{id}":{"get":{"summary":"Gets a single Dashboard Item","security":[{"BearerAuth":[]}],"operationId":"getDashboardItemById","tags":["Dashboard Items"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DashboardItem to get"}],"responses":{"200":{"description":"DashboardItem with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardItem"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DashboardItem not found"}}},"put":{"summary":"Update an existing item","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Dashboard Items"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DashboardItem"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/items/":{"post":{"summary":"Create dasboard item","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Dashboard Items"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dashboards/items/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dashboard Item","security":[{"BearerAuth":[]}],"operationId":"deleteDashboardItemById","tags":["Dashboard Items"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DashboardItem to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DashboardItem not found"}}}},"/dispositions":{"get":{"summary":"Gets a list of Dispositions","security":[{"BearerAuth":[]}],"operationId":"listAllDisposition","tags":["Dispositions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Disposition"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dispositions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Disposition"}}}}},"206":{"description":"Partial (paged) collection of Dispositions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Disposition"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Disposition","security":[{"BearerAuth":[]}],"operationId":"createDisposition","tags":["Dispositions"],"requestBody":{"required":true,"description":"data for creating a new Disposition","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"level":{"type":"string","enum":["first","second","third"],"default":"first"},"description":{"type":"string"}},"required":["name","level"]}}}},"responses":{"201":{"description":"Disposition successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disposition"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/dispositions/{id}":{"get":{"summary":"Gets a single Disposition","security":[{"BearerAuth":[]}],"operationId":"getDispositionById","tags":["Dispositions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Disposition to get"}],"responses":{"200":{"description":"Disposition with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disposition"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Disposition not found"}}},"put":{"summary":"Update an existing Disposition","security":[{"BearerAuth":[]}],"operationId":"updateDispositionById","tags":["Dispositions"],"requestBody":{"required":true,"description":"data for updating a new Disposition","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"level":{"type":"string","enum":["first","second","third"],"default":"first"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Disposition to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Disposition not found"}}}},"/dispositions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Disposition","security":[{"BearerAuth":[]}],"operationId":"deleteDispositionById","tags":["Dispositions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Disposition to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Disposition not found"}}}},"/fax/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllFaxAccount","tags":["Fax Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Account","security":[{"BearerAuth":[]}],"operationId":"createFaxAccount","tags":["Fax Accounts"],"requestBody":{"required":true,"description":"data for creating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ecm":{"type":"string","enum":["yes","no"],"default":"yes"},"headerinfo":{"type":"string","default":"xCALLY Motion Fax"},"localstationid":{"type":"string"},"minrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"default":"4800"},"maxrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"default":"14400"},"modem":{"type":"string","default":"v17,v27,v29"},"gateway":{"type":"string","default":"no"},"faxdetect":{"type":"string","default":"no"},"t38timeout":{"type":"integer","default":5000},"tech":{"type":"string","enum":["SIP","IAX","DADHI","KHOMP"],"default":"SIP"},"key":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}},"required":["name","key"]}}}},"responses":{"201":{"description":"FaxAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeFaxAccount","tags":["Fax Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getFaxAccountById","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount to get"}],"responses":{"200":{"description":"FaxAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateFaxAccountById","tags":["Fax Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ecm":{"type":"string","enum":["yes","no"],"default":"yes"},"headerinfo":{"type":"string","default":"xCALLY Motion Fax"},"localstationid":{"type":"string"},"minrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"default":"4800"},"maxrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"default":"14400"},"modem":{"type":"string","default":"v17,v27,v29"},"gateway":{"type":"string","default":"no"},"faxdetect":{"type":"string","default":"no"},"t38timeout":{"type":"integer","default":5000},"tech":{"type":"string","enum":["SIP","IAX","DADHI","KHOMP"],"default":"SIP"},"key":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxAccount not found"}}}},"/fax/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/interactions":{"get":{"summary":"Gets account interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new interactions","security":[{"BearerAuth":[]}],"operationId":"addInteraction","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/applications":{"get":{"summary":"Gets account pplications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/messages":{"get":{"summary":"Gets account messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/users":{"get":{"summary":"Gets agents from fax account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a fax account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a fax account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/addaccountapplications":{"post":{"summary":"Creates new account and applications","security":[{"BearerAuth":[]}],"operationId":"addAccountApplications","tags":["Fax Accounts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/updateaccountapplications":{"post":{"summary":"Update account and applications","security":[{"BearerAuth":[]}],"operationId":"updateAccountApplications","tags":["Fax Accounts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/send":{"post":{"summary":"Send new fax","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Account","security":[{"BearerAuth":[]}],"operationId":"deleteFaxAccountById","tags":["Fax Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxAccount not found"}}}},"/fax/applications":{"get":{"summary":"Gets a list of Applications","security":[{"BearerAuth":[]}],"operationId":"listAllFaxApplication","tags":["Fax Applications"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxApplication"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxApplication"}}}}},"206":{"description":"Partial (paged) collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxApplication"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Application","security":[{"BearerAuth":[]}],"operationId":"createFaxApplication","tags":["Fax Applications"],"requestBody":{"required":true,"description":"data for creating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}},"required":["priority","app"]}}}},"responses":{"201":{"description":"FaxApplication successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getFaxApplicationById","tags":["Fax Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxApplication to get"}],"responses":{"200":{"description":"FaxApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateFaxApplicationById","tags":["Fax Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxApplication not found"}}}},"/fax/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteFaxApplicationById","tags":["Fax Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxApplication not found"}}}},"/fax/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllFaxInteraction","tags":["Fax Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createFaxInteraction","tags":["Fax Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"read1stAt":{"type":"string"},"fax":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}},"required":["firstMsgDirection","lastMsgDirection"]}}}},"responses":{"201":{"description":"FaxInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeFaxInteraction","tags":["Fax Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getFaxInteractionById","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction to get"}],"responses":{"200":{"description":"FaxInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateFaxInteractionById","tags":["Fax Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"read1stAt":{"type":"string"},"fax":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxInteraction not found"}}}},"/fax/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/{id}/download":{"get":{"summary":"Get interactions","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteFaxInteractionById","tags":["Fax Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxInteraction not found"}}}},"/fax/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllFaxMessage","tags":["Fax Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeFaxMessage","tags":["Fax Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getFaxMessageById","tags":["Fax Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage to get"}],"responses":{"200":{"description":"FaxMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateFaxMessageById","tags":["Fax Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"failMessage":{"type":"string","default":null},"readAt":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxMessage not found"}}}},"/fax/messages/{id}/download":{"get":{"summary":"Get message","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Fax Message"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/":{"post":{"summary":"Create message and send Fax","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Fax Messages"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Fax Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Fax Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteFaxMessageById","tags":["Fax Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxMessage not found"}}}},"/fax/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllFaxQueue","tags":["Fax Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createFaxQueue","tags":["Fax Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"lastAgent":{"type":"integer","default":0}},"required":["name","timeout","strategy"]}}}},"responses":{"201":{"description":"FaxQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeFaxQueue","tags":["Fax Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getFaxQueueById","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue to get"}],"responses":{"200":{"description":"FaxQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateFaxQueueById","tags":["Fax Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"lastAgent":{"type":"integer","default":0}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueue not found"}}}},"/fax/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteFaxQueueById","tags":["Fax Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueue not found"}}}},"/fax/reports/queue":{"get":{"summary":"Gets a list of Fax Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllFaxQueueReport","tags":["Fax Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Fax Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Fax Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Fax Queue Report","security":[{"BearerAuth":[]}],"operationId":"createFaxQueueReport","tags":["Fax Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Fax Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"FaxQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/reports/queue/describe":{"get":{"summary":"Gets table info about Fax Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeFaxQueueReport","tags":["Fax Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/reports/queue/{id}":{"get":{"summary":"Gets a single Fax Queue Report","security":[{"BearerAuth":[]}],"operationId":"getFaxQueueReportById","tags":["Fax Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueueReport to get"}],"responses":{"200":{"description":"FaxQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueueReport not found"}}},"put":{"summary":"Update an existing Fax Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateFaxQueueReportById","tags":["Fax Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Fax Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueueReport not found"}}}},"/fax/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Fax Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteFaxQueueReportById","tags":["Fax Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxQueueReport not found"}}}},"/fax/reports/transfer":{"get":{"summary":"Gets a list of Fax Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllFaxTransferReport","tags":["Fax Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FaxTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Fax Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Fax Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaxTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Fax Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createFaxTransferReport","tags":["Fax Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Fax Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"FaxTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/reports/transfer/describe":{"get":{"summary":"Gets table info about Fax Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeFaxTransferReport","tags":["Fax Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/fax/reports/transfer/{id}":{"get":{"summary":"Gets a single Fax Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getFaxTransferReportById","tags":["Fax Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxTransferReport to get"}],"responses":{"200":{"description":"FaxTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxTransferReport not found"}}},"put":{"summary":"Update an existing Fax Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateFaxTransferReportById","tags":["Fax Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Fax Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxTransferReport not found"}}}},"/fax/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Fax Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteFaxTransferReportById","tags":["Fax Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FaxTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FaxTransferReport not found"}}}},"/integrations/desk/accounts":{"get":{"summary":"Gets a list of Desk Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllDeskAccount","tags":["Desk Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each DeskAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Desk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskAccount"}}}}},"206":{"description":"Partial (paged) collection of Desk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Desk Account","security":[{"BearerAuth":[]}],"operationId":"createDeskAccount","tags":["Desk Accounts"],"requestBody":{"required":true,"description":"data for creating a new Desk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"remoteUri":{"type":"string"},"authType":{"type":"string","enum":["basic"],"default":"basic"},"password":{"type":"string"},"consumerKey":{"type":"string"},"consumerSecret":{"type":"string"},"token":{"type":"string"},"tokenSecret":{"type":"string"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"responses":{"201":{"description":"DeskAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/accounts/{id}":{"get":{"summary":"Gets a single Desk Account","security":[{"BearerAuth":[]}],"operationId":"getDeskAccountById","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount to get"}],"responses":{"200":{"description":"DeskAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskAccount not found"}}},"put":{"summary":"Update an existing Desk Account","security":[{"BearerAuth":[]}],"operationId":"updateDeskAccountById","tags":["Desk Accounts"],"requestBody":{"required":true,"description":"data for updating a new Desk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"remoteUri":{"type":"string"},"authType":{"type":"string","enum":["basic"],"default":"basic"},"password":{"type":"string"},"consumerKey":{"type":"string"},"consumerSecret":{"type":"string"},"token":{"type":"string"},"tokenSecret":{"type":"string"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskAccount not found"}}}},"/integrations/desk/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Desk Account","security":[{"BearerAuth":[]}],"operationId":"deleteDeskAccountById","tags":["Desk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskAccount not found"}}}},"/integrations/desk/configurations":{"get":{"summary":"Gets a list of Desk Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllDeskConfiguration","tags":["Desk Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each DeskConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Desk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Desk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Desk Configuration","security":[{"BearerAuth":[]}],"operationId":"createDeskConfiguration","tags":["Desk Configurations"],"requestBody":{"required":true,"description":"data for creating a new Desk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"DeskConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}":{"get":{"summary":"Gets a single Desk Configuration","security":[{"BearerAuth":[]}],"operationId":"getDeskConfigurationById","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration to get"}],"responses":{"200":{"description":"DeskConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskConfiguration not found"}}},"put":{"summary":"Update an existing Desk Configuration","security":[{"BearerAuth":[]}],"operationId":"updateDeskConfigurationById","tags":["Desk Configurations"],"requestBody":{"required":true,"description":"data for updating a new Desk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskConfiguration not found"}}}},"/integrations/desk/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}/tags":{"get":{"summary":"Gets configurations tags","security":[{"BearerAuth":[]}],"operationId":"getTags","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Sets new tags","security":[{"BearerAuth":[]}],"operationId":"setTags","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Desk Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteDeskConfigurationById","tags":["Desk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskConfiguration not found"}}}},"/integrations/desk/fields":{"get":{"summary":"Gets a list of Desk Fields","security":[{"BearerAuth":[]}],"operationId":"listAllDeskField","tags":["Desk Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each DeskField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Desk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskField"}}}}},"206":{"description":"Partial (paged) collection of Desk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeskField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Desk Field","security":[{"BearerAuth":[]}],"operationId":"createDeskField","tags":["Desk Fields"],"requestBody":{"required":true,"description":"data for creating a new Desk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"DeskField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/desk/fields/{id}":{"get":{"summary":"Gets a single Desk Field","security":[{"BearerAuth":[]}],"operationId":"getDeskFieldById","tags":["Desk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskField to get"}],"responses":{"200":{"description":"DeskField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskField not found"}}},"put":{"summary":"Update an existing Desk Field","security":[{"BearerAuth":[]}],"operationId":"updateDeskFieldById","tags":["Desk Fields"],"requestBody":{"required":true,"description":"data for updating a new Desk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskField not found"}}}},"/integrations/desk/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Desk Field","security":[{"BearerAuth":[]}],"operationId":"deleteDeskFieldById","tags":["Desk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the DeskField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"DeskField not found"}}}},"/integrations/dynamics365/accounts":{"get":{"summary":"Gets a list of Dynamics365 Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllDynamics365Account","tags":["Dynamics365 Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Dynamics365Account"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dynamics365 Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Account"}}}}},"206":{"description":"Partial (paged) collection of Dynamics365 Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Account"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Dynamics365 Account","security":[{"BearerAuth":[]}],"operationId":"createDynamics365Account","tags":["Dynamics365 Accounts"],"requestBody":{"required":true,"description":"data for creating a new Dynamics365 Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"remoteUri":{"type":"string"},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"serverUrl":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"Dynamics365Account successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Account"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/accounts/{id}":{"get":{"summary":"Gets a single Dynamics365 Account","security":[{"BearerAuth":[]}],"operationId":"getDynamics365AccountById","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account to get"}],"responses":{"200":{"description":"Dynamics365Account with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Account"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Account not found"}}},"put":{"summary":"Update an existing Dynamics365 Account","security":[{"BearerAuth":[]}],"operationId":"updateDynamics365AccountById","tags":["Dynamics365 Accounts"],"requestBody":{"required":true,"description":"data for updating a new Dynamics365 Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"remoteUri":{"type":"string"},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"serverUrl":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Account not found"}}}},"/integrations/dynamics365/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dynamics365 Account","security":[{"BearerAuth":[]}],"operationId":"deleteDynamics365AccountById","tags":["Dynamics365 Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Account to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Account not found"}}}},"/integrations/dynamics365/configurations":{"get":{"summary":"Gets a list of Dynamics365 Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllDynamics365Configuration","tags":["Dynamics365 Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Dynamics365Configuration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dynamics365 Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Configuration"}}}}},"206":{"description":"Partial (paged) collection of Dynamics365 Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Configuration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Dynamics365 Configuration","security":[{"BearerAuth":[]}],"operationId":"createDynamics365Configuration","tags":["Dynamics365 Configurations"],"requestBody":{"required":true,"description":"data for creating a new Dynamics365 Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ticketType":{"type":"string","enum":["incident","phonecall"],"default":"incident"}}}}}},"responses":{"201":{"description":"Dynamics365Configuration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Configuration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/configurations/{id}":{"get":{"summary":"Gets a single Dynamics365 Configuration","security":[{"BearerAuth":[]}],"operationId":"getDynamics365ConfigurationById","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration to get"}],"responses":{"200":{"description":"Dynamics365Configuration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Configuration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Configuration not found"}}},"put":{"summary":"Update an existing Dynamics365 Configuration","security":[{"BearerAuth":[]}],"operationId":"updateDynamics365ConfigurationById","tags":["Dynamics365 Configurations"],"requestBody":{"required":true,"description":"data for updating a new Dynamics365 Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ticketType":{"type":"string","enum":["incident","phonecall"],"default":"incident"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Configuration not found"}}}},"/integrations/dynamics365/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dynamics365 Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteDynamics365ConfigurationById","tags":["Dynamics365 Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Configuration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Configuration not found"}}}},"/integrations/dynamics365/fields":{"get":{"summary":"Gets a list of Dynamics365 Fields","security":[{"BearerAuth":[]}],"operationId":"listAllDynamics365Field","tags":["Dynamics365 Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Dynamics365Field"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dynamics365 Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Field"}}}}},"206":{"description":"Partial (paged) collection of Dynamics365 Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dynamics365Field"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Dynamics365 Field","security":[{"BearerAuth":[]}],"operationId":"createDynamics365Field","tags":["Dynamics365 Fields"],"requestBody":{"required":true,"description":"data for creating a new Dynamics365 Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"Dynamics365Field successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Field"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/dynamics365/fields/{id}":{"get":{"summary":"Gets a single Dynamics365 Field","security":[{"BearerAuth":[]}],"operationId":"getDynamics365FieldById","tags":["Dynamics365 Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Field to get"}],"responses":{"200":{"description":"Dynamics365Field with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dynamics365Field"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Field not found"}}},"put":{"summary":"Update an existing Dynamics365 Field","security":[{"BearerAuth":[]}],"operationId":"updateDynamics365FieldById","tags":["Dynamics365 Fields"],"requestBody":{"required":true,"description":"data for updating a new Dynamics365 Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Field to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Field not found"}}}},"/integrations/dynamics365/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Dynamics365 Field","security":[{"BearerAuth":[]}],"operationId":"deleteDynamics365FieldById","tags":["Dynamics365 Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Dynamics365Field to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Dynamics365Field not found"}}}},"/integrations":{"get":{"summary":"Gets a list of Integrations","security":[{"BearerAuth":[]}],"operationId":"listAllIntegration","tags":["Integrations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Integration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Integrations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}}}}},"206":{"description":"Partial (paged) collection of Integrations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Integration","security":[{"BearerAuth":[]}],"operationId":"createIntegration","tags":["Integrations"],"requestBody":{"required":true,"description":"data for creating a new Integration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"main":{"type":"string","default":"app.js"},"filename":{"type":"string"},"path":{"type":"string"},"type":{"type":"string"},"size":{"type":"integer"},"active":{"type":"boolean","default":false},"author":{"type":"string"},"logo":{"type":"string"},"state":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"remoteUri":{"type":"string"},"link":{"type":"string","default":"#"}},"required":["name","version"]}}}},"responses":{"201":{"description":"Integration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/{id}":{"get":{"summary":"Gets a single Integration","security":[{"BearerAuth":[]}],"operationId":"getIntegrationById","tags":["Integrations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Integration to get"}],"responses":{"200":{"description":"Integration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Integration not found"}}},"put":{"summary":"Update an existing Integration","security":[{"BearerAuth":[]}],"operationId":"updateIntegrationById","tags":["Integrations"],"requestBody":{"required":true,"description":"data for updating a new Integration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"main":{"type":"string","default":"app.js"},"filename":{"type":"string"},"path":{"type":"string"},"type":{"type":"string"},"size":{"type":"integer"},"active":{"type":"boolean","default":false},"author":{"type":"string"},"logo":{"type":"string"},"state":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"remoteUri":{"type":"string"},"link":{"type":"string","default":"#"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Integration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Integration not found"}}}},"/integrations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Integration","security":[{"BearerAuth":[]}],"operationId":"deleteIntegrationById","tags":["Integrations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Integration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Integration not found"}}}},"/integrations/reports":{"get":{"summary":"Gets a list of Integration Reports","security":[{"BearerAuth":[]}],"operationId":"listAllIntegrationReport","tags":["Integration Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each IntegrationReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Integration Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationReport"}}}}},"206":{"description":"Partial (paged) collection of Integration Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Integration Report","security":[{"BearerAuth":[]}],"operationId":"createIntegrationReport","tags":["Integration Reports"],"requestBody":{"required":true,"description":"data for creating a new Integration Report","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"string"},"eventChannel":{"type":"string"},"exitStatus":{"type":"string"},"ticketId":{"type":"string"},"integrationId":{"type":"integer"},"contacts":{"type":"string"},"uniqueid":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"queue":{"type":"string"},"interface":{"type":"string"},"membername":{"type":"string"},"agentcalledAt":{"type":"string"},"agentconnectAt":{"type":"string"},"holdtime":{"type":"integer"},"agentcomplete":{"type":"boolean","default":false},"agentcompleteAt":{"type":"string"},"talktime":{"type":"integer"},"agentacw":{"type":"boolean","default":false},"acwtime":{"type":"integer"},"reason":{"type":"string"},"agentringnoanswer":{"type":"boolean","default":false},"agentringnoanswerAt":{"type":"string"},"agentdump":{"type":"boolean","default":false},"agentdumpAt":{"type":"string"},"lastevent":{"type":"string"},"channel":{"type":"string"},"channelstate":{"type":"integer"},"channelstatedesc":{"type":"string"},"connectedlinenum":{"type":"string"},"connectedlinename":{"type":"string"},"language":{"type":"string"},"accountcode":{"type":"string"},"context":{"type":"string"},"exten":{"type":"string"},"priority":{"type":"string"},"destchannel":{"type":"string"},"destchannelstate":{"type":"integer"},"destchannelstatedesc":{"type":"string"},"destcalleridnum":{"type":"string"},"destcalleridname":{"type":"string"},"destconnectedlinenum":{"type":"string"},"destconnectedlinename":{"type":"string"},"destlanguage":{"type":"string"},"destaccountcode":{"type":"string"},"destcontext":{"type":"string"},"destexten":{"type":"string"},"destpriority":{"type":"string"},"destuniqueid":{"type":"string"},"messageId":{"type":"string"},"inReplyTo":{"type":"string"},"subject":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"attachment":{"type":"string"},"html":{"type":"string"},"text":{"type":"string"},"status":{"type":"string","enum":["SENT","SENDING","RECEIVED","FAILED"]},"url":{"type":"string"},"app":{"type":"string"},"appdata":{"type":"string"},"projectId":{"type":"integer"}}}}}},"responses":{"201":{"description":"IntegrationReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/reports/describe":{"get":{"summary":"Gets table info about Integration Reports","security":[{"BearerAuth":[]}],"operationId":"describeIntegrationReport","tags":["Integration Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/reports/{id}":{"get":{"summary":"Gets a single Integration Report","security":[{"BearerAuth":[]}],"operationId":"getIntegrationReportById","tags":["Integration Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the IntegrationReport to get"}],"responses":{"200":{"description":"IntegrationReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"IntegrationReport not found"}}},"put":{"summary":"Update an existing Integration Report","security":[{"BearerAuth":[]}],"operationId":"updateIntegrationReportById","tags":["Integration Reports"],"requestBody":{"required":true,"description":"data for updating a new Integration Report","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"string"},"eventChannel":{"type":"string"},"exitStatus":{"type":"string"},"ticketId":{"type":"string"},"integrationId":{"type":"integer"},"contacts":{"type":"string"},"uniqueid":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"queue":{"type":"string"},"interface":{"type":"string"},"membername":{"type":"string"},"agentcalledAt":{"type":"string"},"agentconnectAt":{"type":"string"},"holdtime":{"type":"integer"},"agentcomplete":{"type":"boolean","default":false},"agentcompleteAt":{"type":"string"},"talktime":{"type":"integer"},"agentacw":{"type":"boolean","default":false},"acwtime":{"type":"integer"},"reason":{"type":"string"},"agentringnoanswer":{"type":"boolean","default":false},"agentringnoanswerAt":{"type":"string"},"agentdump":{"type":"boolean","default":false},"agentdumpAt":{"type":"string"},"lastevent":{"type":"string"},"channel":{"type":"string"},"channelstate":{"type":"integer"},"channelstatedesc":{"type":"string"},"connectedlinenum":{"type":"string"},"connectedlinename":{"type":"string"},"language":{"type":"string"},"accountcode":{"type":"string"},"context":{"type":"string"},"exten":{"type":"string"},"priority":{"type":"string"},"destchannel":{"type":"string"},"destchannelstate":{"type":"integer"},"destchannelstatedesc":{"type":"string"},"destcalleridnum":{"type":"string"},"destcalleridname":{"type":"string"},"destconnectedlinenum":{"type":"string"},"destconnectedlinename":{"type":"string"},"destlanguage":{"type":"string"},"destaccountcode":{"type":"string"},"destcontext":{"type":"string"},"destexten":{"type":"string"},"destpriority":{"type":"string"},"destuniqueid":{"type":"string"},"messageId":{"type":"string"},"inReplyTo":{"type":"string"},"subject":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"attachment":{"type":"string"},"html":{"type":"string"},"text":{"type":"string"},"status":{"type":"string","enum":["SENT","SENDING","RECEIVED","FAILED"]},"url":{"type":"string"},"app":{"type":"string"},"appdata":{"type":"string"},"projectId":{"type":"integer"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the IntegrationReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"IntegrationReport not found"}}}},"/integrations/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Integration Report","security":[{"BearerAuth":[]}],"operationId":"deleteIntegrationReportById","tags":["Integration Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the IntegrationReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"IntegrationReport not found"}}}},"/intervals":{"get":{"summary":"Gets a list of Intervals","security":[{"BearerAuth":[]}],"operationId":"listAllInterval","tags":["Intervals"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Interval"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Intervals","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Interval"}}}}},"206":{"description":"Partial (paged) collection of Intervals","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Interval"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interval","security":[{"BearerAuth":[]}],"operationId":"createInterval","tags":["Intervals"],"requestBody":{"required":true,"description":"data for creating a new Interval","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string"}}}}}},"responses":{"201":{"description":"Interval successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interval"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/intervals/{id}":{"get":{"summary":"Gets a single Interval","security":[{"BearerAuth":[]}],"operationId":"getIntervalById","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval to get"}],"responses":{"200":{"description":"Interval with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interval"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Interval not found"}}},"put":{"summary":"Update an existing Interval","security":[{"BearerAuth":[]}],"operationId":"updateIntervalById","tags":["Intervals"],"requestBody":{"required":true,"description":"data for updating a new Interval","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Interval not found"}}}},"/intervals/{id}/sub_intervals":{"get":{"summary":"Get sub intervals set","security":[{"BearerAuth":[]}],"operationId":"getIntervals","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new sub interval","security":[{"BearerAuth":[]}],"operationId":"addInterval","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/intervals/{id}/sub_intervals/create_many":{"post":{"summary":"Create new sub intervals set","security":[{"BearerAuth":[]}],"operationId":"addIntervals","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/intervals/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interval","security":[{"BearerAuth":[]}],"operationId":"deleteIntervalById","tags":["Intervals"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Interval to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Interval not found"}}}},"/integrations/freshdesk/accounts":{"get":{"summary":"Gets a list of Freshdesk Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllFreshdeskAccount","tags":["Freshdesk Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshdeskAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshdesk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskAccount"}}}}},"206":{"description":"Partial (paged) collection of Freshdesk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshdesk Account","security":[{"BearerAuth":[]}],"operationId":"createFreshdeskAccount","tags":["Freshdesk Accounts"],"requestBody":{"required":true,"description":"data for creating a new Freshdesk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshdeskAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/accounts/{id}":{"get":{"summary":"Gets a single Freshdesk Account","security":[{"BearerAuth":[]}],"operationId":"getFreshdeskAccountById","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount to get"}],"responses":{"200":{"description":"FreshdeskAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskAccount not found"}}},"put":{"summary":"Update an existing Freshdesk Account","security":[{"BearerAuth":[]}],"operationId":"updateFreshdeskAccountById","tags":["Freshdesk Accounts"],"requestBody":{"required":true,"description":"data for updating a new Freshdesk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskAccount not found"}}}},"/integrations/freshdesk/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshdesk Account","security":[{"BearerAuth":[]}],"operationId":"deleteFreshdeskAccountById","tags":["Freshdesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskAccount not found"}}}},"/integrations/freshdesk/configurations":{"get":{"summary":"Gets a list of Freshdesk Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllFreshdeskConfiguration","tags":["Freshdesk Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshdeskConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshdesk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Freshdesk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshdesk Configuration","security":[{"BearerAuth":[]}],"operationId":"createFreshdeskConfiguration","tags":["Freshdesk Configurations"],"requestBody":{"required":true,"description":"data for creating a new Freshdesk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshdeskConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}":{"get":{"summary":"Gets a single Freshdesk Configuration","security":[{"BearerAuth":[]}],"operationId":"getFreshdeskConfigurationById","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration to get"}],"responses":{"200":{"description":"FreshdeskConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskConfiguration not found"}}},"put":{"summary":"Update an existing Freshdesk Configuration","security":[{"BearerAuth":[]}],"operationId":"updateFreshdeskConfigurationById","tags":["Freshdesk Configurations"],"requestBody":{"required":true,"description":"data for updating a new Freshdesk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskConfiguration not found"}}}},"/integrations/freshdesk/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}/tags":{"get":{"summary":"Gets configurations tags","security":[{"BearerAuth":[]}],"operationId":"getTags","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Sets new tags","security":[{"BearerAuth":[]}],"operationId":"setTags","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshdesk Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteFreshdeskConfigurationById","tags":["Freshdesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskConfiguration not found"}}}},"/integrations/freshdesk/fields":{"get":{"summary":"Gets a list of Freshdesk Fields","security":[{"BearerAuth":[]}],"operationId":"listAllFreshdeskField","tags":["Freshdesk Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshdeskField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshdesk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskField"}}}}},"206":{"description":"Partial (paged) collection of Freshdesk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshdeskField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshdesk Field","security":[{"BearerAuth":[]}],"operationId":"createFreshdeskField","tags":["Freshdesk Fields"],"requestBody":{"required":true,"description":"data for creating a new Freshdesk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshdeskField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshdesk/fields/{id}":{"get":{"summary":"Gets a single Freshdesk Field","security":[{"BearerAuth":[]}],"operationId":"getFreshdeskFieldById","tags":["Freshdesk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskField to get"}],"responses":{"200":{"description":"FreshdeskField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshdeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskField not found"}}},"put":{"summary":"Update an existing Freshdesk Field","security":[{"BearerAuth":[]}],"operationId":"updateFreshdeskFieldById","tags":["Freshdesk Fields"],"requestBody":{"required":true,"description":"data for updating a new Freshdesk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskField not found"}}}},"/integrations/freshdesk/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshdesk Field","security":[{"BearerAuth":[]}],"operationId":"deleteFreshdeskFieldById","tags":["Freshdesk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshdeskField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshdeskField not found"}}}},"/integrations/freshsales/accounts":{"get":{"summary":"Gets a list of Freshsales Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllFreshsalesAccount","tags":["Freshsales Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshsalesAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshsales Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesAccount"}}}}},"206":{"description":"Partial (paged) collection of Freshsales Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshsales Account","security":[{"BearerAuth":[]}],"operationId":"createFreshsalesAccount","tags":["Freshsales Accounts"],"requestBody":{"required":true,"description":"data for creating a new Freshsales Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshsalesAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/accounts/{id}":{"get":{"summary":"Gets a single Freshsales Account","security":[{"BearerAuth":[]}],"operationId":"getFreshsalesAccountById","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount to get"}],"responses":{"200":{"description":"FreshsalesAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesAccount not found"}}},"put":{"summary":"Update an existing Freshsales Account","security":[{"BearerAuth":[]}],"operationId":"updateFreshsalesAccountById","tags":["Freshsales Accounts"],"requestBody":{"required":true,"description":"data for updating a new Freshsales Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesAccount not found"}}}},"/integrations/freshsales/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshsales Account","security":[{"BearerAuth":[]}],"operationId":"deleteFreshsalesAccountById","tags":["Freshsales Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesAccount not found"}}}},"/integrations/freshsales/configurations":{"get":{"summary":"Gets a list of Freshsales Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllFreshsalesConfiguration","tags":["Freshsales Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshsalesConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshsales Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Freshsales Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshsales Configuration","security":[{"BearerAuth":[]}],"operationId":"createFreshsalesConfiguration","tags":["Freshsales Configurations"],"requestBody":{"required":true,"description":"data for creating a new Freshsales Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshsalesConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/configurations/{id}":{"get":{"summary":"Gets a single Freshsales Configuration","security":[{"BearerAuth":[]}],"operationId":"getFreshsalesConfigurationById","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration to get"}],"responses":{"200":{"description":"FreshsalesConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesConfiguration not found"}}},"put":{"summary":"Update an existing Freshsales Configuration","security":[{"BearerAuth":[]}],"operationId":"updateFreshsalesConfigurationById","tags":["Freshsales Configurations"],"requestBody":{"required":true,"description":"data for updating a new Freshsales Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesConfiguration not found"}}}},"/integrations/freshsales/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshsales Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteFreshsalesConfigurationById","tags":["Freshsales Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesConfiguration not found"}}}},"/integrations/freshsales/fields":{"get":{"summary":"Gets a list of Freshsales Fields","security":[{"BearerAuth":[]}],"operationId":"listAllFreshsalesField","tags":["Freshsales Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each FreshsalesField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Freshsales Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesField"}}}}},"206":{"description":"Partial (paged) collection of Freshsales Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreshsalesField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Freshsales Field","security":[{"BearerAuth":[]}],"operationId":"createFreshsalesField","tags":["Freshsales Fields"],"requestBody":{"required":true,"description":"data for creating a new Freshsales Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"FreshsalesField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/freshsales/fields/{id}":{"get":{"summary":"Gets a single Freshsales Field","security":[{"BearerAuth":[]}],"operationId":"getFreshsalesFieldById","tags":["Freshsales Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesField to get"}],"responses":{"200":{"description":"FreshsalesField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshsalesField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesField not found"}}},"put":{"summary":"Update an existing Freshsales Field","security":[{"BearerAuth":[]}],"operationId":"updateFreshsalesFieldById","tags":["Freshsales Fields"],"requestBody":{"required":true,"description":"data for updating a new Freshsales Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesField not found"}}}},"/integrations/freshsales/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Freshsales Field","security":[{"BearerAuth":[]}],"operationId":"deleteFreshsalesFieldById","tags":["Freshsales Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the FreshsalesField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"FreshsalesField not found"}}}},"/integrations/salesforce/accounts":{"get":{"summary":"Gets a list of Salesforce Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllSalesforceAccount","tags":["Salesforce Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SalesforceAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Salesforce Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceAccount"}}}}},"206":{"description":"Partial (paged) collection of Salesforce Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Salesforce Account","security":[{"BearerAuth":[]}],"operationId":"createSalesforceAccount","tags":["Salesforce Accounts"],"requestBody":{"required":true,"description":"data for creating a new Salesforce Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"remoteUri":{"type":"string"},"password":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"securityToken":{"type":"string"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"responses":{"201":{"description":"SalesforceAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/accounts/{id}":{"get":{"summary":"Gets a single Salesforce Account","security":[{"BearerAuth":[]}],"operationId":"getSalesforceAccountById","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount to get"}],"responses":{"200":{"description":"SalesforceAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceAccount not found"}}},"put":{"summary":"Update an existing Salesforce Account","security":[{"BearerAuth":[]}],"operationId":"updateSalesforceAccountById","tags":["Salesforce Accounts"],"requestBody":{"required":true,"description":"data for updating a new Salesforce Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"remoteUri":{"type":"string"},"password":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"securityToken":{"type":"string"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceAccount not found"}}}},"/integrations/salesforce/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Salesforce Account","security":[{"BearerAuth":[]}],"operationId":"deleteSalesforceAccountById","tags":["Salesforce Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceAccount not found"}}}},"/integrations/salesforce/configurations":{"get":{"summary":"Gets a list of Salesforce Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllSalesforceConfiguration","tags":["Salesforce Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SalesforceConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Salesforce Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Salesforce Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Salesforce Configuration","security":[{"BearerAuth":[]}],"operationId":"createSalesforceConfiguration","tags":["Salesforce Configurations"],"requestBody":{"required":true,"description":"data for creating a new Salesforce Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ticketType":{"type":"string","enum":["Task","Case"],"default":"Task"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"default":"contact_lead"},"moduleCreate":{"type":"string","enum":["nothing","contact","lead"],"default":"lead"}}}}}},"responses":{"201":{"description":"SalesforceConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/configurations/{id}":{"get":{"summary":"Gets a single Salesforce Configuration","security":[{"BearerAuth":[]}],"operationId":"getSalesforceConfigurationById","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration to get"}],"responses":{"200":{"description":"SalesforceConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceConfiguration not found"}}},"put":{"summary":"Update an existing Salesforce Configuration","security":[{"BearerAuth":[]}],"operationId":"updateSalesforceConfigurationById","tags":["Salesforce Configurations"],"requestBody":{"required":true,"description":"data for updating a new Salesforce Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ticketType":{"type":"string","enum":["Task","Case"],"default":"Task"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"default":"contact_lead"},"moduleCreate":{"type":"string","enum":["nothing","contact","lead"],"default":"lead"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceConfiguration not found"}}}},"/integrations/salesforce/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Salesforce Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteSalesforceConfigurationById","tags":["Salesforce Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceConfiguration not found"}}}},"/integrations/salesforce/fields":{"get":{"summary":"Gets a list of Salesforce Fields","security":[{"BearerAuth":[]}],"operationId":"listAllSalesforceField","tags":["Salesforce Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SalesforceField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Salesforce Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceField"}}}}},"206":{"description":"Partial (paged) collection of Salesforce Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesforceField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Salesforce Field","security":[{"BearerAuth":[]}],"operationId":"createSalesforceField","tags":["Salesforce Fields"],"requestBody":{"required":true,"description":"data for creating a new Salesforce Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"SalesforceField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/salesforce/fields/{id}":{"get":{"summary":"Gets a single Salesforce Field","security":[{"BearerAuth":[]}],"operationId":"getSalesforceFieldById","tags":["Salesforce Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceField to get"}],"responses":{"200":{"description":"SalesforceField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceField not found"}}},"put":{"summary":"Update an existing Salesforce Field","security":[{"BearerAuth":[]}],"operationId":"updateSalesforceFieldById","tags":["Salesforce Fields"],"requestBody":{"required":true,"description":"data for updating a new Salesforce Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceField not found"}}}},"/integrations/salesforce/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Salesforce Field","security":[{"BearerAuth":[]}],"operationId":"deleteSalesforceFieldById","tags":["Salesforce Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SalesforceField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SalesforceField not found"}}}},"/integrations/servicenow/accounts":{"get":{"summary":"Gets a list of Servicenow Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllServicenowAccount","tags":["Servicenow Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ServicenowAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Servicenow Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowAccount"}}}}},"206":{"description":"Partial (paged) collection of Servicenow Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Servicenow Account","security":[{"BearerAuth":[]}],"operationId":"createServicenowAccount","tags":["Servicenow Accounts"],"requestBody":{"required":true,"description":"data for creating a new Servicenow Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"responses":{"201":{"description":"ServicenowAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/accounts/{id}":{"get":{"summary":"Gets a single Servicenow Account","security":[{"BearerAuth":[]}],"operationId":"getServicenowAccountById","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount to get"}],"responses":{"200":{"description":"ServicenowAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowAccount not found"}}},"put":{"summary":"Update an existing Servicenow Account","security":[{"BearerAuth":[]}],"operationId":"updateServicenowAccountById","tags":["Servicenow Accounts"],"requestBody":{"required":true,"description":"data for updating a new Servicenow Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowAccount not found"}}}},"/integrations/servicenow/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Servicenow Account","security":[{"BearerAuth":[]}],"operationId":"deleteServicenowAccountById","tags":["Servicenow Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowAccount not found"}}}},"/integrations/servicenow/configurations":{"get":{"summary":"Gets a list of Servicenow Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllServicenowConfiguration","tags":["Servicenow Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ServicenowConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Servicenow Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Servicenow Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Servicenow Configuration","security":[{"BearerAuth":[]}],"operationId":"createServicenowConfiguration","tags":["Servicenow Configurations"],"requestBody":{"required":true,"description":"data for creating a new Servicenow Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"ServicenowConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/configurations/{id}":{"get":{"summary":"Gets a single Servicenow Configuration","security":[{"BearerAuth":[]}],"operationId":"getServicenowConfigurationById","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration to get"}],"responses":{"200":{"description":"ServicenowConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowConfiguration not found"}}},"put":{"summary":"Update an existing Servicenow Configuration","security":[{"BearerAuth":[]}],"operationId":"updateServicenowConfigurationById","tags":["Servicenow Configurations"],"requestBody":{"required":true,"description":"data for updating a new Servicenow Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowConfiguration not found"}}}},"/integrations/servicenow/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Servicenow Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteServicenowConfigurationById","tags":["Servicenow Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowConfiguration not found"}}}},"/integrations/servicenow/fields":{"get":{"summary":"Gets a list of Servicenow Fields","security":[{"BearerAuth":[]}],"operationId":"listAllServicenowField","tags":["Servicenow Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ServicenowField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Servicenow Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowField"}}}}},"206":{"description":"Partial (paged) collection of Servicenow Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServicenowField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Servicenow Field","security":[{"BearerAuth":[]}],"operationId":"createServicenowField","tags":["Servicenow Fields"],"requestBody":{"required":true,"description":"data for creating a new Servicenow Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"ServicenowField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/servicenow/fields/{id}":{"get":{"summary":"Gets a single Servicenow Field","security":[{"BearerAuth":[]}],"operationId":"getServicenowFieldById","tags":["Servicenow Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowField to get"}],"responses":{"200":{"description":"ServicenowField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicenowField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowField not found"}}},"put":{"summary":"Update an existing Servicenow Field","security":[{"BearerAuth":[]}],"operationId":"updateServicenowFieldById","tags":["Servicenow Fields"],"requestBody":{"required":true,"description":"data for updating a new Servicenow Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowField not found"}}}},"/integrations/servicenow/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Servicenow Field","security":[{"BearerAuth":[]}],"operationId":"deleteServicenowFieldById","tags":["Servicenow Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ServicenowField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ServicenowField not found"}}}},"/integrations/sugarcrm/accounts":{"get":{"summary":"Gets a list of Sugarcrm Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllSugarcrmAccount","tags":["Sugarcrm Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SugarcrmAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sugarcrm Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmAccount"}}}}},"206":{"description":"Partial (paged) collection of Sugarcrm Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Sugarcrm Account","security":[{"BearerAuth":[]}],"operationId":"createSugarcrmAccount","tags":["Sugarcrm Accounts"],"requestBody":{"required":true,"description":"data for creating a new Sugarcrm Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"responses":{"201":{"description":"SugarcrmAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/accounts/{id}":{"get":{"summary":"Gets a single Sugarcrm Account","security":[{"BearerAuth":[]}],"operationId":"getSugarcrmAccountById","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount to get"}],"responses":{"200":{"description":"SugarcrmAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmAccount not found"}}},"put":{"summary":"Update an existing Sugarcrm Account","security":[{"BearerAuth":[]}],"operationId":"updateSugarcrmAccountById","tags":["Sugarcrm Accounts"],"requestBody":{"required":true,"description":"data for updating a new Sugarcrm Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmAccount not found"}}}},"/integrations/sugarcrm/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Sugarcrm Account","security":[{"BearerAuth":[]}],"operationId":"deleteSugarcrmAccountById","tags":["Sugarcrm Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmAccount not found"}}}},"/integrations/sugarcrm/configurations":{"get":{"summary":"Gets a list of SugarCRM Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllSugarcrmConfiguration","tags":["SugarCRM Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SugarcrmConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of SugarCRM Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmConfiguration"}}}}},"206":{"description":"Partial (paged) collection of SugarCRM Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new SugarCRM Configuration","security":[{"BearerAuth":[]}],"operationId":"createSugarcrmConfiguration","tags":["SugarCRM Configurations"],"requestBody":{"required":true,"description":"data for creating a new SugarCRM Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"SugarcrmConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/configurations/{id}":{"get":{"summary":"Gets a single SugarCRM Configuration","security":[{"BearerAuth":[]}],"operationId":"getSugarcrmConfigurationById","tags":["SugarCRM Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration to get"}],"responses":{"200":{"description":"SugarcrmConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmConfiguration not found"}}},"put":{"summary":"Update an existing SugarCRM Configuration","security":[{"BearerAuth":[]}],"operationId":"updateSugarcrmConfigurationById","tags":["SugarCRM Configurations"],"requestBody":{"required":true,"description":"data for updating a new SugarCRM Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmConfiguration not found"}}}},"/integrations/sugarcrm/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Sugarcrm Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Sugarcrm Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Sugarcrm Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing SugarCRM Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteSugarcrmConfigurationById","tags":["SugarCRM Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmConfiguration not found"}}}},"/integrations/sugarcrm/fields":{"get":{"summary":"Gets a list of Sugarcrm Fields","security":[{"BearerAuth":[]}],"operationId":"listAllSugarcrmField","tags":["Sugarcrm Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SugarcrmField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sugarcrm Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmField"}}}}},"206":{"description":"Partial (paged) collection of Sugarcrm Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SugarcrmField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Sugarcrm Field","security":[{"BearerAuth":[]}],"operationId":"createSugarcrmField","tags":["Sugarcrm Fields"],"requestBody":{"required":true,"description":"data for creating a new Sugarcrm Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"SugarcrmField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/sugarcrm/fields/{id}":{"get":{"summary":"Gets a single Sugarcrm Field","security":[{"BearerAuth":[]}],"operationId":"getSugarcrmFieldById","tags":["Sugarcrm Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmField to get"}],"responses":{"200":{"description":"SugarcrmField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugarcrmField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmField not found"}}},"put":{"summary":"Update an existing Sugarcrm Field","security":[{"BearerAuth":[]}],"operationId":"updateSugarcrmFieldById","tags":["Sugarcrm Fields"],"requestBody":{"required":true,"description":"data for updating a new Sugarcrm Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmField not found"}}}},"/integrations/sugarcrm/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Sugarcrm Field","security":[{"BearerAuth":[]}],"operationId":"deleteSugarcrmFieldById","tags":["Sugarcrm Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SugarcrmField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SugarcrmField not found"}}}},"/integrations/vtiger/accounts":{"get":{"summary":"Gets a list of Vtiger Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllVtigerAccount","tags":["Vtiger Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VtigerAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Vtiger Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerAccount"}}}}},"206":{"description":"Partial (paged) collection of Vtiger Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Vtiger Account","security":[{"BearerAuth":[]}],"operationId":"createVtigerAccount","tags":["Vtiger Accounts"],"requestBody":{"required":true,"description":"data for creating a new Vtiger Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"moduleName":{"type":"string","default":"HelpDesk"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"},"accessKey":{"type":"string"}},"required":["name","username","moduleName","remoteUri","accessKey"]}}}},"responses":{"201":{"description":"VtigerAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/accounts/{id}":{"get":{"summary":"Gets a single Vtiger Account","security":[{"BearerAuth":[]}],"operationId":"getVtigerAccountById","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount to get"}],"responses":{"200":{"description":"VtigerAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerAccount not found"}}},"put":{"summary":"Update an existing Vtiger Account","security":[{"BearerAuth":[]}],"operationId":"updateVtigerAccountById","tags":["Vtiger Accounts"],"requestBody":{"required":true,"description":"data for updating a new Vtiger Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"moduleName":{"type":"string","default":"HelpDesk"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string"},"accessKey":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerAccount not found"}}}},"/integrations/vtiger/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Vtiger Account","security":[{"BearerAuth":[]}],"operationId":"deleteVtigerAccountById","tags":["Vtiger Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerAccount not found"}}}},"/integrations/vtiger/configurations":{"get":{"summary":"Gets a list of Vtiger Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllVtigerConfiguration","tags":["Vtiger Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VtigerConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Vtiger Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Vtiger Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Vtiger Configuration","security":[{"BearerAuth":[]}],"operationId":"createVtigerConfiguration","tags":["Vtiger Configurations"],"requestBody":{"required":true,"description":"data for creating a new Vtiger Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"VtigerConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/configurations/{id}":{"get":{"summary":"Gets a single Vtiger Configuration","security":[{"BearerAuth":[]}],"operationId":"getVtigerConfigurationById","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration to get"}],"responses":{"200":{"description":"VtigerConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerConfiguration not found"}}},"put":{"summary":"Update an existing Vtiger Configuration","security":[{"BearerAuth":[]}],"operationId":"updateVtigerConfigurationById","tags":["Vtiger Configurations"],"requestBody":{"required":true,"description":"data for updating a new Vtiger Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerConfiguration not found"}}}},"/integrations/vtiger/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Vtiger Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteVtigerConfigurationById","tags":["Vtiger Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerConfiguration not found"}}}},"/integrations/vtiger/fields":{"get":{"summary":"Gets a list of Vtiger Fields","security":[{"BearerAuth":[]}],"operationId":"listAllVtigerField","tags":["Vtiger Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VtigerField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Vtiger Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerField"}}}}},"206":{"description":"Partial (paged) collection of Vtiger Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VtigerField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Vtiger Field","security":[{"BearerAuth":[]}],"operationId":"createVtigerField","tags":["Vtiger Fields"],"requestBody":{"required":true,"description":"data for creating a new Vtiger Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"VtigerField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/vtiger/fields/{id}":{"get":{"summary":"Gets a single Vtiger Field","security":[{"BearerAuth":[]}],"operationId":"getVtigerFieldById","tags":["Vtiger Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerField to get"}],"responses":{"200":{"description":"VtigerField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtigerField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerField not found"}}},"put":{"summary":"Update an existing Vtiger Field","security":[{"BearerAuth":[]}],"operationId":"updateVtigerFieldById","tags":["Vtiger Fields"],"requestBody":{"required":true,"description":"data for updating a new Vtiger Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerField not found"}}}},"/integrations/vtiger/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Vtiger Field","security":[{"BearerAuth":[]}],"operationId":"deleteVtigerFieldById","tags":["Vtiger Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VtigerField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VtigerField not found"}}}},"/integrations/zendesk/accounts":{"get":{"summary":"Gets a list of Zendesk Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllZendeskAccount","tags":["Zendesk Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZendeskAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zendesk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskAccount"}}}}},"206":{"description":"Partial (paged) collection of Zendesk Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zendesk Account","security":[{"BearerAuth":[]}],"operationId":"createZendeskAccount","tags":["Zendesk Accounts"],"requestBody":{"required":true,"description":"data for creating a new Zendesk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"token":{"type":"string"},"remoteUri":{"type":"string"},"authType":{"type":"string","enum":["password","token"],"default":"password"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"responses":{"201":{"description":"ZendeskAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/accounts/{id}":{"get":{"summary":"Gets a single Zendesk Account","security":[{"BearerAuth":[]}],"operationId":"getZendeskAccountById","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount to get"}],"responses":{"200":{"description":"ZendeskAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskAccount not found"}}},"put":{"summary":"Update an existing Zendesk Account","security":[{"BearerAuth":[]}],"operationId":"updateZendeskAccountById","tags":["Zendesk Accounts"],"requestBody":{"required":true,"description":"data for updating a new Zendesk Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"token":{"type":"string"},"remoteUri":{"type":"string"},"authType":{"type":"string","enum":["password","token"],"default":"password"},"serverUrl":{"type":"string"},"type":{"type":"string","enum":["integrationTab","newTab"],"default":"integrationTab"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskAccount not found"}}}},"/integrations/zendesk/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zendesk Account","security":[{"BearerAuth":[]}],"operationId":"deleteZendeskAccountById","tags":["Zendesk Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskAccount not found"}}}},"/integrations/zendesk/configurations":{"get":{"summary":"Gets a list of Zendesk Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllZendeskConfiguration","tags":["Zendesk Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZendeskConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zendesk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Zendesk Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zendesk Configuration","security":[{"BearerAuth":[]}],"operationId":"createZendeskConfiguration","tags":["Zendesk Configurations"],"requestBody":{"required":true,"description":"data for creating a new Zendesk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"ZendeskConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}":{"get":{"summary":"Gets a single Zendesk Configuration","security":[{"BearerAuth":[]}],"operationId":"getZendeskConfigurationById","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration to get"}],"responses":{"200":{"description":"ZendeskConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskConfiguration not found"}}},"put":{"summary":"Update an existing Zendesk Configuration","security":[{"BearerAuth":[]}],"operationId":"updateZendeskConfigurationById","tags":["Zendesk Configurations"],"requestBody":{"required":true,"description":"data for updating a new Zendesk Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskConfiguration not found"}}}},"/integrations/zendesk/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}/tags":{"get":{"summary":"Gets configurations tags","security":[{"BearerAuth":[]}],"operationId":"getTags","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Sets new tags","security":[{"BearerAuth":[]}],"operationId":"setTags","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zendesk Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteZendeskConfigurationById","tags":["Zendesk Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskConfiguration not found"}}}},"/integrations/zendesk/fields":{"get":{"summary":"Gets a list of Zendesk Fields","security":[{"BearerAuth":[]}],"operationId":"listAllZendeskField","tags":["Zendesk Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZendeskField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zendesk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskField"}}}}},"206":{"description":"Partial (paged) collection of Zendesk Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZendeskField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zendesk Field","security":[{"BearerAuth":[]}],"operationId":"createZendeskField","tags":["Zendesk Fields"],"requestBody":{"required":true,"description":"data for creating a new Zendesk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"ZendeskField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zendesk/fields/{id}":{"get":{"summary":"Gets a single Zendesk Field","security":[{"BearerAuth":[]}],"operationId":"getZendeskFieldById","tags":["Zendesk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskField to get"}],"responses":{"200":{"description":"ZendeskField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZendeskField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskField not found"}}},"put":{"summary":"Update an existing Zendesk Field","security":[{"BearerAuth":[]}],"operationId":"updateZendeskFieldById","tags":["Zendesk Fields"],"requestBody":{"required":true,"description":"data for updating a new Zendesk Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskField not found"}}}},"/integrations/zendesk/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zendesk Field","security":[{"BearerAuth":[]}],"operationId":"deleteZendeskFieldById","tags":["Zendesk Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZendeskField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZendeskField not found"}}}},"/integrations/zoho/accounts":{"get":{"summary":"Gets a list of Zoho Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllZohoAccount","tags":["Zoho Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZohoAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zoho Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoAccount"}}}}},"206":{"description":"Partial (paged) collection of Zoho Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zoho Account","security":[{"BearerAuth":[]}],"operationId":"createZohoAccount","tags":["Zoho Accounts"],"requestBody":{"required":true,"description":"data for creating a new Zoho Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"host":{"type":"string"},"zone":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"serverUrl":{"type":"string"},"code":{"type":"string"},"refreshToken":{"type":"string"}}}}}},"responses":{"201":{"description":"ZohoAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/accounts/{id}":{"get":{"summary":"Gets a single Zoho Account","security":[{"BearerAuth":[]}],"operationId":"getZohoAccountById","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount to get"}],"responses":{"200":{"description":"ZohoAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoAccount not found"}}},"put":{"summary":"Update an existing Zoho Account","security":[{"BearerAuth":[]}],"operationId":"updateZohoAccountById","tags":["Zoho Accounts"],"requestBody":{"required":true,"description":"data for updating a new Zoho Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"host":{"type":"string"},"zone":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"serverUrl":{"type":"string"},"code":{"type":"string"},"refreshToken":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoAccount not found"}}}},"/integrations/zoho/accounts/{id}/configurations":{"get":{"summary":"Gets account configurations","security":[{"BearerAuth":[]}],"operationId":"getConfigurations","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new configuration","security":[{"BearerAuth":[]}],"operationId":"addConfiguration","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/accounts/{id}/fields":{"get":{"summary":"Gets account fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zoho Account","security":[{"BearerAuth":[]}],"operationId":"deleteZohoAccountById","tags":["Zoho Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoAccount not found"}}}},"/integrations/zoho/configurations":{"get":{"summary":"Gets a list of Zoho Configurations","security":[{"BearerAuth":[]}],"operationId":"listAllZohoConfiguration","tags":["Zoho Configurations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZohoConfiguration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zoho Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoConfiguration"}}}}},"206":{"description":"Partial (paged) collection of Zoho Configurations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoConfiguration"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zoho Configuration","security":[{"BearerAuth":[]}],"operationId":"createZohoConfiguration","tags":["Zoho Configurations"],"requestBody":{"required":true,"description":"data for creating a new Zoho Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"moduleCreate":{"type":"string","enum":["lead","contact","nothing"],"default":"lead"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"default":"contact_lead"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"ZohoConfiguration successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/configurations/{id}":{"get":{"summary":"Gets a single Zoho Configuration","security":[{"BearerAuth":[]}],"operationId":"getZohoConfigurationById","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration to get"}],"responses":{"200":{"description":"ZohoConfiguration with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoConfiguration"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoConfiguration not found"}}},"put":{"summary":"Update an existing Zoho Configuration","security":[{"BearerAuth":[]}],"operationId":"updateZohoConfigurationById","tags":["Zoho Configurations"],"requestBody":{"required":true,"description":"data for updating a new Zoho Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"moduleCreate":{"type":"string","enum":["lead","contact","nothing"],"default":"lead"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"default":"contact_lead"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoConfiguration not found"}}}},"/integrations/zoho/configurations/{id}/fields":{"get":{"summary":"Gets configurations fields","security":[{"BearerAuth":[]}],"operationId":"getFields","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/configurations/{id}/subjects":{"get":{"summary":"Gets configurations subjects","security":[{"BearerAuth":[]}],"operationId":"getSubjects","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/configurations/{id}/descriptions":{"get":{"summary":"Gets configurations descriptions","security":[{"BearerAuth":[]}],"operationId":"getDescriptions","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/configurations/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zoho Configuration","security":[{"BearerAuth":[]}],"operationId":"deleteZohoConfigurationById","tags":["Zoho Configurations"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoConfiguration to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoConfiguration not found"}}}},"/integrations/zoho/fields":{"get":{"summary":"Gets a list of Zoho Fields","security":[{"BearerAuth":[]}],"operationId":"listAllZohoField","tags":["Zoho Fields"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ZohoField"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Zoho Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoField"}}}}},"206":{"description":"Partial (paged) collection of Zoho Fields","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZohoField"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Zoho Field","security":[{"BearerAuth":[]}],"operationId":"createZohoField","tags":["Zoho Fields"],"requestBody":{"required":true,"description":"data for creating a new Zoho Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"responses":{"201":{"description":"ZohoField successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/integrations/zoho/fields/{id}":{"get":{"summary":"Gets a single Zoho Field","security":[{"BearerAuth":[]}],"operationId":"getZohoFieldById","tags":["Zoho Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoField to get"}],"responses":{"200":{"description":"ZohoField with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoField"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoField not found"}}},"put":{"summary":"Update an existing Zoho Field","security":[{"BearerAuth":[]}],"operationId":"updateZohoFieldById","tags":["Zoho Fields"],"requestBody":{"required":true,"description":"data for updating a new Zoho Field","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"default":"string"},"content":{"type":"string"},"key":{"type":"string"},"keyType":{"type":"string","enum":["string","variable","customVariable"]},"keyContent":{"type":"string"},"idField":{"type":"string"},"nameField":{"type":"string"},"customField":{"type":"boolean","default":true},"variableName":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoField to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoField not found"}}}},"/integrations/zoho/fields/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Zoho Field","security":[{"BearerAuth":[]}],"operationId":"deleteZohoFieldById","tags":["Zoho Fields"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ZohoField to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ZohoField not found"}}}},"/jira":{"post":{"summary":"Creates a new issue","security":[{"BearerAuth":[]}],"operationId":"createJiraIssue","tags":["Issue"],"requestBody":{"required":true,"description":"Issue content","content":{"application/json":{"schema":{"type":"object","properties":{"issuetype":{"type":"string","description":"the issue type","default":"Bug"},"summary":{"type":"string","description":"short description of the issue"},"description":{"type":"string","description":"the issue full description"}},"required":["summary","description"]}}}},"responses":{"201":{"description":"issue submitted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/answers/reports":{"get":{"summary":"Gets a list of Reports","security":[{"BearerAuth":[]}],"operationId":"listAllJscriptyAnswerReport","tags":["JscriptyAnswerReport"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each JscriptyAnswerReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyAnswerReport"}}}}},"206":{"description":"Partial (paged) collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyAnswerReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Report","security":[{"BearerAuth":[]}],"operationId":"createJscriptyAnswerReport","tags":["JscriptyAnswerReport"],"requestBody":{"required":true,"description":"data for creating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"questionId":{"type":"string"}}}}}},"responses":{"201":{"description":"JscriptyAnswerReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyAnswerReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/answers/reports/describe":{"get":{"summary":"Gets table info about Reports","security":[{"BearerAuth":[]}],"operationId":"describeJscriptyAnswerReport","tags":["JscriptyAnswerReport"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/answers/reports/{id}":{"get":{"summary":"Gets a single Report","security":[{"BearerAuth":[]}],"operationId":"getJscriptyAnswerReportById","tags":["JscriptyAnswerReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyAnswerReport to get"}],"responses":{"200":{"description":"JscriptyAnswerReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyAnswerReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyAnswerReport not found"}}},"put":{"summary":"Update an existing Report","security":[{"BearerAuth":[]}],"operationId":"updateJscriptyAnswerReportById","tags":["JscriptyAnswerReport"],"requestBody":{"required":true,"description":"data for updating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"questionId":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyAnswerReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyAnswerReport not found"}}}},"/jscripty/answers/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Report","security":[{"BearerAuth":[]}],"operationId":"deleteJscriptyAnswerReportById","tags":["JscriptyAnswerReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyAnswerReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyAnswerReport not found"}}}},"/jscripty/projects":{"get":{"summary":"Gets a list of Projects","security":[{"BearerAuth":[]}],"operationId":"listAllJscriptyProject","tags":["Jscripty Projects"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each JscriptyProject"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Projects","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyProject"}}}}},"206":{"description":"Partial (paged) collection of Projects","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyProject"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Project","security":[{"BearerAuth":[]}],"operationId":"createJscriptyProject","tags":["Jscripty Projects"],"requestBody":{"required":true,"description":"data for creating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"formData":{"type":"string"},"enableUncompleteSave":{"type":"boolean","default":true},"sendUnpauseOnSubmit":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"JscriptyProject successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/{id}":{"get":{"summary":"Gets a single Project","security":[{"BearerAuth":[]}],"operationId":"getJscriptyProjectById","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject to get"}],"responses":{"200":{"description":"JscriptyProject with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyProject not found"}}},"put":{"summary":"Update an existing Project","security":[{"BearerAuth":[]}],"operationId":"updateJscriptyProjectById","tags":["Jscripty Projects"],"requestBody":{"required":true,"description":"data for updating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"formData":{"type":"string"},"enableUncompleteSave":{"type":"boolean","default":true},"sendUnpauseOnSubmit":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyProject not found"}}}},"/jscripty/projects/{id}/sessions":{"get":{"summary":"Gets jscripty project sessions","security":[{"BearerAuth":[]}],"operationId":"getSessions","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/{id}/answers":{"get":{"summary":"Gets jscripty project answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/{id}/summary":{"get":{"summary":"Gets jscripty project summary","security":[{"BearerAuth":[]}],"operationId":"getSummary","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/clone":{"post":{"summary":"Clone an existing Project","security":[{"BearerAuth":[]}],"operationId":"cloneJscriptyProject","tags":["Jscripty Projects"],"requestBody":{"required":true,"description":"data for creating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Project to clone"},"name":{"type":"string"},"description":{"type":"string"},"formData":{"type":"string"},"enableUncompleteSave":{"type":"boolean","default":true},"sendUnpauseOnSubmit":{"type":"boolean","default":false}},"required":["id"]}}}},"responses":{"201":{"description":"JscriptyProject successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/projects/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Project","security":[{"BearerAuth":[]}],"operationId":"deleteJscriptyProjectById","tags":["Jscripty Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyProject to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyProject not found"}}}},"/jscripty/questions/reports":{"get":{"summary":"Gets a list of Reports","security":[{"BearerAuth":[]}],"operationId":"listAllJscriptyQuestionReport","tags":["JscriptyQuestionReport"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each JscriptyQuestionReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyQuestionReport"}}}}},"206":{"description":"Partial (paged) collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptyQuestionReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Report","security":[{"BearerAuth":[]}],"operationId":"createJscriptyQuestionReport","tags":["JscriptyQuestionReport"],"requestBody":{"required":true,"description":"data for creating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"questionId":{"type":"string"}}}}}},"responses":{"201":{"description":"JscriptyQuestionReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyQuestionReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/questions/reports/describe":{"get":{"summary":"Gets table info about Reports","security":[{"BearerAuth":[]}],"operationId":"describeJscriptyQuestionReport","tags":["JscriptyQuestionReport"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/questions/reports/{id}":{"get":{"summary":"Gets a single Report","security":[{"BearerAuth":[]}],"operationId":"getJscriptyQuestionReportById","tags":["JscriptyQuestionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyQuestionReport to get"}],"responses":{"200":{"description":"JscriptyQuestionReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptyQuestionReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyQuestionReport not found"}}},"put":{"summary":"Update an existing Report","security":[{"BearerAuth":[]}],"operationId":"updateJscriptyQuestionReportById","tags":["JscriptyQuestionReport"],"requestBody":{"required":true,"description":"data for updating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"questionId":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyQuestionReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyQuestionReport not found"}}}},"/jscripty/questions/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Report","security":[{"BearerAuth":[]}],"operationId":"deleteJscriptyQuestionReportById","tags":["JscriptyQuestionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptyQuestionReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptyQuestionReport not found"}}}},"/jscripty/sessions/reports":{"get":{"summary":"Gets a list of Reports","security":[{"BearerAuth":[]}],"operationId":"listAllJscriptySessionReport","tags":["JscriptySessionReport"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each JscriptySessionReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptySessionReport"}}}}},"206":{"description":"Partial (paged) collection of Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JscriptySessionReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Report","security":[{"BearerAuth":[]}],"operationId":"createJscriptySessionReport","tags":["JscriptySessionReport"],"requestBody":{"required":true,"description":"data for creating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"starttime":{"type":"string"},"endtime":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"completed":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"JscriptySessionReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptySessionReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/sessions/reports/describe":{"get":{"summary":"Gets table info about Reports","security":[{"BearerAuth":[]}],"operationId":"describeJscriptySessionReport","tags":["JscriptySessionReport"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/sessions/reports/{id}":{"get":{"summary":"Gets a single Report","security":[{"BearerAuth":[]}],"operationId":"getJscriptySessionReportById","tags":["JscriptySessionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptySessionReport to get"}],"responses":{"200":{"description":"JscriptySessionReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JscriptySessionReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptySessionReport not found"}}},"put":{"summary":"Update an existing Report","security":[{"BearerAuth":[]}],"operationId":"updateJscriptySessionReportById","tags":["JscriptySessionReport"],"requestBody":{"required":true,"description":"data for updating a new Report","content":{"application/json":{"schema":{"type":"object","properties":{"starttime":{"type":"string"},"endtime":{"type":"string"},"membername":{"type":"string"},"projectname":{"type":"string"},"queue":{"type":"string"},"uniqueid":{"type":"string"},"calleridname":{"type":"string"},"calleridnum":{"type":"string"},"completed":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptySessionReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptySessionReport not found"}}}},"/jscripty/sessions/reports/{id}/questions":{"get":{"summary":"Gets Jscripty Session questions","security":[{"BearerAuth":[]}],"operationId":"getQuestions","tags":["JscriptySessionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptySessionReport"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/jscripty/sessions/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Report","security":[{"BearerAuth":[]}],"operationId":"deleteJscriptySessionReportById","tags":["JscriptySessionReport"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the JscriptySessionReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"JscriptySessionReport not found"}}}},"/license/":{"get":{"summary":"Gets License Info","operationId":"index","tags":["License"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/license/{id}":{"put":{"summary":"Update License Info","security":[{"BearerAuth":[]}],"operationId":"update","tags":["License"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the License"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllMailAccount","tags":["Mail Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeMailAccount","tags":["Mail Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getMailAccountById","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount to get"}],"responses":{"200":{"description":"MailAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateMailAccountById","tags":["Mail Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"},"service":{"type":"boolean","default":false},"email":{"type":"string"},"active":{"type":"boolean","default":true},"key":{"type":"string"},"template":{"type":"string"},"markAsUnread":{"type":"boolean","default":false},"fontFamily":{"type":"string","default":"Arial,Helvetica,sans-serif"},"fontSize":{"type":"integer","default":13},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}<br/>Subject : {{message.subject}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailAccount not found"}}},"delete":{"summary":"Deletes a mail account","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/in_servers":{"get":{"summary":"Gets account IMAP server","security":[{"BearerAuth":[]}],"operationId":"getImap","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new IMAP server","security":[{"BearerAuth":[]}],"operationId":"addImap","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes IMAP server from an account","security":[{"BearerAuth":[]}],"operationId":"removeImap","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/out_servers":{"get":{"summary":"Gets account SMTP server","security":[{"BearerAuth":[]}],"operationId":"getSmtp","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new SMTP server","security":[{"BearerAuth":[]}],"operationId":"addSmtp","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes SMTP server from an account","security":[{"BearerAuth":[]}],"operationId":"removeSmtp","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/interactions":{"get":{"summary":"Gets account interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new interactions","security":[{"BearerAuth":[]}],"operationId":"addInteraction","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/applications":{"get":{"summary":"Gets account applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/messages":{"get":{"summary":"Gets account messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/verify":{"get":{"summary":"Verify mail account","security":[{"BearerAuth":[]}],"operationId":"verifySmtp","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/users":{"get":{"summary":"Gets agents from mail account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a mail account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a mail account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/":{"post":{"summary":"Create a mail account","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Mail Accounts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/accounts/{id}/send":{"post":{"summary":"Send new mail","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Mail Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getMailApplicationById","tags":["Mail Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailApplication to get"}],"responses":{"200":{"description":"MailApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateMailApplicationById","tags":["Mail Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailApplication not found"}}}},"/mail/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteMailApplicationById","tags":["Mail Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailApplication not found"}}}},"/mail/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllMailInteraction","tags":["Mail Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createMailInteraction","tags":["Mail Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"inReplyTo":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"subject":{"type":"string"},"attach":{"type":"boolean","default":false},"read1stAt":{"type":"string"},"substatus":{"type":"string"},"substatusAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgBody":{"type":"string"},"lastMsgText":{"type":"string"}},"required":["firstMsgDirection","lastMsgDirection"]}}}},"responses":{"201":{"description":"MailInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeMailInteraction","tags":["Mail Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getMailInteractionById","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction to get"}],"responses":{"200":{"description":"MailInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateMailInteractionById","tags":["Mail Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"inReplyTo":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"subject":{"type":"string"},"attach":{"type":"boolean","default":false},"read1stAt":{"type":"string"},"substatus":{"type":"string"},"substatusAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgBody":{"type":"string"},"lastMsgText":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailInteraction not found"}}}},"/mail/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new message","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteMailInteractionById","tags":["Mail Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailInteraction not found"}}}},"/mail/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllMailMessage","tags":["Mail Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeMailMessage","tags":["Mail Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getMailMessageById","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage to get"}],"responses":{"200":{"description":"MailMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateMailMessageById","tags":["Mail Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"plainBody":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"cc":{"type":"string"},"bcc":{"type":"string"},"subject":{"type":"string"},"sentAt":{"type":"string"},"attach":{"type":"integer","default":0},"secret":{"type":"boolean","default":false},"readAt":{"type":"string"},"originTo":{"type":"string"},"originCc":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailMessage not found"}}}},"/mail/messages/{id}/download":{"get":{"summary":"Gets message","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/":{"post":{"summary":"Create a message","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Mail Messages"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteMailMessageById","tags":["Mail Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailMessage not found"}}}},"/mail/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllMailQueue","tags":["Mail Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createMailQueue","tags":["Mail Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"responses":{"201":{"description":"MailQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeMailQueue","tags":["Mail Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getMailQueueById","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue to get"}],"responses":{"200":{"description":"MailQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateMailQueueById","tags":["Mail Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueue not found"}}}},"/mail/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteMailQueueById","tags":["Mail Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueue not found"}}}},"/mail/reports/queue":{"get":{"summary":"Gets a list of Mail Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllMailQueueReport","tags":["Mail Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Mail Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Mail Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Mail Queue Report","security":[{"BearerAuth":[]}],"operationId":"createMailQueueReport","tags":["Mail Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Mail Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"MailQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/reports/queue/describe":{"get":{"summary":"Gets table info about Mail Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeMailQueueReport","tags":["Mail Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/reports/queue/{id}":{"get":{"summary":"Gets a single Mail Queue Report","security":[{"BearerAuth":[]}],"operationId":"getMailQueueReportById","tags":["Mail Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueueReport to get"}],"responses":{"200":{"description":"MailQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueueReport not found"}}},"put":{"summary":"Update an existing Mail Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateMailQueueReportById","tags":["Mail Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Mail Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueueReport not found"}}}},"/mail/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Mail Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteMailQueueReportById","tags":["Mail Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailQueueReport not found"}}}},"/mail/out_servers":{"get":{"summary":"Gets a list of SMTPs","security":[{"BearerAuth":[]}],"operationId":"listAllMailServerOut","tags":["Mail SMTP"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailServerOut"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of SMTPs","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailServerOut"}}}}},"206":{"description":"Partial (paged) collection of SMTPs","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailServerOut"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new SMTP","security":[{"BearerAuth":[]}],"operationId":"createMailServerOut","tags":["Mail SMTP"],"requestBody":{"required":true,"description":"data for creating a new SMTP","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"host":{"type":"string"},"user":{"type":"string"},"pass":{"type":"string"},"port":{"type":"integer"},"secure":{"type":"boolean","default":false},"service":{"type":"string"},"authentication":{"type":"boolean","default":true}}}}}},"responses":{"201":{"description":"MailServerOut successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailServerOut"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/out_servers/{id}":{"get":{"summary":"Gets a single SMTP","security":[{"BearerAuth":[]}],"operationId":"getMailServerOutById","tags":["Mail SMTP"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailServerOut to get"}],"responses":{"200":{"description":"MailServerOut with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailServerOut"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailServerOut not found"}}},"put":{"summary":"Update an existing SMTP","security":[{"BearerAuth":[]}],"operationId":"updateMailServerOutById","tags":["Mail SMTP"],"requestBody":{"required":true,"description":"data for updating a new SMTP","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"host":{"type":"string"},"user":{"type":"string"},"pass":{"type":"string"},"port":{"type":"integer"},"secure":{"type":"boolean","default":false},"service":{"type":"string"},"authentication":{"type":"boolean","default":true}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailServerOut to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailServerOut not found"}}}},"/mail/out_servers/{id}/destroy_many":{"delete":{"summary":"Destroy an existing SMTP","security":[{"BearerAuth":[]}],"operationId":"deleteMailServerOutById","tags":["Mail SMTP"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailServerOut to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailServerOut not found"}}}},"/mail/substatuses":{"get":{"summary":"Gets a list of Substatuses","security":[{"BearerAuth":[]}],"operationId":"listAllMailSubstatus","tags":["Mail Substatuses"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailSubstatus"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Substatuses","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailSubstatus"}}}}},"206":{"description":"Partial (paged) collection of Substatuses","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailSubstatus"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createMailSubstatus","tags":["Mail Substatuses"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"MailSubstatus successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSubstatus"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/substatuses/describe":{"get":{"summary":"Gets table info about Substatuses","security":[{"BearerAuth":[]}],"operationId":"describeMailSubstatus","tags":["Mail Substatuses"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/substatuses/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getMailSubstatusById","tags":["Mail Substatuses"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailSubstatus to get"}],"responses":{"200":{"description":"MailSubstatus with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSubstatus"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailSubstatus not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateMailSubstatusById","tags":["Mail Substatuses"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailSubstatus to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailSubstatus not found"}}}},"/mail/substatuses/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteMailSubstatusById","tags":["Mail Substatuses"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailSubstatus to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailSubstatus not found"}}}},"/mail/reports/transfer":{"get":{"summary":"Gets a list of Mail Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllMailTransferReport","tags":["Mail Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MailTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Mail Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Mail Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Mail Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createMailTransferReport","tags":["Mail Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Mail Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"MailTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/reports/transfer/describe":{"get":{"summary":"Gets table info about Mail Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeMailTransferReport","tags":["Mail Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/mail/reports/transfer/{id}":{"get":{"summary":"Gets a single Mail Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getMailTransferReportById","tags":["Mail Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailTransferReport to get"}],"responses":{"200":{"description":"MailTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailTransferReport not found"}}},"put":{"summary":"Update an existing Mail Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateMailTransferReportById","tags":["Mail Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Mail Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailTransferReport not found"}}}},"/mail/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Mail Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteMailTransferReportById","tags":["Mail Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MailTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MailTransferReport not found"}}}},"/members/reports":{"get":{"summary":"Gets a list of Member Reports","security":[{"BearerAuth":[]}],"operationId":"listAllMemberReport","tags":["Member Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each MemberReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Member Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MemberReport"}}}}},"206":{"description":"Partial (paged) collection of Member Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MemberReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/members/reports/describe":{"get":{"summary":"Gets table info about Member Reports","security":[{"BearerAuth":[]}],"operationId":"describeMemberReport","tags":["Member Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/members/reports/{id}":{"get":{"summary":"Gets a single Member Report","security":[{"BearerAuth":[]}],"operationId":"getMemberReportById","tags":["Member Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the MemberReport to get"}],"responses":{"200":{"description":"MemberReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"MemberReport not found"}}}},"/migrations":{"get":{"summary":"Gets a list of Migrations","operationId":"listAllMigration","tags":["Migrations"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Migration"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Migrations","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Migration"}}}}},"206":{"description":"Partial (paged) collection of Migrations","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Migration"}}}}}}}},"/networks":{"get":{"summary":"Gets a list of Networks","security":[{"BearerAuth":[]}],"operationId":"listAllNetwork","tags":["Networks"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Network"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Networks","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}}}},"206":{"description":"Partial (paged) collection of Networks","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/networks/{id}":{"get":{"summary":"Gets a single Network","security":[{"BearerAuth":[]}],"operationId":"getNetworkById","tags":["Networks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Network to get"}],"responses":{"200":{"description":"Network with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Network not found"}}},"put":{"summary":"Update an existing network","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Networks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Network"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Deletes a network","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Networks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Network"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/networks/":{"post":{"summary":"Create a new network","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Networks"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/notifications/":{"post":{"summary":"Send notification to user","security":[{"BearerAuth":[]}],"operationId":"sendNotification","tags":["Notifications"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelAccount","tags":["Openchannel Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Account","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelAccount","tags":["Openchannel Accounts"],"requestBody":{"required":true,"description":"data for creating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"token":{"type":"string","default":"opoXzKt8ZC9vMwf35tCZb0Y8Ci6w5NXM"},"replyUri":{"type":"string"},"key":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"mapKey":{"type":"string"},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}},"required":["name","key"]}}}},"responses":{"201":{"description":"OpenchannelAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelAccount","tags":["Openchannel Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelAccountById","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount to get"}],"responses":{"200":{"description":"OpenchannelAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelAccountById","tags":["Openchannel Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"token":{"type":"string","default":"HgITaNXHR7se5sobT0VIEUDhnuXiOOoL"},"replyUri":{"type":"string"},"key":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"mapKey":{"type":"string"},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled","default":null},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelAccount not found"}}}},"/openchannel/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/applications":{"get":{"summary":"Gets account applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/interactions":{"get":{"summary":"Gets Openchannel Account Interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/users":{"get":{"summary":"Gets agents from openchannel account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a openchannel account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a openchannel account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/notify":{"post":{"summary":"Notify new message","operationId":"notify","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"}}}},"/openchannel/accounts/{id}/send":{"post":{"summary":"Send new openchannel message","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Account","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelAccountById","tags":["Openchannel Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelAccount not found"}}}},"/openchannel/applications":{"get":{"summary":"Gets a list of Applications","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelApplication","tags":["Openchannel Applications"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelApplication"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelApplication"}}}}},"206":{"description":"Partial (paged) collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelApplication"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Application","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelApplication","tags":["Openchannel Applications"],"requestBody":{"required":true,"description":"data for creating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}},"required":["priority","app"]}}}},"responses":{"201":{"description":"OpenchannelApplication successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelApplicationById","tags":["Openchannel Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelApplication to get"}],"responses":{"200":{"description":"OpenchannelApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelApplicationById","tags":["Openchannel Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelApplication not found"}}}},"/openchannel/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelApplicationById","tags":["Openchannel Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelApplication not found"}}}},"/openchannel/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelInteraction","tags":["Openchannel Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelInteraction","tags":["Openchannel Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"read1stAt":{"type":"string"},"threadId":{"type":"string"},"externalUrl":{"type":"string"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"from":{"type":"string"}},"required":["lastMsgDirection"]}}}},"responses":{"201":{"description":"OpenchannelInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelInteraction","tags":["Openchannel Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelInteractionById","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction to get"}],"responses":{"200":{"description":"OpenchannelInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelInteractionById","tags":["Openchannel Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"read1stAt":{"type":"string"},"threadId":{"type":"string"},"externalUrl":{"type":"string"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"from":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelInteraction not found"}}}},"/openchannel/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelInteractionById","tags":["Openchannel Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelInteraction not found"}}}},"/openchannel/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelMessage","tags":["Openchannel Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelMessage","tags":["Openchannel Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"secret":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"OpenchannelMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelMessage","tags":["Openchannel Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelMessageById","tags":["Openchannel Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage to get"}],"responses":{"200":{"description":"OpenchannelMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelMessageById","tags":["Openchannel Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"secret":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelMessage not found"}}}},"/openchannel/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Openchannel Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Openchannel Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelMessageById","tags":["Openchannel Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelMessage not found"}}}},"/openchannel/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelQueue","tags":["Openchannel Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelQueue","tags":["Openchannel Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"responses":{"201":{"description":"OpenchannelQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelQueue","tags":["Openchannel Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelQueueById","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue to get"}],"responses":{"200":{"description":"OpenchannelQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelQueueById","tags":["Openchannel Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueue not found"}}}},"/openchannel/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelQueueById","tags":["Openchannel Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueue not found"}}}},"/openchannel/reports/queue":{"get":{"summary":"Gets a list of Openchannel Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelQueueReport","tags":["Openchannel Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Openchannel Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Openchannel Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Openchannel Queue Report","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelQueueReport","tags":["Openchannel Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Openchannel Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"OpenchannelQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/reports/queue/describe":{"get":{"summary":"Gets table info about Openchannel Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelQueueReport","tags":["Openchannel Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/reports/queue/{id}":{"get":{"summary":"Gets a single Openchannel Queue Report","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelQueueReportById","tags":["Openchannel Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueueReport to get"}],"responses":{"200":{"description":"OpenchannelQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueueReport not found"}}},"put":{"summary":"Update an existing Openchannel Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelQueueReportById","tags":["Openchannel Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Openchannel Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueueReport not found"}}}},"/openchannel/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Openchannel Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelQueueReportById","tags":["Openchannel Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelQueueReport not found"}}}},"/openchannel/reports/transfer":{"get":{"summary":"Gets a list of Openchannel Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllOpenchannelTransferReport","tags":["Openchannel Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each OpenchannelTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Openchannel Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Openchannel Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenchannelTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Openchannel Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createOpenchannelTransferReport","tags":["Openchannel Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Openchannel Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"OpenchannelTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/reports/transfer/describe":{"get":{"summary":"Gets table info about Openchannel Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeOpenchannelTransferReport","tags":["Openchannel Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/openchannel/reports/transfer/{id}":{"get":{"summary":"Gets a single Openchannel Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelTransferReportById","tags":["Openchannel Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelTransferReport to get"}],"responses":{"200":{"description":"OpenchannelTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenchannelTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelTransferReport not found"}}},"put":{"summary":"Update an existing Openchannel Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateOpenchannelTransferReportById","tags":["Openchannel Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Openchannel Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelTransferReport not found"}}}},"/openchannel/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Openchannel Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteOpenchannelTransferReportById","tags":["Openchannel Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the OpenchannelTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"OpenchannelTransferReport not found"}}}},"/pauses":{"get":{"summary":"Gets a list of Pauses","security":[{"BearerAuth":[]}],"operationId":"listAllPause","tags":["Pauses"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Pause"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Pauses","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pause"}}}}},"206":{"description":"Partial (paged) collection of Pauses","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pause"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Pause","security":[{"BearerAuth":[]}],"operationId":"createPause","tags":["Pauses"],"requestBody":{"required":true,"description":"data for creating a new Pause","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Pause successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pause"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/pauses/{id}":{"get":{"summary":"Gets a single Pause","security":[{"BearerAuth":[]}],"operationId":"getPauseById","tags":["Pauses"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Pause to get"}],"responses":{"200":{"description":"Pause with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pause"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Pause not found"}}},"put":{"summary":"Update an existing Pause","security":[{"BearerAuth":[]}],"operationId":"updatePauseById","tags":["Pauses"],"requestBody":{"required":true,"description":"data for updating a new Pause","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Pause to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Pause not found"}}}},"/pauses/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Pause","security":[{"BearerAuth":[]}],"operationId":"deletePauseById","tags":["Pauses"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Pause to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Pause not found"}}}},"/plugins":{"get":{"summary":"Gets a list of Plugins","security":[{"BearerAuth":[]}],"operationId":"listAllPlugin","tags":["Plugins"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Plugin"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Plugins","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Plugin"}}}}},"206":{"description":"Partial (paged) collection of Plugins","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Plugin"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/plugins/webhook":{"get":{"summary":"Redirect a plugin request to the specified path","operationId":"webhookGet","tags":["Plugins"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Redirect a plugin request to the specified path","operationId":"webhookPost","tags":["Plugins"],"responses":{"201":{"description":"successfully created"}}}},"/plugins/{id}":{"get":{"summary":"Gets a single Plugin","security":[{"BearerAuth":[]}],"operationId":"getPluginById","tags":["Plugins"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Plugin to get"}],"responses":{"200":{"description":"Plugin with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plugin"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Plugin not found"}}},"put":{"summary":"Update an existing plugin","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Plugins"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Plugin"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Delete a plugin","security":[{"BearerAuth":[]}],"operationId":"delete","tags":["Plugins"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Plugin"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/plugins/{id}/download":{"get":{"summary":"Download plugin source code","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Plugins"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Plugin"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/plugins/":{"post":{"summary":"Upload new plugin","security":[{"BearerAuth":[]}],"operationId":"postupload","tags":["Plugins"],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/pm2":{"get":{"summary":"Gets pm2 processes","security":[{"BearerAuth":[]}],"operationId":"getPm2Processes","tags":["Pm2"],"responses":{"200":{"description":"list of processes","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Start a single pm2 process","security":[{"BearerAuth":[]}],"operationId":"startPm2Process","tags":["Pm2"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the process"}],"requestBody":{"required":true,"description":"process data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"process name"},"script":{"type":"string","description":"script name"}},"required":["name","script"]}}}},"responses":{"201":{"description":"successfully started"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}}},"/pm2/{id}":{"get":{"summary":"Gets a single pm2 process by id","security":[{"BearerAuth":[]}],"operationId":"getPm2Process","tags":["Pm2"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the process"}],"responses":{"200":{"description":"process information","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}},"put":{"summary":"Update an existing process","security":[{"BearerAuth":[]}],"operationId":"updatePm2Process","tags":["Pm2"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the process"}],"requestBody":{"required":true,"description":"process data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"process name"},"script":{"type":"string","description":"script name"}},"required":["name","script"]}}}},"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}},"delete":{"summary":"Delete an existing process by id","security":[{"BearerAuth":[]}],"operationId":"deletePm2Process","tags":["Pm2"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the process"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}}},"/rpc/voice/channels":{"get":{"summary":"Gets a list of RTVoiceChannels","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceChannels","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTVoiceChannels","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/channels/{uniqueid}/mixmonitor":{"get":{"summary":"Gets a list of RTVoiceChannelMixMonitor","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceChannelMixMonitor","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"}],"responses":{"200":{"description":"list of RTVoiceChannelMixMonitor","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/channels/{uniqueid}/stopmixmonitor":{"get":{"summary":"Gets a list of RTVoiceChannelStopMixMonitor","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceChannelStopMixMonitor","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"}],"responses":{"200":{"description":"list of RTVoiceChannelStopMixMonitor","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/queues":{"get":{"summary":"Gets a list of RTVoiceQueues","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTVoiceQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/chat/queues":{"get":{"summary":"Gets a list of RTChatQueues","security":[{"BearerAuth":[]}],"operationId":"getRTChatQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTChatQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/mail/queues":{"get":{"summary":"Gets a list of RTMailQueues","security":[{"BearerAuth":[]}],"operationId":"getRTMailQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTMailQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/mail/accounts":{"get":{"summary":"Gets a list of RTMailAccounts","security":[{"BearerAuth":[]}],"operationId":"getRTMailAccounts","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTMailAccounts","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/openchannel/queues":{"get":{"summary":"Gets a list of RTOpenchannelQueues","security":[{"BearerAuth":[]}],"operationId":"getRTOpenchannelQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTOpenchannelQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/sms/queues":{"get":{"summary":"Gets a list of RTSmsQueues","security":[{"BearerAuth":[]}],"operationId":"getRTSmsQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTSmsQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/whatsapp/queues":{"get":{"summary":"Gets a list of RTWhatsappQueues","security":[{"BearerAuth":[]}],"operationId":"getRTWhatsappQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTWhatsappQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/fax/queues":{"get":{"summary":"Gets a list of RTFaxQueues","security":[{"BearerAuth":[]}],"operationId":"getRTFaxQueues","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTFaxQueues","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/queues/preview/{id}":{"get":{"summary":"Gets a single preview contact","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueuePreview","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the preview"}],"responses":{"200":{"description":"preview contact","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"preview contact not found"}}}},"/rpc/voice/queues/channels":{"get":{"summary":"Gets a list of RTVoiceQueuesChannels","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueuesChannels","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTVoiceQueuesChannels","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/voice/queues/channels/{uniqueid}":{"get":{"summary":"Gets a single RTVoiceQueueChannel","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueueChannel","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"}],"responses":{"200":{"description":"RT Voice Queue Channel","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Channel not found"}}}},"/rpc/voice/queues/channels/{uniqueid}/hangup":{"get":{"summary":"Hangup a single RTVoiceQueueChannel","security":[{"BearerAuth":[]}],"operationId":"hangupRTVoiceQueueChannel","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"}],"responses":{"200":{"description":"Hangup ok"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Channel not found"}}}},"/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}":{"get":{"summary":"Redirect a single RTVoiceQueueChannel to a specific extension.","security":[{"BearerAuth":[]}],"operationId":"redirectRTVoiceQueueChannel","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"uniqueid","schema":{"type":"integer"},"required":true,"description":"unique id of the channel"},{"in":"path","name":"exten","schema":{"type":"string"},"required":true,"description":"extension name"}],"responses":{"200":{"description":"Redirect ok"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Channel or extension not found"}}}},"/rpc/voice/queues/{id}":{"get":{"summary":"Gets a single RTVoiceQueue","security":[{"BearerAuth":[]}],"operationId":"getRTVoiceQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"RT Voice Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"RT Voice Queue not found"}}}},"/rpc/outbound":{"get":{"summary":"Gets a list of RTOutbound","security":[{"BearerAuth":[]}],"operationId":"getRTOutbound","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTOutbound","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/outbound/channels":{"get":{"summary":"Gets a list of RTOutboundChannels","security":[{"BearerAuth":[]}],"operationId":"getRTOutboundChannels","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTOutboundChannels","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/agents":{"get":{"summary":"Gets a list of RTAgents","security":[{"BearerAuth":[]}],"operationId":"getRTAgents","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTAgents","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/agents/{id}/capacity":{"put":{"summary":"Sets agent capacity","security":[{"BearerAuth":[]}],"operationId":"putRTAgentCapacity","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the agent"}],"requestBody":{"required":true,"description":"Desired capacity payload","content":{"application/json":{"schema":{"type":"object","properties":{"capacity":{"type":"integer","description":"the desired capacity"},"interaction":{"type":"object","description":"interaction"}},"required":["capacity","interaction"]}}}},"responses":{"200":{"description":"Capacity updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"agent id"},"capacity":{"type":"integer","description":"agent capacity"}},"required":["id","capacity"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Agent not found"}}}},"/rpc/telephones":{"get":{"summary":"Gets a list of RTTelephones","security":[{"BearerAuth":[]}],"operationId":"getRTTelephones","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTTelephones","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/trunks":{"get":{"summary":"Gets a list of RTTrunks","security":[{"BearerAuth":[]}],"operationId":"getRTTrunks","tags":["RPC Realtime"],"responses":{"200":{"description":"list of RTTrunks","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/campaigns":{"get":{"summary":"Gets a list of campaigns","security":[{"BearerAuth":[]}],"operationId":"getCampaigns","tags":["RPC Realtime"],"responses":{"200":{"description":"list of campaigns","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/fax/accounts":{"get":{"summary":"Gets a list of FaxAccounts","security":[{"BearerAuth":[]}],"operationId":"getFaxAccounts","tags":["RPC Realtime"],"responses":{"200":{"description":"list of FaxAccounts","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/chat/queues/waitinginteractions":{"get":{"summary":"Gets a list of chatQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getChatQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of chatQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/mail/queues/waitinginteractions":{"get":{"summary":"Gets a list of mailQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getMailQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of mailQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/openchannel/queues/waitinginteractions":{"get":{"summary":"Gets a list of openchannelQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of openchannelQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/openchannel/queues/{id}/waitinginteractions":{"get":{"summary":"Gets a list of openchannelQueuesIdWaitingInteractions for the queue","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelQueuesWaitingInteractionsForId","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"list of openchannelQueuesIdWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/sms/queues/waitinginteractions":{"get":{"summary":"Gets a list of smsQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getSmsQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of getSmsQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/whatsapp/queues/waitinginteractions":{"get":{"summary":"Gets a list of whatsappQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getWhatsappQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of whatsappQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/fax/queues/waitinginteractions":{"get":{"summary":"Gets a list of faxQueuesWaitingInteractions","security":[{"BearerAuth":[]}],"operationId":"getFaxQueuesWaitingInteractions","tags":["RPC Realtime"],"responses":{"200":{"description":"list of faxQueuesWaitingInteractions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/rpc/mail/queues/{id}/notify":{"post":{"summary":"Notify message to a specific mail queue","security":[{"BearerAuth":[]}],"operationId":"postMailQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the agent"}],"requestBody":{"required":true,"description":"message to be notified","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Agent not found"}}}},"/rpc/mail/queues/{id}":{"get":{"summary":"Gets a single RTMailQueue","security":[{"BearerAuth":[]}],"operationId":"getRTMailQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/chat/queues/{id}/notify":{"post":{"summary":"Notify message to a specific chat queue","security":[{"BearerAuth":[]}],"operationId":"postChatQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the agent"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Agent not found"}}}},"/rpc/chat/queues/{id}":{"get":{"summary":"Gets a single RTChatQueue","security":[{"BearerAuth":[]}],"operationId":"getRTChatQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/fax/queues/{id}/notify":{"post":{"summary":"Notify message to a specific fax queue","security":[{"BearerAuth":[]}],"operationId":"postFaxQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/fax/queues/{id}":{"get":{"summary":"Gets a single RTFaxQueue","security":[{"BearerAuth":[]}],"operationId":"getRTFaxQueue","tags":["RPC Realtimen"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/openchannel/queues/{id}/notify":{"post":{"summary":"Notify message to a specific openchannel queue","security":[{"BearerAuth":[]}],"operationId":"postOpenchannelQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}}},"/rpc/openchannel/queues/{id}":{"get":{"summary":"Gets a single RTOpenchannelQueue","security":[{"BearerAuth":[]}],"operationId":"getRTOpenchannelQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/sms/queues/{id}/notify":{"post":{"summary":"Notify message to a specific sms queue","security":[{"BearerAuth":[]}],"operationId":"postSmsQueueNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Process not found"}}}},"/rpc/whatsapp/queues/{id}/notify":{"post":{"summary":"Notify message to a specific agent","security":[{"BearerAuth":[]}],"operationId":"postAgentNotify","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the agent"}],"responses":{"200":{"description":"Notification","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Agent not found"}}}},"/rpc/sms/queues/{id}":{"get":{"summary":"Gets a single RTSmsQueue","security":[{"BearerAuth":[]}],"operationId":"getRTSmsQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/rpc/whatsapp/queues/{id}":{"get":{"summary":"Gets a single RTWhatsappQueue","security":[{"BearerAuth":[]}],"operationId":"getRTWhatsappQueue","tags":["RPC Realtime"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the queue"}],"responses":{"200":{"description":"Queue","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Queue not found"}}}},"/schedules":{"get":{"summary":"Gets a list of Schedules","security":[{"BearerAuth":[]}],"operationId":"listAllSchedule","tags":["Schedules"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Schedule"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Schedules","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Schedule"}}}}},"206":{"description":"Partial (paged) collection of Schedules","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Schedule"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Schedule","security":[{"BearerAuth":[]}],"operationId":"createSchedule","tags":["Schedules"],"requestBody":{"required":true,"description":"data for creating a new Schedule","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean","default":false},"cron":{"type":"string","default":"0 0 * * *"},"startAt":{"type":"string"},"endAt":{"type":"string"},"subtractNumber":{"type":"integer","default":1},"subtractUnit":{"type":"string","enum":["years","quarters","months","weeks","days","hours","minutes"],"default":"days"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"type":{"type":"string","enum":["custom","default"],"default":"custom"},"sendMail":{"type":"boolean","default":false},"email":{"type":"string"},"cc":{"type":"string"},"bcc":{"type":"string"},"sendIfEmpty":{"type":"boolean","default":true}},"required":["name","active","cron","startAt","endAt","subtractNumber","subtractUnit","output","type"]}}}},"responses":{"201":{"description":"Schedule successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/schedules/{id}":{"get":{"summary":"Gets a single Schedule","security":[{"BearerAuth":[]}],"operationId":"getScheduleById","tags":["Schedules"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Schedule to get"}],"responses":{"200":{"description":"Schedule with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Schedule not found"}}},"put":{"summary":"Update an existing Schedule","security":[{"BearerAuth":[]}],"operationId":"updateScheduleById","tags":["Schedules"],"requestBody":{"required":true,"description":"data for updating a new Schedule","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean","default":false},"cron":{"type":"string","default":"0 0 * * *"},"startAt":{"type":"string"},"endAt":{"type":"string"},"subtractNumber":{"type":"integer","default":1},"subtractUnit":{"type":"string","enum":["years","quarters","months","weeks","days","hours","minutes"],"default":"days"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"type":{"type":"string","enum":["custom","default"],"default":"custom"},"sendMail":{"type":"boolean","default":false},"email":{"type":"string"},"cc":{"type":"string"},"bcc":{"type":"string"},"sendIfEmpty":{"type":"boolean","default":true}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Schedule to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Schedule not found"}}}},"/schedules/{id}/run":{"get":{"summary":"Run Scheduler","security":[{"BearerAuth":[]}],"operationId":"run","tags":["Schedules"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Schedule"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/schedules/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Schedule","security":[{"BearerAuth":[]}],"operationId":"deleteScheduleById","tags":["Schedules"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Schedule to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Schedule not found"}}}},"/screen/recordings":{"get":{"summary":"Gets a list of Recordings","security":[{"BearerAuth":[]}],"operationId":"listAllScreenRecording","tags":["Screen Recordings"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each ScreenRecording"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenRecording"}}}}},"206":{"description":"Partial (paged) collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenRecording"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Recording","security":[{"BearerAuth":[]}],"operationId":"createScreenRecording","tags":["Screen Recordings"],"requestBody":{"required":true,"description":"data for creating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string"},"interactionid":{"type":"string"},"channel":{"type":"string"},"value":{"type":"string"},"rating":{"type":"integer"},"duration":{"type":"integer"},"startedAt":{"type":"string"},"closedAt":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"responses":{"201":{"description":"ScreenRecording successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/screen/recordings/describe":{"get":{"summary":"Gets table info about Recordings","security":[{"BearerAuth":[]}],"operationId":"describeScreenRecording","tags":["Screen Recordings"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/screen/recordings/{id}":{"get":{"summary":"Gets a single Recording","security":[{"BearerAuth":[]}],"operationId":"getScreenRecordingById","tags":["Screen Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ScreenRecording to get"}],"responses":{"200":{"description":"ScreenRecording with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ScreenRecording not found"}}},"put":{"summary":"Update an existing Recording","security":[{"BearerAuth":[]}],"operationId":"updateScreenRecordingById","tags":["Screen Recordings"],"requestBody":{"required":true,"description":"data for updating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string"},"interactionid":{"type":"string"},"channel":{"type":"string"},"value":{"type":"string"},"rating":{"type":"integer"},"duration":{"type":"integer"},"startedAt":{"type":"string"},"closedAt":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ScreenRecording to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"ScreenRecording not found"}}},"delete":{"summary":"Delete screen recording","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Screen Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ScreenRecording"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/screen/recordings/{id}/download":{"get":{"summary":"Download Recording","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Screen Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ScreenRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings":{"get":{"summary":"Gets a list of Settings","security":[{"BearerAuth":[]}],"operationId":"listAllSetting","tags":["Settings"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Setting"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Settings","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Setting"}}}}},"206":{"description":"Partial (paged) collection of Settings","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Setting"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings/now":{"get":{"summary":"Get Server Current Date","operationId":"getDate","tags":["Settings"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/settings/{id}":{"get":{"summary":"Gets a single Setting","operationId":"getSettingById","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting to get"}],"responses":{"200":{"description":"Setting with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Setting"}}}},"404":{"description":"Setting not found"}}},"put":{"summary":"Update an existing Setting","security":[{"BearerAuth":[]}],"operationId":"updateSettingById","tags":["Settings"],"requestBody":{"required":true,"description":"data for updating a new Setting","content":{"application/json":{"schema":{"type":"object","properties":{"min_internal":{"type":"integer","default":1000},"min_mailbox":{"type":"integer","default":1000},"agi_port":{"type":"integer","default":4573},"soundPath":{"type":"string","default":"/var/opt/motion2/server/files/sounds/converted"},"logo":{"type":"string"},"defaultLogo":{"type":"boolean","default":true},"loginLogo":{"type":"string"},"defaultLoginLogo":{"type":"boolean","default":true},"headerWhiteLabel":{"type":"string"},"defaultHeaderWhiteLabel":{"type":"boolean","default":true},"securePassword":{"type":"boolean","default":true},"firstSetup":{"type":"boolean","default":true},"stunaddr":{"type":"string"},"turnaddr":{"type":"string"},"turnusername":{"type":"string"},"turnpassword":{"type":"string"},"pageTitle":{"type":"string"},"defaultPageTitle":{"type":"boolean","default":true},"callRecordingEncryption":{"type":"boolean","default":false},"passwordExpiresDays":{"type":"integer","default":90},"phoneBarAutoUpdater":{"type":"boolean","default":true},"phoneBarAutoUpdaterUrl":{"type":"string","default":"https://www.xcally.com/bar/phonebar/autoupdater.xml"},"enableEmailPreview":{"type":"boolean","default":false},"split":{"type":"boolean","default":true},"splitSizeCsv":{"type":"integer","default":5000},"splitSizePdf":{"type":"integer","default":5000},"splitSizeXlsx":{"type":"integer","default":5000},"messagesAlignment":{"type":"string","default":"alternate"},"chatTimeout":{"type":"integer","default":30},"phoneBarRememberMeEnabled":{"type":"boolean","default":true},"preferred":{"type":"string"},"defaultPreferred":{"type":"boolean","default":true},"rtlSupport":{"type":"boolean","default":false},"defaultScreenRecordingPath":{"type":"string"},"allowedLoginAttempts":{"type":"integer","default":5},"blockDuration":{"type":"integer","default":10},"favicon":{"type":"string"},"defaultFavicon":{"type":"boolean","default":true},"loginMailFrequency":{"type":"integer","default":10},"transcribe":{"type":"boolean","default":false},"automaticTranscribe":{"type":"boolean","default":false},"transcribeAccountId":{"type":"integer"},"transcribeRegion":{"type":"string"},"sentiment":{"type":"boolean","default":false},"automaticSentiment":{"type":"boolean","default":false},"sentimentAccountId":{"type":"integer"},"sentimentRegion":{"type":"string"},"language":{"type":"string"},"bucket":{"type":"string"},"googleSsoEnabled":{"type":"boolean","default":false},"enforcePasswordHistory":{"type":"boolean","default":true},"passwordHistoryLimit":{"type":"integer","default":3}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Setting not found"}}}},"/settings/{id}/logo":{"get":{"summary":"Get logo","operationId":"getLogo","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add logo","security":[{"BearerAuth":[]}],"operationId":"postaddLogo","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings/{id}/logo_login":{"get":{"summary":"Get logo login","operationId":"getLogoLogin","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add logo login","security":[{"BearerAuth":[]}],"operationId":"postaddLogoLogin","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings/{id}/gdpr":{"get":{"summary":"Get gdpr settings","operationId":"gdpr","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/settings/{id}/preferred":{"get":{"summary":"Get Preferred","operationId":"getPreferred","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add Preferred","security":[{"BearerAuth":[]}],"operationId":"postaddPreferred","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/settings/{id}/favicon":{"get":{"summary":"Get Favicon","operationId":"getFavicon","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Add Favicon","security":[{"BearerAuth":[]}],"operationId":"postaddFavicon","tags":["Settings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Setting"}],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllSmsAccount","tags":["Sms Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Account","security":[{"BearerAuth":[]}],"operationId":"createSmsAccount","tags":["Sms Accounts"],"requestBody":{"required":true,"description":"data for creating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","default":"XiWeIvQm9jR44uKXXbaTAMRW3cKSKIDM"},"phone":{"type":"string"},"type":{"type":"string","enum":["twilio","skebby","connectel","clicksend","plivo","clickatell","csc","infobip","intelepeer"]},"accountSid":{"type":"string"},"authId":{"type":"string"},"authToken":{"type":"string"},"smsMethod":{"type":"string","enum":["SI","TI","GP"]},"username":{"type":"string"},"password":{"type":"string"},"apiKey":{"type":"string"},"senderString":{"type":"string"},"deliveryReport":{"type":"boolean","default":false},"description":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"baseUrl":{"type":"string"},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}},"required":["name","key","remote"]}}}},"responses":{"201":{"description":"SmsAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeSmsAccount","tags":["Sms Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getSmsAccountById","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount to get"}],"responses":{"200":{"description":"SmsAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateSmsAccountById","tags":["Sms Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","default":"5sbjWGiIAFCaMsOZLSTaVBFZQrZ6BXaO"},"phone":{"type":"string"},"type":{"type":"string","enum":["twilio","skebby","connectel","clicksend","plivo","clickatell","csc","infobip","intelepeer"]},"accountSid":{"type":"string"},"authId":{"type":"string"},"authToken":{"type":"string"},"smsMethod":{"type":"string","enum":["SI","TI","GP"]},"username":{"type":"string"},"password":{"type":"string"},"apiKey":{"type":"string"},"senderString":{"type":"string"},"deliveryReport":{"type":"boolean","default":false},"description":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":true},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"baseUrl":{"type":"string"},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsAccount not found"}}}},"/sms/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/applications":{"get":{"summary":"Gets account applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/interactions":{"get":{"summary":"Gets Sms Account interactions","security":[{"BearerAuth":[]}],"operationId":"getInteractions","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/status":{"get":{"summary":"Receive message status as get request","operationId":"statusGet","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"summary":"Receive message status","operationId":"status","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"}}}},"/sms/accounts/{id}/users":{"get":{"summary":"Gets agents from sms account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a sms account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a sms account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/notify":{"post":{"summary":"Notify new message","operationId":"notify","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"}}}},"/sms/accounts/{id}/send":{"post":{"summary":"Send new sms message","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Account","security":[{"BearerAuth":[]}],"operationId":"deleteSmsAccountById","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsAccount not found"}}}},"/sms/applications":{"get":{"summary":"Gets a list of Applications","security":[{"BearerAuth":[]}],"operationId":"listAllSmsApplication","tags":["Sms Applications"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsApplication"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsApplication"}}}}},"206":{"description":"Partial (paged) collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsApplication"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Application","security":[{"BearerAuth":[]}],"operationId":"createSmsApplication","tags":["Sms Applications"],"requestBody":{"required":true,"description":"data for creating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}},"required":["priority","app"]}}}},"responses":{"201":{"description":"SmsApplication successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getSmsApplicationById","tags":["Sms Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsApplication to get"}],"responses":{"200":{"description":"SmsApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateSmsApplicationById","tags":["Sms Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsApplication not found"}}}},"/sms/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteSmsApplicationById","tags":["Sms Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsApplication not found"}}}},"/sms/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllSmsInteraction","tags":["Sms Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createSmsInteraction","tags":["Sms Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"phone":{"type":"string"},"read1stAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}},"required":["firstMsgDirection","lastMsgDirection"]}}}},"responses":{"201":{"description":"SmsInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeSmsInteraction","tags":["Sms Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getSmsInteractionById","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction to get"}],"responses":{"200":{"description":"SmsInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateSmsInteractionById","tags":["Sms Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"phone":{"type":"string"},"read1stAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsInteraction not found"}}}},"/sms/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteSmsInteractionById","tags":["Sms Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsInteraction not found"}}}},"/sms/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllSmsMessage","tags":["Sms Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createSmsMessage","tags":["Sms Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"phone":{"type":"string"},"readAt":{"type":"string"},"secret":{"type":"boolean","default":false},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"SmsMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeSmsMessage","tags":["Sms Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getSmsMessageById","tags":["Sms Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage to get"}],"responses":{"200":{"description":"SmsMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateSmsMessageById","tags":["Sms Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"phone":{"type":"string"},"readAt":{"type":"string"},"secret":{"type":"boolean","default":false},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsMessage not found"}}}},"/sms/messages/{id}/status":{"post":{"summary":"Receive message status","operationId":"status","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage"}],"responses":{"201":{"description":"successfully created"}}}},"/sms/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Sms Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteSmsMessageById","tags":["Sms Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsMessage not found"}}}},"/sms/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllSmsQueue","tags":["Sms Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createSmsQueue","tags":["Sms Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"responses":{"201":{"description":"SmsQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeSmsQueue","tags":["Sms Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getSmsQueueById","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue to get"}],"responses":{"200":{"description":"SmsQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateSmsQueueById","tags":["Sms Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueue not found"}}}},"/sms/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteSmsQueueById","tags":["Sms Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueue not found"}}}},"/sms/reports/queue":{"get":{"summary":"Gets a list of Sms Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllSmsQueueReport","tags":["Sms Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sms Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Sms Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Sms Queue Report","security":[{"BearerAuth":[]}],"operationId":"createSmsQueueReport","tags":["Sms Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Sms Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"SmsQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/reports/queue/describe":{"get":{"summary":"Gets table info about Sms Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeSmsQueueReport","tags":["Sms Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/reports/queue/{id}":{"get":{"summary":"Gets a single Sms Queue Report","security":[{"BearerAuth":[]}],"operationId":"getSmsQueueReportById","tags":["Sms Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueueReport to get"}],"responses":{"200":{"description":"SmsQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueueReport not found"}}},"put":{"summary":"Update an existing Sms Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateSmsQueueReportById","tags":["Sms Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Sms Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueueReport not found"}}}},"/sms/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Sms Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteSmsQueueReportById","tags":["Sms Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsQueueReport not found"}}}},"/sms/reports/transfer":{"get":{"summary":"Gets a list of Sms Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllSmsTransferReport","tags":["Sms Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SmsTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sms Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Sms Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Sms Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createSmsTransferReport","tags":["Sms Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Sms Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}},"required":["uniqueid","type","transferredAt"]}}}},"responses":{"201":{"description":"SmsTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/reports/transfer/describe":{"get":{"summary":"Gets table info about Sms Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeSmsTransferReport","tags":["Sms Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sms/reports/transfer/{id}":{"get":{"summary":"Gets a single Sms Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getSmsTransferReportById","tags":["Sms Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsTransferReport to get"}],"responses":{"200":{"description":"SmsTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsTransferReport not found"}}},"put":{"summary":"Update an existing Sms Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateSmsTransferReportById","tags":["Sms Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Sms Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","default":"NOW"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsTransferReport not found"}}}},"/sms/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Sms Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteSmsTransferReportById","tags":["Sms Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SmsTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SmsTransferReport not found"}}}},"/sounds":{"get":{"summary":"Gets a list of Sounds","security":[{"BearerAuth":[]}],"operationId":"listAllSound","tags":["Sounds"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Sound"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Sounds","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Sound"}}}}},"206":{"description":"Partial (paged) collection of Sounds","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Sound"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sounds/{id}":{"get":{"summary":"Gets a single Sound","security":[{"BearerAuth":[]}],"operationId":"getSoundById","tags":["Sounds"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Sound to get"}],"responses":{"200":{"description":"Sound with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sound"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Sound not found"}}},"put":{"summary":"Update an existing new sound","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Sounds"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Sound"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Deletes a sound","security":[{"BearerAuth":[]}],"operationId":"delete","tags":["Sounds"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Sound"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sounds/{id}/download":{"get":{"summary":"Download Sound","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Sounds"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Sound"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/sounds/":{"post":{"summary":"Create a new sound","security":[{"BearerAuth":[]}],"operationId":"postcreate","tags":["Sounds"],"requestBody":{"required":true,"description":"data for uploading a file","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"success."},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllSquareMessage","tags":["Square Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createSquareMessage","tags":["Square Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"body":{"type":"string"},"direction":{"type":"string","enum":["in","out"],"default":"out"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"SquareMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getSquareMessageById","tags":["Square Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareMessage to get"}],"responses":{"200":{"description":"SquareMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateSquareMessageById","tags":["Square Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"body":{"type":"string"},"direction":{"type":"string","enum":["in","out"],"default":"out"},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareMessage not found"}}}},"/square/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteSquareMessageById","tags":["Square Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareMessage not found"}}}},"/square/odbc":{"get":{"summary":"Gets a list of ODBCs","security":[{"BearerAuth":[]}],"operationId":"listAllSquareOdbc","tags":["Square ODBC"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareOdbc"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of ODBCs","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareOdbc"}}}}},"206":{"description":"Partial (paged) collection of ODBCs","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareOdbc"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new ODBC","security":[{"BearerAuth":[]}],"operationId":"createSquareOdbc","tags":["Square ODBC"],"requestBody":{"required":true,"description":"data for creating a new ODBC","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"dsn":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"SquareOdbc successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareOdbc"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/odbc/{id}":{"get":{"summary":"Gets a single ODBC","security":[{"BearerAuth":[]}],"operationId":"getSquareOdbcById","tags":["Square ODBC"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareOdbc to get"}],"responses":{"200":{"description":"SquareOdbc with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareOdbc"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareOdbc not found"}}},"put":{"summary":"Update an existing ODBC","security":[{"BearerAuth":[]}],"operationId":"updateSquareOdbcById","tags":["Square ODBC"],"requestBody":{"required":true,"description":"data for updating a new ODBC","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"dsn":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareOdbc to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareOdbc not found"}}}},"/square/odbc/{id}/test":{"get":{"summary":"Test Odbc","security":[{"BearerAuth":[]}],"operationId":"test","tags":["Square ODBC"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareOdbc"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/odbc/{id}/destroy_many":{"delete":{"summary":"Destroy an existing ODBC","security":[{"BearerAuth":[]}],"operationId":"deleteSquareOdbcById","tags":["Square ODBC"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareOdbc to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareOdbc not found"}}}},"/square/projects":{"get":{"summary":"Gets a list of Projects","security":[{"BearerAuth":[]}],"operationId":"listAllSquareProject","tags":["Square Projects"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareProject"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Projects","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareProject"}}}}},"206":{"description":"Partial (paged) collection of Projects","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareProject"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Project","security":[{"BearerAuth":[]}],"operationId":"createSquareProject","tags":["Square Projects"],"requestBody":{"required":true,"description":"data for creating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"notes":{"type":"string"},"preproduction":{"type":"object"},"production":{"type":"object"}},"required":["name"]}}}},"responses":{"201":{"description":"SquareProject successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/projects/{id}":{"get":{"summary":"Gets a single Project","security":[{"BearerAuth":[]}],"operationId":"getSquareProjectById","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject to get"}],"responses":{"200":{"description":"SquareProject with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareProject"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareProject not found"}}},"put":{"summary":"Update an existing Project","security":[{"BearerAuth":[]}],"operationId":"updateSquareProjectById","tags":["Square Projects"],"requestBody":{"required":true,"description":"data for updating a new Project","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"notes":{"type":"string"},"preproduction":{"type":"object"},"production":{"type":"object"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareProject not found"}}}},"/square/projects/{id}/users":{"get":{"summary":"Gets users permissions from Project","security":[{"BearerAuth":[]}],"operationId":"getUsers","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Adds user permissions to a Project","security":[{"BearerAuth":[]}],"operationId":"addUsers","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes user permissions from a Project","security":[{"BearerAuth":[]}],"operationId":"removeUsers","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/projects/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Project","security":[{"BearerAuth":[]}],"operationId":"deleteSquareProjectById","tags":["Square Projects"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareProject to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareProject not found"}}}},"/square/recordings":{"get":{"summary":"Gets a list of Recordings","security":[{"BearerAuth":[]}],"operationId":"listAllSquareRecording","tags":["Square Recordings"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareRecording"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareRecording"}}}}},"206":{"description":"Partial (paged) collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareRecording"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Recording","security":[{"BearerAuth":[]}],"operationId":"createSquareRecording","tags":["Square Recordings"],"requestBody":{"required":true,"description":"data for creating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"callerid":{"type":"string"},"calleridname":{"type":"string"},"context":{"type":"string"},"extension":{"type":"string"},"priority":{"type":"string"},"accountcode":{"type":"string"},"dnid":{"type":"string"},"projectName":{"type":"string"},"saveName":{"type":"string"},"filename":{"type":"string"},"savePath":{"type":"string"},"format":{"type":"string"}}}}}},"responses":{"201":{"description":"SquareRecording successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/recordings/{id}":{"get":{"summary":"Gets a single Recording","security":[{"BearerAuth":[]}],"operationId":"getSquareRecordingById","tags":["Square Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareRecording to get"}],"responses":{"200":{"description":"SquareRecording with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareRecording not found"}}},"put":{"summary":"Update an existing Recording","security":[{"BearerAuth":[]}],"operationId":"updateSquareRecordingById","tags":["Square Recordings"],"requestBody":{"required":true,"description":"data for updating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"callerid":{"type":"string"},"calleridname":{"type":"string"},"context":{"type":"string"},"extension":{"type":"string"},"priority":{"type":"string"},"accountcode":{"type":"string"},"dnid":{"type":"string"},"projectName":{"type":"string"},"saveName":{"type":"string"},"filename":{"type":"string"},"savePath":{"type":"string"},"format":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareRecording to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareRecording not found"}}}},"/square/recordings/{id}/download":{"get":{"summary":"Download Recording","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Square Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/recordings/{id}/delete":{"delete":{"summary":"Delete recording","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Square Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareRecording"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/reports":{"get":{"summary":"Gets a list of Square Reports","security":[{"BearerAuth":[]}],"operationId":"listAllSquareReport","tags":["Square Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Square Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareReport"}}}}},"206":{"description":"Partial (paged) collection of Square Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Square Report","security":[{"BearerAuth":[]}],"operationId":"createSquareReport","tags":["Square Reports"],"requestBody":{"required":true,"description":"data for creating a new Square Report","content":{"application/json":{"schema":{"type":"object","properties":{"network":{"type":"string"},"network_script":{"type":"string"},"request":{"type":"string"},"channel":{"type":"string"},"language":{"type":"string"},"type":{"type":"string"},"uniqueid":{"type":"string"},"version":{"type":"string"},"callerid":{"type":"string"},"calleridname":{"type":"string"},"callingpres":{"type":"string"},"callingani2":{"type":"string"},"callington":{"type":"string"},"callingtns":{"type":"string"},"dnid":{"type":"string"},"rdnis":{"type":"string"},"context":{"type":"string"},"extension":{"type":"string"},"priority":{"type":"string"},"enhanced":{"type":"string"},"accountcode":{"type":"string"},"threadid":{"type":"string"},"project_name":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"bot":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"SquareReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/reports/describe":{"get":{"summary":"Gets table info about Square Reports","security":[{"BearerAuth":[]}],"operationId":"describeSquareReport","tags":["Square Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/reports/{id}":{"get":{"summary":"Gets a single Square Report","security":[{"BearerAuth":[]}],"operationId":"getSquareReportById","tags":["Square Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareReport to get"}],"responses":{"200":{"description":"SquareReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareReport not found"}}},"put":{"summary":"Update an existing Square Report","security":[{"BearerAuth":[]}],"operationId":"updateSquareReportById","tags":["Square Reports"],"requestBody":{"required":true,"description":"data for updating a new Square Report","content":{"application/json":{"schema":{"type":"object","properties":{"network":{"type":"string"},"network_script":{"type":"string"},"request":{"type":"string"},"channel":{"type":"string"},"language":{"type":"string"},"type":{"type":"string"},"uniqueid":{"type":"string"},"version":{"type":"string"},"callerid":{"type":"string"},"calleridname":{"type":"string"},"callingpres":{"type":"string"},"callingani2":{"type":"string"},"callington":{"type":"string"},"callingtns":{"type":"string"},"dnid":{"type":"string"},"rdnis":{"type":"string"},"context":{"type":"string"},"extension":{"type":"string"},"priority":{"type":"string"},"enhanced":{"type":"string"},"accountcode":{"type":"string"},"threadid":{"type":"string"},"project_name":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"bot":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareReport not found"}}}},"/square/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Square Report","security":[{"BearerAuth":[]}],"operationId":"deleteSquareReportById","tags":["Square Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareReport not found"}}}},"/square/details/reports":{"get":{"summary":"Gets a list of Square Detail Reports","security":[{"BearerAuth":[]}],"operationId":"listAllSquareDetailsReport","tags":["Square Details Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each SquareDetailsReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Square Detail Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareDetailsReport"}}}}},"206":{"description":"Partial (paged) collection of Square Detail Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SquareDetailsReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Square Detail Report","security":[{"BearerAuth":[]}],"operationId":"createSquareDetailsReport","tags":["Square Details Reports"],"requestBody":{"required":true,"description":"data for creating a new Square Detail Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"node":{"type":"string"},"application":{"type":"string"},"data":{"type":"string"},"project_name":{"type":"string"},"callerid":{"type":"string"}}}}}},"responses":{"201":{"description":"SquareDetailsReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareDetailsReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/details/reports/describe":{"get":{"summary":"Gets table info about Square Detail Reports","security":[{"BearerAuth":[]}],"operationId":"describeSquareDetailsReport","tags":["Square Details Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/square/details/reports/{id}":{"get":{"summary":"Gets a single Square Detail Report","security":[{"BearerAuth":[]}],"operationId":"getSquareDetailsReportById","tags":["Square Details Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareDetailsReport to get"}],"responses":{"200":{"description":"SquareDetailsReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SquareDetailsReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareDetailsReport not found"}}},"put":{"summary":"Update an existing Square Detail Report","security":[{"BearerAuth":[]}],"operationId":"updateSquareDetailsReportById","tags":["Square Details Reports"],"requestBody":{"required":true,"description":"data for updating a new Square Detail Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"node":{"type":"string"},"application":{"type":"string"},"data":{"type":"string"},"project_name":{"type":"string"},"callerid":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareDetailsReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareDetailsReport not found"}}}},"/square/details/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Square Detail Report","security":[{"BearerAuth":[]}],"operationId":"deleteSquareDetailsReportById","tags":["Square Details Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the SquareDetailsReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"SquareDetailsReport not found"}}}},"/system":{"get":{"summary":"Gets system information","security":[{"BearerAuth":[]}],"operationId":"getSystemInformation","tags":["System Information"],"responses":{"200":{"description":"system information","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/system/process":{"get":{"summary":"Gets process information","security":[{"BearerAuth":[]}],"operationId":"getSystemProcessInformation","tags":["System Information"],"responses":{"200":{"description":"process information","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/tags":{"get":{"summary":"Gets a list of Tags","security":[{"BearerAuth":[]}],"operationId":"listAllTag","tags":["Tags"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Tag"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Tags","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}},"206":{"description":"Partial (paged) collection of Tags","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Tag","security":[{"BearerAuth":[]}],"operationId":"createTag","tags":["Tags"],"requestBody":{"required":true,"description":"data for creating a new Tag","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string","default":"#0091EA"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Tag successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/tags/{id}":{"get":{"summary":"Gets a single Tag","security":[{"BearerAuth":[]}],"operationId":"getTagById","tags":["Tags"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Tag to get"}],"responses":{"200":{"description":"Tag with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Tag not found"}}},"put":{"summary":"Update an existing Tag","security":[{"BearerAuth":[]}],"operationId":"updateTagById","tags":["Tags"],"requestBody":{"required":true,"description":"data for updating a new Tag","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string","default":"#0091EA"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Tag to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Tag not found"}}}},"/tags/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Tag","security":[{"BearerAuth":[]}],"operationId":"deleteTagById","tags":["Tags"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Tag to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Tag not found"}}}},"/teams":{"get":{"summary":"Gets a list of Teams","security":[{"BearerAuth":[]}],"operationId":"listAllTeam","tags":["Teams"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Team"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Teams","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"206":{"description":"Partial (paged) collection of Teams","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Team","security":[{"BearerAuth":[]}],"operationId":"createTeam","tags":["Teams"],"requestBody":{"required":true,"description":"data for creating a new Team","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Team successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/teams/{id}":{"get":{"summary":"Gets a single Team","security":[{"BearerAuth":[]}],"operationId":"getTeamById","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team to get"}],"responses":{"200":{"description":"Team with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Team not found"}}},"put":{"summary":"Update an existing Team","security":[{"BearerAuth":[]}],"operationId":"updateTeamById","tags":["Teams"],"requestBody":{"required":true,"description":"data for updating a new Team","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Team not found"}}}},"/teams/{id}/queues":{"get":{"summary":"Gets Queues list","security":[{"BearerAuth":[]}],"operationId":"getQueues","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add queues to a team","security":[{"BearerAuth":[]}],"operationId":"addQueues","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove queues to a team","security":[{"BearerAuth":[]}],"operationId":"removeQueues","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/teams/{id}/users":{"get":{"summary":"Gets agents from team","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Adds agents to a team","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a team","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/teams/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Team","security":[{"BearerAuth":[]}],"operationId":"deleteTeamById","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Team to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Team not found"}}}},"/templates":{"get":{"summary":"Gets a list of Templates","security":[{"BearerAuth":[]}],"operationId":"listAllTemplate","tags":["Templates"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Template"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Templates","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}}},"206":{"description":"Partial (paged) collection of Templates","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Template","security":[{"BearerAuth":[]}],"operationId":"createTemplate","tags":["Templates"],"requestBody":{"required":true,"description":"data for creating a new Template","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"html":{"type":"string"}}}}}},"responses":{"201":{"description":"Template successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/templates/{id}":{"get":{"summary":"Gets a single Template","security":[{"BearerAuth":[]}],"operationId":"getTemplateById","tags":["Templates"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Template to get"}],"responses":{"200":{"description":"Template with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Template not found"}}},"put":{"summary":"Update an existing Template","security":[{"BearerAuth":[]}],"operationId":"updateTemplateById","tags":["Templates"],"requestBody":{"required":true,"description":"data for updating a new Template","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"html":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Template to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Template not found"}}}},"/templates/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Template","security":[{"BearerAuth":[]}],"operationId":"deleteTemplateById","tags":["Templates"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Template to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Template not found"}}}},"/triggers":{"get":{"summary":"Gets a list of Triggers","security":[{"BearerAuth":[]}],"operationId":"listAllTrigger","tags":["Triggers"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Trigger"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Triggers","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}}}}},"206":{"description":"Partial (paged) collection of Triggers","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Trigger","security":[{"BearerAuth":[]}],"operationId":"createTrigger","tags":["Triggers"],"requestBody":{"required":true,"description":"data for creating a new Trigger","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"string"},"description":{"type":"string"},"status":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"Trigger successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/triggers/{id}":{"get":{"summary":"Gets a single Trigger","security":[{"BearerAuth":[]}],"operationId":"getTriggerById","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger to get"}],"responses":{"200":{"description":"Trigger with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Trigger not found"}}},"put":{"summary":"Update an existing Trigger","security":[{"BearerAuth":[]}],"operationId":"updateTriggerById","tags":["Triggers"],"requestBody":{"required":true,"description":"data for updating a new Trigger","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"channel":{"type":"string"},"description":{"type":"string"},"status":{"type":"boolean","default":false}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Trigger not found"}}}},"/triggers/{id}/all_conditions":{"get":{"summary":"Gets \"AND\" Trigger Conditions","security":[{"BearerAuth":[]}],"operationId":"getAllConditions","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new \"AND\"condition","security":[{"BearerAuth":[]}],"operationId":"addAllCondition","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/triggers/{id}/any_conditions":{"get":{"summary":"Gets \"OR\" Trigger Conditions","security":[{"BearerAuth":[]}],"operationId":"getAnyConditions","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new \"OR\"condition","security":[{"BearerAuth":[]}],"operationId":"addAnyCondition","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/triggers/{id}/actions":{"get":{"summary":"Gets Trigger Actions","security":[{"BearerAuth":[]}],"operationId":"getActions","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new actions","security":[{"BearerAuth":[]}],"operationId":"addAction","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/triggers/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Trigger","security":[{"BearerAuth":[]}],"operationId":"deleteTriggerById","tags":["Triggers"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trigger to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Trigger not found"}}}},"/trunks":{"get":{"summary":"Gets a list of Trunks","security":[{"BearerAuth":[]}],"operationId":"listAllTrunk","tags":["Trunks"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Trunk"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Trunks","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trunk"}}}}},"206":{"description":"Partial (paged) collection of Trunks","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trunk"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/trunks/{id}":{"get":{"summary":"Gets a single Trunk","security":[{"BearerAuth":[]}],"operationId":"getTrunkById","tags":["Trunks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trunk to get"}],"responses":{"200":{"description":"Trunk with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trunk"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Trunk not found"}}},"put":{"summary":"Update an existing trunk","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Trunks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trunk"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Deletes a trunk","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Trunks"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Trunk"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/trunks/clone":{"post":{"summary":"Clone an existing Trunk","security":[{"BearerAuth":[]}],"operationId":"cloneTrunk","tags":["Trunks"],"requestBody":{"required":true,"description":"data for creating a new Trunk","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Trunk to clone"},"name":{"type":"string"},"type":{"type":"string","enum":["friend","user","peer"],"default":"friend"},"context":{"type":"string","default":"from-voip-provider"},"callingpres":{"type":"string","enum":["ALLOWED_NOT_SCREENED","ALLOWED_PASSED_SCREEN","ALLOWED_FAILED_SCREEN","ALLOWED","PROHIB_NOT_SCREENED","PROHIB_PASSED_SCREEN","PROHIB_FAILED_SCREEN","PROHIB"]},"deny":{"type":"string"},"permit":{"type":"string"},"secret":{"type":"string"},"md5secret":{"type":"string"},"remotesecret":{"type":"string"},"transport":{"type":"string","description":"String is deprecated. Please use an Array as [\"udp\", \"tcp\"]","default":"udp"},"dtmfmode":{"type":"string","enum":["rfc2833","info","shortinfo","inband","auto"],"default":"rfc2833"},"directmedia":{"type":"string","enum":["yes","no","nonat","update","outgoing"],"default":"no"},"directrtpsetup":{"type":"string","enum":["yes","no"],"default":"no"},"directmediapermit":{"type":"string"},"directmediadeny":{"type":"string"},"nat":{"type":"string","description":"String is deprecated. Please use an Array as [\"force_rport\", \"comedia\"]","default":"force_rport,comedia"},"callgroup":{"type":"string"},"namedcallgroup":{"type":"string"},"pickupgroup":{"type":"string"},"namedpickupgroup":{"type":"string"},"language":{"type":"string","default":"en"},"tonezone":{"type":"string"},"disallow":{"type":"string","default":"all"},"allow":{"type":"string","description":"String is deprecated. Please use an Array as [\"ulaw\", \"alaw\", \"alaw\"]","default":"ulaw;alaw;gsm"},"autoframing":{"type":"string","enum":["yes","no"]},"insecure":{"type":"string","description":"String is deprecated. Please use an Array as [\"port\", \"invite\"]","default":"port,invite"},"trustrpid":{"type":"string","enum":["yes","no"],"default":"no"},"trust_id_outbound":{"type":"string","enum":["yes","no"],"default":"no"},"progressinband":{"type":"string","enum":["yes","no","never"]},"promiscredir":{"type":"string","enum":["yes","no"]},"useclientcode":{"type":"string","enum":["yes","no"]},"accountcode":{"type":"integer"},"setvar":{"type":"string"},"callerid":{"type":"string","default":"\"\" <>"},"amaflags":{"type":"string"},"callcounter":{"type":"string","enum":["yes","no"],"default":"yes"},"busylevel":{"type":"integer"},"allowoverlap":{"type":"string","enum":["yes","no"]},"allowsubscribe":{"type":"string","enum":["yes","no"]},"allowtransfer":{"type":"string","enum":["yes","no"]},"ignoresdpversion":{"type":"string","enum":["yes","no"]},"subscribecontext":{"type":"string"},"template":{"type":"string"},"videosupport":{"type":"string","enum":["yes","no","always"],"default":"no"},"maxcallbitrate":{"type":"integer"},"rfc2833compensate":{"type":"string","enum":["yes","no"]},"mailbox":{"type":"string"},"session_timers":{"type":"string","enum":["accept","refuse","originate"]},"session_expires":{"type":"integer"},"session_minse":{"type":"integer"},"session_refresher":{"type":"string","enum":["uac","uas"],"default":"uas"},"t38pt_usertpsource":{"type":"string"},"regexten":{"type":"string"},"fromdomain":{"type":"string"},"fromuser":{"type":"string"},"port":{"type":"integer"},"qualify":{"type":"string","enum":["yes","no"],"default":"yes"},"keepalive":{"type":"integer"},"defaultip":{"type":"string"},"defaultuser":{"type":"string"},"rtptimeout":{"type":"integer"},"rtpholdtimeout":{"type":"integer"},"rtpkeepalive":{"type":"integer"},"sendrpid":{"type":"string","enum":["yes","no","pai"],"default":"no"},"outboundproxy":{"type":"string"},"callbackextension":{"type":"string"},"timert1":{"type":"integer"},"timerb":{"type":"integer"},"qualifyfreq":{"type":"integer"},"contactpermit":{"type":"string"},"contactdeny":{"type":"string"},"contactacl":{"type":"string"},"unsolicited_mailbox":{"type":"string"},"use_q850_reason":{"type":"string"},"maxforwards":{"type":"integer"},"encryption":{"type":"string","enum":["yes","no"],"default":"no"},"avpf":{"type":"string","enum":["yes","no"]},"force_avp":{"type":"string","enum":["yes","no"]},"icesupport":{"type":"string","enum":["yes","no"]},"dtlsenable":{"type":"string","enum":["yes","no"]},"dtlsverify":{"type":"string","enum":["yes","no","fingerprint","certificate"]},"dtlsrekey":{"type":"integer"},"dtlscertfile":{"type":"string"},"dtlsprivatekey":{"type":"string"},"dtlscipher":{"type":"string"},"dtlscafile":{"type":"string"},"dtlscapath":{"type":"string"},"dtlssetup":{"type":"string","enum":["active","passive","actpass"]},"dtlsfingerprint":{"type":"string"},"usereqphone":{"type":"string","enum":["yes","no"],"default":"no"},"recordonfeature":{"type":"string"},"recordofffeature":{"type":"string"},"call_limit":{"type":"integer","default":1000},"registertrying":{"type":"string","enum":["yes","no"]},"subscribemwi":{"type":"string","enum":["yes","no"]},"vmexten":{"type":"string"},"mohinterpret":{"type":"string"},"mohsuggest":{"type":"string"},"parkinglot":{"type":"string"},"description":{"type":"string"},"host":{"type":"string","default":"dynamic"},"canreinvite":{"type":"string","enum":["yes","no","nonat","update","update,nonat"],"default":"no"},"registry":{"type":"string"},"otherFields":{"type":"string"},"active":{"type":"boolean","default":true},"t38pt_udptl":{"type":"string","default":"no"}},"required":["id"]}}}},"responses":{"201":{"description":"Trunk successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trunk"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/trunks/":{"post":{"summary":"Create a new trunk","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Trunks"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users":{"get":{"summary":"Gets a list of Users","security":[{"BearerAuth":[]}],"operationId":"listUsers","tags":["Users"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each User"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Users","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"206":{"description":"Partial (paged) collection of Users","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Create a new User","security":[{"BearerAuth":[]}],"operationId":"postCreateUser","tags":["Users"],"requestBody":{"required":true,"description":"user to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"201":{"description":"user created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/describe":{"get":{"summary":"Gets table info about Users","security":[{"BearerAuth":[]}],"operationId":"describeUsers","tags":["Users"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/whoami":{"get":{"summary":"Gets current user","security":[{"BearerAuth":[]}],"operationId":"getWhoAmI","tags":["Users"],"responses":{"200":{"description":"current user information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}":{"get":{"summary":"Gets a user by id","security":[{"BearerAuth":[]}],"operationId":"getUserById","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user to get"}],"responses":{"200":{"description":"user information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"put":{"summary":"Update an existing User","security":[{"BearerAuth":[]}],"operationId":"putUpdateUser","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"user properties to be updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"description":"user updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove a user","security":[{"BearerAuth":[]}],"operationId":"deleteUser","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"204":{"description":"user deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"user not found"}}}},"/users/{id}/avatar":{"get":{"summary":"Gets a user avatar by id","security":[{"BearerAuth":[]}],"operationId":"getUserAvatarById","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user avatar","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add avatar","security":[{"BearerAuth":[]}],"operationId":"postAddAvatar","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"Add avatar","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"avatar added"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/contacts":{"get":{"summary":"Gets a user contacts by id","security":[{"BearerAuth":[]}],"operationId":"getUserContactsById","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user contacts list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user contacts list","type":"array","items":{"$ref":"#/components/schemas/CmContact"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add contacts to a user","security":[{"BearerAuth":[]}],"operationId":"postAddUserContact","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"user contacts to be added","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"contacts added"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/queues":{"get":{"summary":"Gets a user queues list by user id","security":[{"BearerAuth":[]}],"operationId":"getUserQueues","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"channel","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string","enum":["voice","mail","chat","fax","sms","whatsapp","openchannel"]},"description":"channel to filter for (e.g. mail, voice...)","examples":{"fields":{"value":"mail","summary":"A call returning only queues for channel = mail"}}}],"responses":{"200":{"description":"user queues list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user queues list","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/VoiceQueue"},{"$ref":"#/components/schemas/MailQueue"},{"$ref":"#/components/schemas/ChatQueue"},{"$ref":"#/components/schemas/FaxQueue"},{"$ref":"#/components/schemas/SmsQueue"},{"$ref":"#/components/schemas/OpenchannelQueue"},{"$ref":"#/components/schemas/WhatsappQueue"}]}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add queues to an agent","security":[{"BearerAuth":[]}],"operationId":"postAddQueuesToAgent","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"Add queues to an agent","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"queues added"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove one or more queues from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserQueues","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the voice queues to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove voice queues with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"queues deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/queues_rt":{"get":{"summary":"Gets a user UserVoiceQueuesRt list by user id","security":[{"BearerAuth":[]}],"operationId":"getUserVoiceQueuesRt","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user UserVoiceQueuesRt list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user UserVoiceQueueRt list","type":"array","items":{"$ref":"#/components/schemas/UserVoiceQueueRt"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/groups":{"get":{"summary":"Gets a user ChatGroups list by user id","security":[{"BearerAuth":[]}],"operationId":"getChatGroups","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user ChatGroups list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user ChatGroups list","type":"array","items":{"$ref":"#/components/schemas/ChatGroup"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/recordings":{"get":{"summary":"Gets a user VoiceRecording list by user id","security":[{"BearerAuth":[]}],"operationId":"getVoiceRecordings","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user VoiceRecording list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user VoiceRecording list","type":"array","items":{"$ref":"#/components/schemas/VoiceRecording"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/screen_recordings":{"get":{"summary":"Gets a user ScreenRecording list by user id","security":[{"BearerAuth":[]}],"operationId":"getScreenRecordings","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user ScreenRecording list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user ScreenRecording list","type":"array","items":{"$ref":"#/components/schemas/ScreenRecording"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/chat/interactions":{"get":{"summary":"Gets a user ChatInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getChatInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user ChatInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user ChatInteraction list","type":"array","items":{"$ref":"#/components/schemas/ChatInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/openchannel/interactions":{"get":{"summary":"Gets a user OpenchannelInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user OpenchannelInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user OpenchannelInteraction list","type":"array","items":{"$ref":"#/components/schemas/OpenchannelInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/mail/interactions":{"get":{"summary":"Gets a user MailInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getMailInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user MailInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user MailInteraction list","type":"array","items":{"$ref":"#/components/schemas/MailInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/sms/interactions":{"get":{"summary":"Gets a user SmsInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getSmsInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user SmsInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user SmsInteraction list","type":"array","items":{"$ref":"#/components/schemas/SmsInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/fax/interactions":{"get":{"summary":"Gets a user FaxInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getFaxInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user FaxInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user FaxInteraction list","type":"array","items":{"$ref":"#/components/schemas/FaxInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/whatsapp/interactions":{"get":{"summary":"Gets a user WhatsappInteraction list by user id","security":[{"BearerAuth":[]}],"operationId":"getWhatsappInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user WhatsappInteraction list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user WhatsappInteraction list","type":"array","items":{"$ref":"#/components/schemas/WhatsappInteraction"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/teams":{"get":{"summary":"Gets a user Teams list by user id","security":[{"BearerAuth":[]}],"operationId":"getTeamss","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user Teams list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user Teams list","type":"array","items":{"$ref":"#/components/schemas/Team"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to an agent","security":[{"BearerAuth":[]}],"operationId":"postPause","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"teams to be added","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"responses":{"201":{"description":"teams added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove one or more teams from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserTeams","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the teams to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove teams with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"teams deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/lists":{"get":{"summary":"Gets a user CmList list by user id","security":[{"BearerAuth":[]}],"operationId":"getCmLists","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user CmList list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user CmList list","type":"array","items":{"$ref":"#/components/schemas/CmList"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/agents":{"get":{"summary":"Gets a user Agents list by user id","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user Agents list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user Agents list","type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/prefixes":{"get":{"summary":"Gets a user VoicePrefix list by user id","security":[{"BearerAuth":[]}],"operationId":"getVoicePrefixes","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user VoicePrefix list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user VoicePrefix list","type":"array","items":{"$ref":"#/components/schemas/VoicePrefix"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/fax_accounts":{"get":{"summary":"Gets a user FaxAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getFaxAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user FaxAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user FaxAccount list","type":"array","items":{"$ref":"#/components/schemas/FaxAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a Fax Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserFaxAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"fax accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"fax accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"fax accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove fax accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserFaxAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the fax accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove fax accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"fax accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/mail_accounts":{"get":{"summary":"Gets a user MailAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getMailAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user MailAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user MailAccount list","type":"array","items":{"$ref":"#/components/schemas/MailAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a mail Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserMailAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"mail accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"mail accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"mail accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove mail accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserMailAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the mail accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove mail accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"mail accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/openchannel_accounts":{"get":{"summary":"Gets a user OpenchannelAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getOpenchannelAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user OpenchannelAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user OpenchannelAccount list","type":"array","items":{"$ref":"#/components/schemas/OpenchannelAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a openchannel Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserOpenchannelAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"openchannel accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"openchannel accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"openchannel accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove openchannel accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserOpenchannelAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the openchannel accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove openchannel accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"openchannel accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/sms_accounts":{"get":{"summary":"Gets a user SmsAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getSmsAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user SmsAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user SmsAccount list","type":"array","items":{"$ref":"#/components/schemas/SmsAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a sms Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserSmsAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"sms accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"sms accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"sms accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove sms accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserSmsAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the sms accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove sms accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"sms accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/chat_websites":{"get":{"summary":"Gets a user ChatWebsite list by user id","security":[{"BearerAuth":[]}],"operationId":"getChatWebsites","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user ChatWebsite list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user ChatWebsite list","type":"array","items":{"$ref":"#/components/schemas/ChatWebsite"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a Chat Website to a user","security":[{"BearerAuth":[]}],"operationId":"postUserChatWebsites","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"chat websites to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"chat websites identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"chat websites added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove chat websites from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserChatWebsites","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the chat websites to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove chat websites with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"chat websites deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/whatsapp_accounts":{"get":{"summary":"Gets a user WhatsappAccount list by user id","security":[{"BearerAuth":[]}],"operationId":"getWhatsappAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user WhatsappAccount list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user WhatsappAccount list","type":"array","items":{"$ref":"#/components/schemas/WhatsappAccount"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a whatsapp Account to a user","security":[{"BearerAuth":[]}],"operationId":"postUserWhatsappAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"whatsapp accounts to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"whatsapp accounts identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"whatsapp accounts added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove whatsapp accounts from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserWhatsappAccounts","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the whatsapp accounts to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove whatsapp accounts with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"whatsapp accounts deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/square_projects":{"get":{"summary":"Gets a user SquareProject list by user id","security":[{"BearerAuth":[]}],"operationId":"getSquareProjects","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user SquareProject list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user SquareProject list","type":"array","items":{"$ref":"#/components/schemas/SquareProject"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add a Square Project to a user","security":[{"BearerAuth":[]}],"operationId":"postUserSquareProject","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"square project to be added","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"square project identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"square project added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove one or more Square Project from a user","security":[{"BearerAuth":[]}],"operationId":"deleteSquareProjects","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the square project to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove square project with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"square project deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/scheduled_calls":{"get":{"summary":"Gets a user scheduled calls list by user id","security":[{"BearerAuth":[]}],"operationId":"getScheduledCalls","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user scheduled calls list result","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"results count","default":0},"rows":{"description":"user scheduled calls list","type":"array","items":{"type":"object"}}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/api_key":{"get":{"summary":"Gets a user api key by user id","security":[{"BearerAuth":[]}],"operationId":"getApiKey","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"200":{"description":"user api keys list result","content":{"application/json":{"schema":{"type":"object","properties":{"api_key":{"type":"string","description":"api key token"}}}}}},"204":{"description":"No API access key found!","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"error message","default":"No API access key found!"}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Create a new API access key for the user","security":[{"BearerAuth":[]}],"operationId":"postCreateApiKey","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"tags":["Users"],"responses":{"201":{"description":"the api key that has been created","content":{"application/json":{"schema":{"type":"object","properties":{"api_key":{"type":"string","description":"api key token"}}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove API access key for the user","security":[{"BearerAuth":[]}],"operationId":"deleteUserApiKey","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"204":{"description":"user apikey deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"user not found"}}}},"/users/create_many":{"post":{"summary":"Create several Users","security":[{"BearerAuth":[]}],"operationId":"postCreateUsers","tags":["Users"],"requestBody":{"required":true,"description":"users to be created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"responses":{"201":{"description":"users created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/login":{"post":{"summary":"perform SIP Login","security":[{"BearerAuth":[]}],"operationId":"postSipLogin","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"Login","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"SIP Login success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/logout":{"post":{"summary":"perform SIP logout","security":[{"BearerAuth":[]}],"operationId":"postSipLogout","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"responses":{"201":{"description":"SIP logout success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/pause":{"post":{"summary":"set pause status","security":[{"BearerAuth":[]}],"operationId":"postPause","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"pause payload","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"status updated successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/unpause":{"post":{"summary":"unset pause status","security":[{"BearerAuth":[]}],"operationId":"postUnpause","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"unpause payload","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"status updated successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/users/{id}/chat_interactions":{"post":{"summary":"Add chat interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserChatInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"chat interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"chat interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"chat interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove chat interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserChatInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the chat interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove chat interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"chat interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/mail_interactions":{"post":{"summary":"Add mail interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserMailInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"mail interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"mail interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"mail interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove mail interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserMailInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the mail interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove mail interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"mail interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/fax_interactions":{"post":{"summary":"Add fax interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserFaxInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"fax interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"fax interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"fax interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove fax interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserFaxInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the fax interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove fax interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"fax interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/sms_interactions":{"post":{"summary":"Add sms interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserSmsInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"sms interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"sms interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"sms interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove sms_interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserSmsInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the sms interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove sms interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"sms interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/openchannel_interactions":{"post":{"summary":"Add openchannel interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserOpenchannelInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"openchannel interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"openchannel interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"openchannel interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove openchannel interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserOpenchannelInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the openchannel interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove openchannel interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"openchannel interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/whatsapp_interactions":{"post":{"summary":"Add whatsapp interaction tabs to an agent","security":[{"BearerAuth":[]}],"operationId":"postUserWhatsappInteraction","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"whatsapp interaction tabs","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"whatsapp interactions identifiers","type":"array","items":{"type":"integer"}}},"required":["ids"]}}}},"responses":{"201":{"description":"whatsapp interaction tabs added successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove whatsapp_interactions from an agent","security":[{"BearerAuth":[]}],"operationId":"deleteUserWhatsappInteractions","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"},{"in":"query","name":"ids","allowReserved":true,"style":"form","explode":true,"schema":{"type":"string"},"description":"ids of the whatsapp interactions to be removed","examples":{"fields":{"value":"1,2,3","summary":"remove whatsapp interactions with ids=1, ids=2 and ids=3"}}}],"responses":{"204":{"description":"whatsapp interactions deleted successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"one or more records not found"}}}},"/users/{id}/password":{"put":{"summary":"Update an existing User","security":[{"BearerAuth":[]}],"operationId":"putUpdateUser","tags":["Users"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the user"}],"requestBody":{"required":true,"description":"old password and new password","content":{"application/json":{"schema":{"type":"object","properties":{"oldPassword":{"type":"string","format":"password","description":"old password"},"newPassword":{"type":"string","format":"password","description":"new password"}},"required":["oldPassword","newPassword"]}}}},"responses":{"200":{"description":"user password updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles":{"get":{"summary":"Gets a list of User Profiles","security":[{"BearerAuth":[]}],"operationId":"listAllUserProfile","tags":["User Profiles"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each UserProfile"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of User Profiles","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfile"}}}}},"206":{"description":"Partial (paged) collection of User Profiles","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfile"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new User Profile","security":[{"BearerAuth":[]}],"operationId":"createUserProfile","tags":["User Profiles"],"requestBody":{"required":true,"description":"data for creating a new User Profile","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"crudPermissions":{"type":"string","default":"r"},"description":{"type":"string"}},"required":["name","crudPermissions"]}}}},"responses":{"201":{"description":"UserProfile successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/describe":{"get":{"summary":"Gets table info about User Profiles","security":[{"BearerAuth":[]}],"operationId":"describeUserProfile","tags":["User Profiles"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/{id}":{"get":{"summary":"Gets a single User Profile","security":[{"BearerAuth":[]}],"operationId":"getUserProfileById","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile to get"}],"responses":{"200":{"description":"UserProfile with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfile not found"}}},"put":{"summary":"Update an existing User Profile","security":[{"BearerAuth":[]}],"operationId":"updateUserProfileById","tags":["User Profiles"],"requestBody":{"required":true,"description":"data for updating a new User Profile","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"crudPermissions":{"type":"string","default":"r"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfile not found"}}}},"/userProfiles/{id}/sections":{"get":{"summary":"Get sections associated to a User Profile","security":[{"BearerAuth":[]}],"operationId":"getSections","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add sections' permissions to User Profile","security":[{"BearerAuth":[]}],"operationId":"addSections","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes sections' permissions from User Profile","security":[{"BearerAuth":[]}],"operationId":"removeSections","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/{id}/resources":{"get":{"summary":"Get Resources assigned to a Section","security":[{"BearerAuth":[]}],"operationId":"getResources","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add resources' permissions to User Profile","security":[{"BearerAuth":[]}],"operationId":"addResources","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes resources' permissions from User Profile","security":[{"BearerAuth":[]}],"operationId":"removeResources","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/clone":{"post":{"summary":"Clone an existing User Profile","security":[{"BearerAuth":[]}],"operationId":"cloneUserProfile","tags":["User Profiles"],"requestBody":{"required":true,"description":"data for creating a new User Profile","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the User Profile to clone"},"name":{"type":"string"},"crudPermissions":{"type":"string","default":"r"},"description":{"type":"string"}},"required":["id"]}}}},"responses":{"201":{"description":"UserProfile successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfiles/{id}/destroy_many":{"delete":{"summary":"Destroy an existing User Profile","security":[{"BearerAuth":[]}],"operationId":"deleteUserProfileById","tags":["User Profiles"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfile to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfile not found"}}}},"/userProfile/resources":{"get":{"summary":"Gets a list of User Profile Resources","security":[{"BearerAuth":[]}],"operationId":"listAllUserProfileResource","tags":["User Profile Resources"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each UserProfileResource"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of User Profile Resources","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileResource"}}}}},"206":{"description":"Partial (paged) collection of User Profile Resources","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileResource"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new User Profile Resource","security":[{"BearerAuth":[]}],"operationId":"createUserProfileResource","tags":["User Profile Resources"],"requestBody":{"required":true,"description":"data for creating a new User Profile Resource","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"resourceId":{"type":"integer"},"type":{"type":"string"}},"required":["name","resourceId","type"]}}}},"responses":{"201":{"description":"UserProfileResource successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileResource"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfile/resources/describe":{"get":{"summary":"Gets table info about User Profile Resources","security":[{"BearerAuth":[]}],"operationId":"describeUserProfileResource","tags":["User Profile Resources"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfile/resources/{id}":{"get":{"summary":"Gets a single User Profile Resource","security":[{"BearerAuth":[]}],"operationId":"getUserProfileResourceById","tags":["User Profile Resources"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileResource to get"}],"responses":{"200":{"description":"UserProfileResource with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileResource"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileResource not found"}}},"put":{"summary":"Update an existing User Profile Resource","security":[{"BearerAuth":[]}],"operationId":"updateUserProfileResourceById","tags":["User Profile Resources"],"requestBody":{"required":true,"description":"data for updating a new User Profile Resource","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"resourceId":{"type":"integer"},"type":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileResource to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileResource not found"}}}},"/userProfile/resources/{id}/destroy_many":{"delete":{"summary":"Destroy an existing User Profile Resource","security":[{"BearerAuth":[]}],"operationId":"deleteUserProfileResourceById","tags":["User Profile Resources"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileResource to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileResource not found"}}}},"/userProfile/sections":{"get":{"summary":"Gets a list of User Profile Sections","security":[{"BearerAuth":[]}],"operationId":"listAllUserProfileSection","tags":["User Profile Sections"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each UserProfileSection"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of User Profile Sections","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileSection"}}}}},"206":{"description":"Partial (paged) collection of User Profile Sections","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileSection"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new User Profile Section","security":[{"BearerAuth":[]}],"operationId":"createUserProfileSection","tags":["User Profile Sections"],"requestBody":{"required":true,"description":"data for creating a new User Profile Section","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"sectionId":{"type":"integer"},"enabled":{"type":"boolean","default":null},"autoAssociation":{"type":"boolean","default":null},"crudPermissions":{"type":"string"}},"required":["name","category","sectionId"]}}}},"responses":{"201":{"description":"UserProfileSection successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileSection"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfile/sections/describe":{"get":{"summary":"Gets table info about User Profile Sections","security":[{"BearerAuth":[]}],"operationId":"describeUserProfileSection","tags":["User Profile Sections"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/userProfile/sections/{id}":{"get":{"summary":"Gets a single User Profile Section","security":[{"BearerAuth":[]}],"operationId":"getUserProfileSectionById","tags":["User Profile Sections"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileSection to get"}],"responses":{"200":{"description":"UserProfileSection with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileSection"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileSection not found"}}},"put":{"summary":"Update an existing User Profile Section","security":[{"BearerAuth":[]}],"operationId":"updateUserProfileSectionById","tags":["User Profile Sections"],"requestBody":{"required":true,"description":"data for updating a new User Profile Section","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"sectionId":{"type":"integer"},"enabled":{"type":"boolean","default":null},"autoAssociation":{"type":"boolean","default":null},"crudPermissions":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileSection to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileSection not found"}}}},"/userProfile/sections/{id}/destroy_many":{"delete":{"summary":"Destroy an existing User Profile Section","security":[{"BearerAuth":[]}],"operationId":"deleteUserProfileSectionById","tags":["User Profile Sections"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the UserProfileSection to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"UserProfileSection not found"}}}},"/variables":{"get":{"summary":"Gets a list of Variables","security":[{"BearerAuth":[]}],"operationId":"listAllVariable","tags":["Variables"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each Variable"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Variables","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}}}}},"206":{"description":"Partial (paged) collection of Variables","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Variable","security":[{"BearerAuth":[]}],"operationId":"createVariable","tags":["Variables"],"requestBody":{"required":true,"description":"data for creating a new Variable","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name"]}}}},"responses":{"201":{"description":"Variable successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variable"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/variables/{id}":{"get":{"summary":"Gets a single Variable","security":[{"BearerAuth":[]}],"operationId":"getVariableById","tags":["Variables"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Variable to get"}],"responses":{"200":{"description":"Variable with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variable"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Variable not found"}}},"put":{"summary":"Update an existing Variable","security":[{"BearerAuth":[]}],"operationId":"updateVariableById","tags":["Variables"],"requestBody":{"required":true,"description":"data for updating a new Variable","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Variable to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Variable not found"}}}},"/variables/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Variable","security":[{"BearerAuth":[]}],"operationId":"deleteVariableById","tags":["Variables"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the Variable to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"Variable not found"}}}},"/version":{"get":{"summary":"Gets version","operationId":"getVersion","tags":["Version"],"responses":{"200":{"description":"full server version infomation","content":{"application/json":{"schema":{"type":"object","properties":{"current":{"type":"string","description":"current product version (semver)"},"phonebar":{"type":"string","description":"current phonebar version (semver)"},"shortHash":{"type":"string","description":"latest server git sha hash"},"branch":{"type":"string","description":"server git branch"},"tag":{"type":"string","description":"server git tag (s)"},"committedOn":{"type":"string","format":"date","description":"last commit date"},"buildDate":{"type":"string","format":"date","description":"buildDate date"}},"required":["current","phonebar","shortHash","branch","tag","committedOn","buildDate"]}}}}}}},"/version/fetch":{"get":{"summary":"Fetch git version","security":[{"BearerAuth":[]}],"operationId":"fetchVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","default":"git fetch origin master","description":"current output"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/version/reset":{"get":{"summary":"Reset git version","security":[{"BearerAuth":[]}],"operationId":"resetVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","default":"git reset --hard","description":"current output"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/version/pull":{"get":{"summary":"Pull git version","security":[{"BearerAuth":[]}],"operationId":"pullVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","description":"current output"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/version/restart":{"get":{"summary":"Restart motion2 after update","security":[{"BearerAuth":[]}],"operationId":"restartVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","default":"Your system has been restarted successfully","description":"current output"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/version/migrations":{"get":{"summary":"Launch database migrations","security":[{"BearerAuth":[]}],"operationId":"migrateVersion","tags":["Version"],"responses":{"200":{"description":"operation successfull","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","default":"Database already up-to-date","description":"current output"},"migrations":{"type":"array","items":{"type":"string"},"description":"migrations that have been executed (version numbers)"}},"required":["output"]}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/agents/reports":{"get":{"summary":"Gets a list of Agent Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceAgentReport","tags":["Voice Agent Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceAgentReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Agent Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceAgentReport"}}}}},"206":{"description":"Partial (paged) collection of Agent Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceAgentReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/agents/reports/describe":{"get":{"summary":"Gets table info about Agent Reports","security":[{"BearerAuth":[]}],"operationId":"describeVoiceAgentReport","tags":["Voice Agent Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/agents/reports/{id}":{"get":{"summary":"Gets a single Agent Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceAgentReportById","tags":["Voice Agent Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceAgentReport to get"}],"responses":{"200":{"description":"VoiceAgentReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceAgentReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceAgentReport not found"}}}},"/voice/calls/reports":{"get":{"summary":"Gets a list of Call Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceCallReport","tags":["Voice Call Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceCallReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Call Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceCallReport"}}}}},"206":{"description":"Partial (paged) collection of Call Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceCallReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/calls/reports/describe":{"get":{"summary":"Gets table info about Call Reports","security":[{"BearerAuth":[]}],"operationId":"describeVoiceCallReport","tags":["Voice Call Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/calls/reports/{id}":{"get":{"summary":"Gets a single Call Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceCallReportById","tags":["Voice Call Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceCallReport to get"}],"responses":{"200":{"description":"VoiceCallReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceCallReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceCallReport not found"}}},"put":{"summary":"Update a single cdr","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Voice Call Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceCallReport"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/chanspy":{"get":{"summary":"Gets a list of Voice ChanSpy","security":[{"BearerAuth":[]}],"operationId":"listVoiceChanSpy","tags":["Voice ChanSpy"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each voice chanspy"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Voice ChanSpy","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceChanSpy"}}}}},"206":{"description":"Partial (paged) collection of Voice ChanSpy","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceChanSpy"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/chanspy/{id}":{"get":{"summary":"Get a ChanSpy by Id","security":[{"BearerAuth":[]}],"operationId":"getChanSpyById","tags":["Voice ChanSpy"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChanSpy"}],"responses":{"200":{"description":"the desired chanspy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceChanSpy"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"chanspy not found"}}},"post":{"summary":"create a ChanSpy","security":[{"BearerAuth":[]}],"operationId":"createChanSpy","tags":["Voice ChanSpy"],"requestBody":{"required":true,"description":"chanspy data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"chanspy name"},"prefix":{"type":"string","description":"chanspy prefix"},"options":{"type":"string","description":"chanspy preoptionsfix"},"auth":{"type":"boolean","description":"chanspy auth"},"password":{"type":"string","format":"password","description":"chanspy password"},"record":{"type":"boolean","description":"chanspy record"},"recordingFormat":{"type":"string","description":"chanspy recordingFormat"},"description":{"type":"string","description":"chanspy description"}},"required":["prefix"]}}}},"responses":{"201":{"description":"successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceChanSpy"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"chanspy not found"}}},"put":{"summary":"Update a ChanSpy","security":[{"BearerAuth":[]}],"operationId":"updateChanSpyById","tags":["Voice ChanSpy"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChanSpy"}],"requestBody":{"required":true,"description":"chanspy data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"chanspy name"},"prefix":{"type":"string","description":"chanspy prefix"},"options":{"type":"string","description":"chanspy preoptionsfix"},"auth":{"type":"boolean","description":"chanspy auth"},"password":{"type":"string","format":"password","description":"chanspy password"},"record":{"type":"boolean","description":"chanspy record"},"recordingFormat":{"type":"string","description":"chanspy recordingFormat"},"description":{"type":"string","description":"chanspy description"}},"required":["prefix"]}}}},"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"chanspy not found"}}},"delete":{"summary":"Delete a ChanSpy","security":[{"BearerAuth":[]}],"operationId":"deleteChanSpyById","tags":["Voice ChanSpy"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the ChanSpy"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"chanspy not found"}}}},"/voice/contexts":{"get":{"summary":"Gets a list of Contexts","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceContext","tags":["Voice Contexts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceContext"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Contexts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceContext"}}}}},"206":{"description":"Partial (paged) collection of Contexts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceContext"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/contexts/{id}":{"get":{"summary":"Gets a single Context","security":[{"BearerAuth":[]}],"operationId":"getVoiceContextById","tags":["Voice Contexts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceContext to get"}],"responses":{"200":{"description":"VoiceContext with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceContext"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceContext not found"}}},"put":{"summary":"Update an existing context","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Voice Contexts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceContext"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Deletes a context","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Voice Contexts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceContext"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/contexts/":{"post":{"summary":"Create a new context","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Voice Contexts"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/dials/reports":{"get":{"summary":"Gets a list of Dial Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceDialReport","tags":["Voice Dial Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceDialReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Dial Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceDialReport"}}}}},"206":{"description":"Partial (paged) collection of Dial Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceDialReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/dials/reports/describe":{"get":{"summary":"Gets table info about Dial Reports","security":[{"BearerAuth":[]}],"operationId":"describeVoiceDialReport","tags":["Voice Dial Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/dials/reports/{id}":{"get":{"summary":"Gets a single Dial Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceDialReportById","tags":["Voice Dial Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceDialReport to get"}],"responses":{"200":{"description":"VoiceDialReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceDialReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceDialReport not found"}}}},"/voice/extensions":{"get":{"summary":"Gets a list of Extensions","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceExtension","tags":["Voice Extensions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceExtension"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Extensions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceExtension"}}}}},"206":{"description":"Partial (paged) collection of Extensions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceExtension"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/extensions/{id}":{"get":{"summary":"Gets a single Extension","security":[{"BearerAuth":[]}],"operationId":"getVoiceExtensionById","tags":["Voice Extensions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceExtension to get"}],"responses":{"200":{"description":"VoiceExtension with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceExtension"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceExtension not found"}}},"put":{"summary":"Update an extension","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Voice Extensions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceExtension"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/extensions/":{"post":{"summary":"Create an extension","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Voice Extensions"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/extensions/{id}/applications":{"post":{"summary":"Create new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Voice Extensions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceExtension"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/extensions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Extension","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceExtensionById","tags":["Voice Extensions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceExtension to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceExtension not found"}}}},"/voice/mails":{"get":{"summary":"Gets a list of Mails","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceMail","tags":["Voice Mails"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceMail"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Mails","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMail"}}}}},"206":{"description":"Partial (paged) collection of Mails","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMail"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Mail","security":[{"BearerAuth":[]}],"operationId":"createVoiceMail","tags":["Voice Mails"],"requestBody":{"required":true,"description":"data for creating a new Mail","content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string"},"context":{"type":"string","default":"from-voicemail"},"mailbox":{"type":"string","default":""},"password":{"type":"string"},"fullname":{"type":"string"},"email":{"type":"string"},"pager":{"type":"string"},"tz":{"type":"string","default":"central"},"attach":{"type":"string","enum":["yes","no"],"default":"yes"},"saycid":{"type":"string","enum":["yes","no"],"default":"yes"},"dialout":{"type":"string"},"callback":{"type":"string"},"review":{"type":"string","enum":["yes","no"],"default":"no"},"operator":{"type":"string","enum":["yes","no"],"default":"no"},"envelope":{"type":"string","enum":["yes","no"],"default":"no"},"sayduration":{"type":"string","enum":["yes","no"],"default":"no"},"saydurationm":{"type":"string","default":1},"sendvoicemail":{"type":"string","enum":["yes","no"],"default":"no"},"delete":{"type":"string","enum":["yes","no"],"default":"no"},"nextaftercmd":{"type":"string","enum":["yes","no"],"default":"yes"},"forcename":{"type":"string","enum":["yes","no"],"default":"no"},"forcegreetings":{"type":"string","enum":["yes","no"],"default":"no"},"hidefromdir":{"type":"string","enum":["yes","no"],"default":"yes"},"stamp":{"type":"string"},"emailsubject":{"type":"string"},"emailbody":{"type":"string"},"maxsecs":{"type":"integer","default":180},"maxmsg":{"type":"integer","default":100},"name":{"type":"string"}},"required":["mailbox","attach","saycid","review","operator","envelope","sayduration","saydurationm","sendvoicemail","delete","nextaftercmd","forcename","forcegreetings","hidefromdir","maxsecs","maxmsg"]}}}},"responses":{"201":{"description":"VoiceMail successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMail"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mails/{id}":{"get":{"summary":"Gets a single Mail","security":[{"BearerAuth":[]}],"operationId":"getVoiceMailById","tags":["Voice Mails"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMail to get"}],"responses":{"200":{"description":"VoiceMail with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMail"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMail not found"}}},"put":{"summary":"Update an existing Mail","security":[{"BearerAuth":[]}],"operationId":"updateVoiceMailById","tags":["Voice Mails"],"requestBody":{"required":true,"description":"data for updating a new Mail","content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string"},"context":{"type":"string","default":"from-voicemail"},"mailbox":{"type":"string","default":""},"password":{"type":"string"},"fullname":{"type":"string"},"email":{"type":"string"},"pager":{"type":"string"},"tz":{"type":"string","default":"central"},"attach":{"type":"string","enum":["yes","no"],"default":"yes"},"saycid":{"type":"string","enum":["yes","no"],"default":"yes"},"dialout":{"type":"string"},"callback":{"type":"string"},"review":{"type":"string","enum":["yes","no"],"default":"no"},"operator":{"type":"string","enum":["yes","no"],"default":"no"},"envelope":{"type":"string","enum":["yes","no"],"default":"no"},"sayduration":{"type":"string","enum":["yes","no"],"default":"no"},"saydurationm":{"type":"string","default":1},"sendvoicemail":{"type":"string","enum":["yes","no"],"default":"no"},"delete":{"type":"string","enum":["yes","no"],"default":"no"},"nextaftercmd":{"type":"string","enum":["yes","no"],"default":"yes"},"forcename":{"type":"string","enum":["yes","no"],"default":"no"},"forcegreetings":{"type":"string","enum":["yes","no"],"default":"no"},"hidefromdir":{"type":"string","enum":["yes","no"],"default":"yes"},"stamp":{"type":"string"},"emailsubject":{"type":"string"},"emailbody":{"type":"string"},"maxsecs":{"type":"integer","default":180},"maxmsg":{"type":"integer","default":100},"name":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMail to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMail not found"}}}},"/voice/mails/{id}/messages":{"get":{"summary":"Gets voice mail messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Voice Mails"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMail"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mails/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Mail","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceMailById","tags":["Voice Mails"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMail to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMail not found"}}}},"/voice/mails/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceMailMessage","tags":["Voice Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceMailMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMailMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMailMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createVoiceMailMessage","tags":["Voice Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"msgnum":{"type":"integer","default":0},"dir":{"type":"string","default":""},"context":{"type":"string","default":""},"macrocontext":{"type":"string","default":""},"callerid":{"type":"string","default":""},"origtime":{"type":"string","default":""},"duration":{"type":"string","default":""},"mailboxuser":{"type":"string","default":""},"mailboxcontext":{"type":"string","default":""},"recording":{"type":"object","default":null},"flag":{"type":"string","default":""},"msg_id":{"type":"string","default":""},"stamp":{"type":"string"}},"required":["msgnum","stamp"]}}}},"responses":{"201":{"description":"VoiceMailMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMailMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mails/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getVoiceMailMessageById","tags":["Voice Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMailMessage to get"}],"responses":{"200":{"description":"VoiceMailMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMailMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMailMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateVoiceMailMessageById","tags":["Voice Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"msgnum":{"type":"integer","default":0},"dir":{"type":"string","default":""},"context":{"type":"string","default":""},"macrocontext":{"type":"string","default":""},"callerid":{"type":"string","default":""},"origtime":{"type":"string","default":""},"duration":{"type":"string","default":""},"mailboxuser":{"type":"string","default":""},"mailboxcontext":{"type":"string","default":""},"recording":{"type":"object","default":null},"flag":{"type":"string","default":""},"msg_id":{"type":"string","default":""},"stamp":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMailMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMailMessage not found"}}}},"/voice/mails/messages/{id}/download":{"get":{"summary":"Download Voice Message","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Voice Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMailMessage"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mails/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceMailMessageById","tags":["Voice Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMailMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMailMessage not found"}}}},"/voice/mohs":{"get":{"summary":"Gets a list of Music On Holds","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceMusicOnHold","tags":["Voice MOHs"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceMusicOnHold"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Music On Holds","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMusicOnHold"}}}}},"206":{"description":"Partial (paged) collection of Music On Holds","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMusicOnHold"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mohs/{id}":{"get":{"summary":"Gets a single Music On Hold","security":[{"BearerAuth":[]}],"operationId":"getVoiceMusicOnHoldById","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold to get"}],"responses":{"200":{"description":"VoiceMusicOnHold with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMusicOnHold"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMusicOnHold not found"}}},"put":{"summary":"Update an existing Music On Hold","security":[{"BearerAuth":[]}],"operationId":"updateVoiceMusicOnHoldById","tags":["Voice MOHs"],"requestBody":{"required":true,"description":"data for updating a new Music On Hold","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"mode":{"type":"string","enum":["custom","files","mp3nb","quietmp3nb","quietmp3","mp3"],"default":"files"},"directory":{"type":"string"},"application":{"type":"string"},"digit":{"type":"string"},"sort":{"type":"string","default":"alpha"},"format":{"type":"string"},"stamp":{"type":"string"},"defaultEntry":{"type":"boolean","default":0}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceMusicOnHold not found"}}},"delete":{"summary":"Deletes an MOH","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mohs/{id}/sounds":{"get":{"summary":"Gets sounds from MOH","security":[{"BearerAuth":[]}],"operationId":"getSounds","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add sound to MOH","security":[{"BearerAuth":[]}],"operationId":"addSound","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mohs/":{"post":{"summary":"Create a new a new MOH","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Voice MOHs"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/mohs/{id}/sounds/:id2":{"delete":{"summary":"Remove sound from MOH","security":[{"BearerAuth":[]}],"operationId":"removeSound","tags":["Voice MOHs"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceMusicOnHold"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes":{"get":{"summary":"Gets a list of Prefixes","security":[{"BearerAuth":[]}],"operationId":"listAllVoicePrefix","tags":["Voice Prefixes"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoicePrefix"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Prefixes","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoicePrefix"}}}}},"206":{"description":"Partial (paged) collection of Prefixes","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoicePrefix"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/describe":{"get":{"summary":"Gets table info about Prefixes","security":[{"BearerAuth":[]}],"operationId":"describeVoicePrefix","tags":["Voice Prefixes"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/{id}":{"get":{"summary":"Gets a single Prefix","security":[{"BearerAuth":[]}],"operationId":"getVoicePrefixById","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix to get"}],"responses":{"200":{"description":"VoicePrefix with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoicePrefix"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoicePrefix not found"}}},"put":{"summary":"Update an existing prefix","security":[{"BearerAuth":[]}],"operationId":"update","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/{id}/users":{"get":{"summary":"Gets agents from prefix","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a prefix","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a prefix","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/":{"post":{"summary":"Create a prefix","security":[{"BearerAuth":[]}],"operationId":"create","tags":["Voice Prefixes"],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/prefixes/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Prefix","security":[{"BearerAuth":[]}],"operationId":"deleteVoicePrefixById","tags":["Voice Prefixes"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoicePrefix to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoicePrefix not found"}}}},"/voice/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceQueue","tags":["Voice Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createVoiceQueue","tags":["Voice Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["inbound","outbound"],"default":"inbound"},"musiconhold":{"type":"string","default":"default"},"announce":{"type":"string","default":""},"strategy":{"type":"string","enum":["rr","ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"],"default":"ringall"},"servicelevel":{"type":"integer","default":0},"context":{"type":"string","default":null},"penaltymemberslimit":{"type":"integer"},"timeout":{"type":"integer","default":15},"retry":{"type":"integer","default":2},"timeoutpriority":{"type":"string"},"weight":{"type":"integer","default":0},"wrapuptime":{"type":"integer","default":0},"autofill":{"type":"string","enum":["yes","no"],"default":"yes"},"autopause":{"type":"string","enum":["yes","no","all"],"default":"no"},"autopausedelay":{"type":"integer"},"autopausebusy":{"type":"string","enum":["yes","no"],"default":"no"},"autopauseunavail":{"type":"string","enum":["yes","no"],"default":"no"},"maxlen":{"type":"integer","default":0},"setinterfacevar":{"type":"string","enum":["yes","no"],"default":"no"},"setqueueentryvar":{"type":"string","enum":["yes","no"]},"setqueuevar":{"type":"string","enum":["yes","no"],"default":"no"},"eventmemberstatus":{"type":"string","enum":["yes","no"],"default":"no"},"membermacro":{"type":"string"},"membergosub":{"type":"string"},"announce_frequency":{"type":"integer","default":0},"min_announce_frequency":{"type":"integer","default":0},"periodic_announce_frequency":{"type":"integer","default":0},"random_periodic_announce":{"type":"string","enum":["yes","no"],"default":"no"},"relative_periodic_announce":{"type":"string","enum":["yes","no"],"default":"yes"},"announce_holdtime":{"type":"string","enum":["yes","no","once"],"default":"no"},"announce_position":{"type":"string","default":"no"},"announce_to_first_user":{"type":"string","enum":["yes","no"]},"announce_position_limit":{"type":"integer"},"announce_round_seconds":{"type":"string","enum":["0","5","10","15","20","30"],"default":"0"},"monitor_format":{"type":"string","default":""},"monitor_type":{"type":"string"},"queue_youarenext":{"type":"string","default":null},"queue_thereare":{"type":"string","default":null},"queue_callswaiting":{"type":"string","default":null},"queue_holdtime":{"type":"string","default":null},"queue_minute":{"type":"string","default":null},"queue_minutes":{"type":"string","default":null},"queue_seconds":{"type":"string","default":null},"queue_thankyou":{"type":"string","default":null},"queue_reporthold":{"type":"string"},"queue_quantity1":{"type":"string"},"queue_quantity2":{"type":"string"},"queue_periodic_announce":{"type":"string"},"queue_less_than":{"type":"string"},"periodic_announce":{"type":"string"},"joinempty":{"type":"string","default":"yes"},"leavewhenempty":{"type":"string","default":"no"},"reportholdtime":{"type":"string","enum":["yes","no"],"default":"no"},"ringinuse":{"type":"string","enum":["yes","no"],"default":"no"},"memberdelay":{"type":"integer","default":0},"timeoutrestart":{"type":"string","enum":["yes","no"],"default":"no"},"defaultrule":{"type":"string"},"description":{"type":"string"},"acw":{"type":"boolean","default":0},"acwTimeout":{"type":"integer","default":10},"dialActive":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"dialMethod":{"type":"string","enum":["preview","progressive","power","predictive","booked"],"description":"Dial Method.","default":"progressive"},"dialLimitChannel":{"type":"integer","description":"Max 9999 channels, 0 means unlimited.","default":0},"dialLimitQueue":{"type":"integer","description":"Max 9999 member in queue(min:1, max:9999), 0 means unlimited.","default":0},"dialPowerLevel":{"type":"number","description":"Power Level: Calls for agents (min:1, max:10).","default":1},"dialPredictiveOptimization":{"type":"string","enum":["agentBusyFactor","dropRate"],"description":"Only for predictive method.","default":"dropRate"},"dialPredictiveOptimizationPercentage":{"type":"number","description":"Predictive Optimization Percentage (min: 1, max: 95)","default":3},"dialPredictiveInterval":{"type":"integer","description":"Interval Predictive Minutes (min:5 max:30)","default":10},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialQueueOptions":{"type":"string","description":"https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue","default":"tTxX"},"dialQueueTimeout":{"type":"integer","description":"Queue Timeout Seconds (min:1, max:999)","default":3},"dialQueueProject":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialPrefix":{"type":"string","default":null},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialRecallMeTimeout":{"type":"integer","description":"#RecallMe Timeout (min:1)","default":30},"dialRecallInQueue":{"type":"boolean","description":"Active/Disactive Recall In Queue","default":0},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialQueueProject2":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialAgiAfterHangupClient":{"type":"boolean","default":false},"dialAgiAfterHangupAgent":{"type":"boolean","default":false},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"dialPredictiveIntervalMaxThreshold":{"type":"integer","default":20},"dialPredictiveIntervalMinThreshold":{"type":"integer","default":10}},"required":["name","type","strategy"]}}}},"responses":{"201":{"description":"VoiceQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getVoiceQueueById","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue to get"}],"responses":{"200":{"description":"VoiceQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateVoiceQueueById","tags":["Voice Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["inbound","outbound"],"default":"inbound"},"musiconhold":{"type":"string","default":"default"},"announce":{"type":"string","default":""},"strategy":{"type":"string","enum":["rr","ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"],"default":"ringall"},"servicelevel":{"type":"integer","default":0},"context":{"type":"string","default":null},"penaltymemberslimit":{"type":"integer"},"timeout":{"type":"integer","default":15},"retry":{"type":"integer","default":2},"timeoutpriority":{"type":"string"},"weight":{"type":"integer","default":0},"wrapuptime":{"type":"integer","default":0},"autofill":{"type":"string","enum":["yes","no"],"default":"yes"},"autopause":{"type":"string","enum":["yes","no","all"],"default":"no"},"autopausedelay":{"type":"integer"},"autopausebusy":{"type":"string","enum":["yes","no"],"default":"no"},"autopauseunavail":{"type":"string","enum":["yes","no"],"default":"no"},"maxlen":{"type":"integer","default":0},"setinterfacevar":{"type":"string","enum":["yes","no"],"default":"no"},"setqueueentryvar":{"type":"string","enum":["yes","no"]},"setqueuevar":{"type":"string","enum":["yes","no"],"default":"no"},"eventmemberstatus":{"type":"string","enum":["yes","no"],"default":"no"},"membermacro":{"type":"string"},"membergosub":{"type":"string"},"announce_frequency":{"type":"integer","default":0},"min_announce_frequency":{"type":"integer","default":0},"periodic_announce_frequency":{"type":"integer","default":0},"random_periodic_announce":{"type":"string","enum":["yes","no"],"default":"no"},"relative_periodic_announce":{"type":"string","enum":["yes","no"],"default":"yes"},"announce_holdtime":{"type":"string","enum":["yes","no","once"],"default":"no"},"announce_position":{"type":"string","default":"no"},"announce_to_first_user":{"type":"string","enum":["yes","no"]},"announce_position_limit":{"type":"integer"},"announce_round_seconds":{"type":"string","enum":["0","5","10","15","20","30"],"default":"0"},"monitor_format":{"type":"string","default":""},"monitor_type":{"type":"string"},"queue_youarenext":{"type":"string","default":null},"queue_thereare":{"type":"string","default":null},"queue_callswaiting":{"type":"string","default":null},"queue_holdtime":{"type":"string","default":null},"queue_minute":{"type":"string","default":null},"queue_minutes":{"type":"string","default":null},"queue_seconds":{"type":"string","default":null},"queue_thankyou":{"type":"string","default":null},"queue_reporthold":{"type":"string"},"queue_quantity1":{"type":"string"},"queue_quantity2":{"type":"string"},"queue_periodic_announce":{"type":"string"},"queue_less_than":{"type":"string"},"periodic_announce":{"type":"string"},"joinempty":{"type":"string","default":"yes"},"leavewhenempty":{"type":"string","default":"no"},"reportholdtime":{"type":"string","enum":["yes","no"],"default":"no"},"ringinuse":{"type":"string","enum":["yes","no"],"default":"no"},"memberdelay":{"type":"integer","default":0},"timeoutrestart":{"type":"string","enum":["yes","no"],"default":"no"},"defaultrule":{"type":"string"},"description":{"type":"string"},"acw":{"type":"boolean","default":0},"acwTimeout":{"type":"integer","default":10},"dialActive":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"dialMethod":{"type":"string","enum":["preview","progressive","power","predictive","booked"],"description":"Dial Method.","default":"progressive"},"dialLimitChannel":{"type":"integer","description":"Max 9999 channels, 0 means unlimited.","default":0},"dialLimitQueue":{"type":"integer","description":"Max 9999 member in queue(min:1, max:9999), 0 means unlimited.","default":0},"dialPowerLevel":{"type":"number","description":"Power Level: Calls for agents (min:1, max:10).","default":1},"dialPredictiveOptimization":{"type":"string","enum":["agentBusyFactor","dropRate"],"description":"Only for predictive method.","default":"dropRate"},"dialPredictiveOptimizationPercentage":{"type":"number","description":"Predictive Optimization Percentage (min: 1, max: 95)","default":3},"dialPredictiveInterval":{"type":"integer","description":"Interval Predictive Minutes (min:5 max:30)","default":10},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialQueueOptions":{"type":"string","description":"https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue","default":"tTxX"},"dialQueueTimeout":{"type":"integer","description":"Queue Timeout Seconds (min:1, max:999)","default":3},"dialQueueProject":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialPrefix":{"type":"string","default":null},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialRecallMeTimeout":{"type":"integer","description":"#RecallMe Timeout (min:1)","default":30},"dialRecallInQueue":{"type":"boolean","description":"Active/Disactive Recall In Queue","default":0},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialQueueProject2":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialAgiAfterHangupClient":{"type":"boolean","default":false},"dialAgiAfterHangupAgent":{"type":"boolean","default":false},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"dialPredictiveIntervalMaxThreshold":{"type":"integer","default":20},"dialPredictiveIntervalMinThreshold":{"type":"integer","default":10}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueue not found"}}}},"/voice/queues/{id}/hoppers":{"get":{"summary":"Gets queue hoppers","security":[{"BearerAuth":[]}],"operationId":"getHoppers","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/hopper_histories":{"get":{"summary":"Gets queue hopper histories","security":[{"BearerAuth":[]}],"operationId":"getHopperHistories","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/hopper_finals":{"get":{"summary":"Gets queue hopper finals","security":[{"BearerAuth":[]}],"operationId":"getHopperFinals","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/hopper_black":{"get":{"summary":"Gets queue hopper blacks","security":[{"BearerAuth":[]}],"operationId":"getHopperBlacks","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/teams":{"get":{"summary":"Gets queue team","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/members":{"get":{"summary":"Gets queue members","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/lists":{"get":{"summary":"Get queue lists","security":[{"BearerAuth":[]}],"operationId":"getLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add lists to a queue","security":[{"BearerAuth":[]}],"operationId":"addLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove lists from a queue","security":[{"BearerAuth":[]}],"operationId":"removeLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/blacklists":{"get":{"summary":"Get queue blacklists","security":[{"BearerAuth":[]}],"operationId":"getBlackLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add blacklists to a queue","security":[{"BearerAuth":[]}],"operationId":"addBlackLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove blacklists from a queue","security":[{"BearerAuth":[]}],"operationId":"removeBlackLists","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/clone":{"post":{"summary":"Clone an existing Queue","security":[{"BearerAuth":[]}],"operationId":"cloneVoiceQueue","tags":["Voice Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"id of the Queue to clone"},"name":{"type":"string"},"type":{"type":"string","enum":["inbound","outbound"],"default":"inbound"},"musiconhold":{"type":"string","default":"default"},"announce":{"type":"string","default":""},"strategy":{"type":"string","enum":["rr","ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"],"default":"ringall"},"servicelevel":{"type":"integer","default":0},"context":{"type":"string","default":null},"penaltymemberslimit":{"type":"integer"},"timeout":{"type":"integer","default":15},"retry":{"type":"integer","default":2},"timeoutpriority":{"type":"string"},"weight":{"type":"integer","default":0},"wrapuptime":{"type":"integer","default":0},"autofill":{"type":"string","enum":["yes","no"],"default":"yes"},"autopause":{"type":"string","enum":["yes","no","all"],"default":"no"},"autopausedelay":{"type":"integer"},"autopausebusy":{"type":"string","enum":["yes","no"],"default":"no"},"autopauseunavail":{"type":"string","enum":["yes","no"],"default":"no"},"maxlen":{"type":"integer","default":0},"setinterfacevar":{"type":"string","enum":["yes","no"],"default":"no"},"setqueueentryvar":{"type":"string","enum":["yes","no"]},"setqueuevar":{"type":"string","enum":["yes","no"],"default":"no"},"eventmemberstatus":{"type":"string","enum":["yes","no"],"default":"no"},"membermacro":{"type":"string"},"membergosub":{"type":"string"},"announce_frequency":{"type":"integer","default":0},"min_announce_frequency":{"type":"integer","default":0},"periodic_announce_frequency":{"type":"integer","default":0},"random_periodic_announce":{"type":"string","enum":["yes","no"],"default":"no"},"relative_periodic_announce":{"type":"string","enum":["yes","no"],"default":"yes"},"announce_holdtime":{"type":"string","enum":["yes","no","once"],"default":"no"},"announce_position":{"type":"string","default":"no"},"announce_to_first_user":{"type":"string","enum":["yes","no"]},"announce_position_limit":{"type":"integer"},"announce_round_seconds":{"type":"string","enum":["0","5","10","15","20","30"],"default":"0"},"monitor_format":{"type":"string","default":""},"monitor_type":{"type":"string"},"queue_youarenext":{"type":"string","default":null},"queue_thereare":{"type":"string","default":null},"queue_callswaiting":{"type":"string","default":null},"queue_holdtime":{"type":"string","default":null},"queue_minute":{"type":"string","default":null},"queue_minutes":{"type":"string","default":null},"queue_seconds":{"type":"string","default":null},"queue_thankyou":{"type":"string","default":null},"queue_reporthold":{"type":"string"},"queue_quantity1":{"type":"string"},"queue_quantity2":{"type":"string"},"queue_periodic_announce":{"type":"string"},"queue_less_than":{"type":"string"},"periodic_announce":{"type":"string"},"joinempty":{"type":"string","default":"yes"},"leavewhenempty":{"type":"string","default":"no"},"reportholdtime":{"type":"string","enum":["yes","no"],"default":"no"},"ringinuse":{"type":"string","enum":["yes","no"],"default":"no"},"memberdelay":{"type":"integer","default":0},"timeoutrestart":{"type":"string","enum":["yes","no"],"default":"no"},"defaultrule":{"type":"string"},"description":{"type":"string"},"acw":{"type":"boolean","default":0},"acwTimeout":{"type":"integer","default":10},"dialActive":{"type":"boolean","description":"Active/Disactive Campaign","default":0},"dialMethod":{"type":"string","enum":["preview","progressive","power","predictive","booked"],"description":"Dial Method.","default":"progressive"},"dialLimitChannel":{"type":"integer","description":"Max 9999 channels, 0 means unlimited.","default":0},"dialLimitQueue":{"type":"integer","description":"Max 9999 member in queue(min:1, max:9999), 0 means unlimited.","default":0},"dialPowerLevel":{"type":"number","description":"Power Level: Calls for agents (min:1, max:10).","default":1},"dialPredictiveOptimization":{"type":"string","enum":["agentBusyFactor","dropRate"],"description":"Only for predictive method.","default":"dropRate"},"dialPredictiveOptimizationPercentage":{"type":"number","description":"Predictive Optimization Percentage (min: 1, max: 95)","default":3},"dialPredictiveInterval":{"type":"integer","description":"Interval Predictive Minutes (min:5 max:30)","default":10},"dialOriginateCallerIdName":{"type":"string"},"dialOriginateCallerIdNumber":{"type":"string"},"dialOriginateTimeout":{"type":"integer","description":"Originate Timeout Seconds (min:1, max:999)","default":30},"dialQueueOptions":{"type":"string","description":"https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue","default":"tTxX"},"dialQueueTimeout":{"type":"integer","description":"Queue Timeout Seconds (min:1, max:999)","default":3},"dialQueueProject":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialCongestionMaxRetry":{"type":"integer","description":"#Congestion Retry (min:1, max:999)","default":3},"dialCongestionRetryFrequency":{"type":"integer","description":"Congestion Retry Frequency Minutes (min:1, max:99999)","default":150},"dialBusyMaxRetry":{"type":"integer","description":"#Busy Retry (min:1, max:999)","default":3},"dialBusyRetryFrequency":{"type":"integer","description":"Busy Retry Frequency Minutes (min:1, max:99999)","default":150},"dialNoAnswerMaxRetry":{"type":"integer","description":"#NoAnswer Retry (min:1, max:999)","default":3},"dialNoAnswerRetryFrequency":{"type":"integer","description":"NoAnswer Retry Frequency Minutes (min:1, max:99999)","default":150},"dialGlobalMaxRetry":{"type":"integer","description":"#Global Max Retry (min:1, max:999)","default":4},"dialTimezone":{"type":"string","default":null},"dialGlobalInterval":{"type":"string","default":"07:00-22:00,*,*,*"},"dialPrefix":{"type":"string","default":null},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"default":"always"},"dialAMDActive":{"type":"boolean","description":"Active/Disactive AMD","default":0},"dialAMDInitialSilence":{"type":"integer","description":"#AMD Initial Silence","default":2500},"dialAMDGreeting":{"type":"integer","description":"#AMD Greeting","default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","description":"#AMD After Greeting Silence","default":800},"dialAMDTotalAnalysisTime":{"type":"integer","description":"#AMD Total Analysis Time","default":5000},"dialAMDMinWordLength":{"type":"integer","description":"#AMD Min Word Length","default":100},"dialAMDBetweenWordsSilence":{"type":"integer","description":"#AMD Between Words Silence","default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","description":"#AMD Maximum Number Of Words","default":3},"dialAMDSilenceThreshold":{"type":"integer","description":"#AMD Silence Threshold (min:0, max:32767)","default":256},"dialAMDMaximumWordLength":{"type":"integer","description":"#AMD Maximum Word Length","default":5000},"dialRecallMeTimeout":{"type":"integer","description":"#RecallMe Timeout (min:1)","default":30},"dialRecallInQueue":{"type":"boolean","description":"Active/Disactive Recall In Queue","default":0},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"default":"DESC"},"dialQueueProject2":{"type":"string","description":"AGI queue option (use: agi://127.0.0.1/square,<project_name>)"},"dialAgiAfterHangupClient":{"type":"boolean","default":false},"dialAgiAfterHangupAgent":{"type":"boolean","default":false},"dialRandomLastDigitCallerIdNumber":{"type":"integer","description":"Random Last Digit (min:1, max:15)","default":0},"dialCutDigit":{"type":"integer","description":"Cut Digit (min:1, max:15)","default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","description":"#NoSuchNumber Retry (min:1, max:999)","default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","description":"NoSuchNumber Retry Frequency Minutes (min:1, max:99999)","default":150},"dialDropMaxRetry":{"type":"integer","description":"#Drop Retry (min:1, max:999)","default":3},"dialDropRetryFrequency":{"type":"integer","description":"Drop Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAbandonedMaxRetry":{"type":"integer","description":"#Abandoned Retry (min:1, max:999)","default":3},"dialAbandonedRetryFrequency":{"type":"integer","description":"Abandoned Retry Frequency Minutes (min:1, max:99999)","default":150},"dialMachineMaxRetry":{"type":"integer","description":"#Machine Retry (min:1, max:999)","default":3},"dialMachineRetryFrequency":{"type":"integer","description":"Machine Retry Frequency Minutes (min:1, max:99999)","default":150},"dialAgentRejectMaxRetry":{"type":"integer","description":"#AgentReject Retry (min:1, max:999)","default":3},"dialAgentRejectRetryFrequency":{"type":"integer","description":"AgentReject Retry Frequency Minutes (min:1, max:99999)","default":150},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"dialPredictiveIntervalMaxThreshold":{"type":"integer","default":20},"dialPredictiveIntervalMinThreshold":{"type":"integer","default":10}},"required":["id"]}}}},"responses":{"201":{"description":"VoiceQueue successfully cloned. Returns the cloned object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceQueueById","tags":["Voice Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueue not found"}}}},"/voice/queues/reports":{"get":{"summary":"Gets a list of Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceQueueReport","tags":["Voice Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/reports/describe":{"get":{"summary":"Gets table info about Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeVoiceQueueReport","tags":["Voice Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/reports/index":{"get":{"summary":"Get Voice Queues Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceQueuesReport","tags":["Voice Queue Reports"],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/queues/reports/{id}":{"get":{"summary":"Gets a single Queue Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceQueueReportById","tags":["Voice Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueueReport to get"}],"responses":{"200":{"description":"VoiceQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueueReport not found"}}}},"/voiceQueuesLog":{"get":{"summary":"Gets a list of VoiceQueuesLogs","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceQueuesLog","tags":["voiceQueuesLog"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceQueuesLog"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of VoiceQueuesLogs","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueuesLog"}}}}},"206":{"description":"Partial (paged) collection of VoiceQueuesLogs","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceQueuesLog"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new VoiceQueuesLog","security":[{"BearerAuth":[]}],"operationId":"createVoiceQueuesLog","tags":["voiceQueuesLog"],"requestBody":{"required":true,"description":"data for creating a new VoiceQueuesLog","content":{"application/json":{"schema":{"type":"object","properties":{"time":{"type":"string"},"callid":{"type":"string","default":""},"queuename":{"type":"string","default":""},"agent":{"type":"string","default":""},"event":{"type":"string","default":""},"data":{"type":"string","default":""},"data1":{"type":"string","default":""},"data2":{"type":"string","default":""},"data3":{"type":"string","default":""},"data4":{"type":"string","default":""},"data5":{"type":"string","default":""},"dtm":{"type":"string","default":"2020-11-27 10:41:25"}},"required":["callid","queuename","agent","event","data","data1","data2","data3","data4","data5","dtm"]}}}},"responses":{"201":{"description":"VoiceQueuesLog successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueuesLog"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voiceQueuesLog/{id}":{"get":{"summary":"Gets a single VoiceQueuesLog","security":[{"BearerAuth":[]}],"operationId":"getVoiceQueuesLogById","tags":["voiceQueuesLog"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueuesLog to get"}],"responses":{"200":{"description":"VoiceQueuesLog with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceQueuesLog"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueuesLog not found"}}},"put":{"summary":"Update an existing VoiceQueuesLog","security":[{"BearerAuth":[]}],"operationId":"updateVoiceQueuesLogById","tags":["voiceQueuesLog"],"requestBody":{"required":true,"description":"data for updating a new VoiceQueuesLog","content":{"application/json":{"schema":{"type":"object","properties":{"time":{"type":"string"},"callid":{"type":"string","default":""},"queuename":{"type":"string","default":""},"agent":{"type":"string","default":""},"event":{"type":"string","default":""},"data":{"type":"string","default":""},"data1":{"type":"string","default":""},"data2":{"type":"string","default":""},"data3":{"type":"string","default":""},"data4":{"type":"string","default":""},"data5":{"type":"string","default":""},"dtm":{"type":"string","default":"2020-11-27 10:41:25"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueuesLog to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueuesLog not found"}}}},"/voiceQueuesLog/{id}/destroy_many":{"delete":{"summary":"Destroy an existing VoiceQueuesLog","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceQueuesLogById","tags":["voiceQueuesLog"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceQueuesLog to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceQueuesLog not found"}}}},"/voice/recordings":{"get":{"summary":"Gets a list of Recordings","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceRecording","tags":["Voice Recordings"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceRecording"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceRecording"}}}}},"206":{"description":"Partial (paged) collection of Recordings","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceRecording"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Recording","security":[{"BearerAuth":[]}],"operationId":"createVoiceRecording","tags":["Voice Recordings"],"requestBody":{"required":true,"description":"data for creating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string"},"uniqueid":{"type":"string"},"channel":{"type":"string"},"membername":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"connectedlinenum":{"type":"string"},"connectedlinename":{"type":"string"},"accountcode":{"type":"string"},"context":{"type":"string"},"exten":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"rating":{"type":"integer"},"queue":{"type":"string"},"userDisposition":{"type":"string"},"userSecondDisposition":{"type":"string"},"userThirdDisposition":{"type":"string"},"location":{"type":"string"},"transcribeName":{"type":"string"},"transcribeStatus":{"type":"string","default":"NEW"},"fileUri":{"type":"string"},"fileText":{"type":"string"},"failureReason":{"type":"string"},"sentiment":{"type":"string"},"sPositive":{"type":"number"},"sNegative":{"type":"number"},"sNeutral":{"type":"number"},"sMixed":{"type":"number"},"tempSentiment":{"type":"boolean","default":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"responses":{"201":{"description":"VoiceRecording successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/recordings/describe":{"get":{"summary":"Gets table info about Recordings","security":[{"BearerAuth":[]}],"operationId":"describeVoiceRecording","tags":["Voice Recordings"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/recordings/{id}":{"get":{"summary":"Gets a single Recording","security":[{"BearerAuth":[]}],"operationId":"getVoiceRecordingById","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording to get"}],"responses":{"200":{"description":"VoiceRecording with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceRecording"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceRecording not found"}}},"put":{"summary":"Update an existing Recording","security":[{"BearerAuth":[]}],"operationId":"updateVoiceRecordingById","tags":["Voice Recordings"],"requestBody":{"required":true,"description":"data for updating a new Recording","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string"},"uniqueid":{"type":"string"},"channel":{"type":"string"},"membername":{"type":"string"},"calleridnum":{"type":"string"},"calleridname":{"type":"string"},"connectedlinenum":{"type":"string"},"connectedlinename":{"type":"string"},"accountcode":{"type":"string"},"context":{"type":"string"},"exten":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"rating":{"type":"integer"},"queue":{"type":"string"},"userDisposition":{"type":"string"},"userSecondDisposition":{"type":"string"},"userThirdDisposition":{"type":"string"},"location":{"type":"string"},"transcribeName":{"type":"string"},"transcribeStatus":{"type":"string","default":"NEW"},"fileUri":{"type":"string"},"fileText":{"type":"string"},"failureReason":{"type":"string"},"sentiment":{"type":"string"},"sPositive":{"type":"number"},"sNegative":{"type":"number"},"sNeutral":{"type":"number"},"sMixed":{"type":"number"},"tempSentiment":{"type":"boolean","default":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceRecording not found"}}},"delete":{"summary":"Delete voice recording","security":[{"BearerAuth":[]}],"operationId":"destroy","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/recordings/{id}/download":{"get":{"summary":"Download Recording","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/recordings/{id}/downloads":{"get":{"summary":"Download Recording","operationId":"downloads","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/voice/recordings/{id}/transcribe":{"get":{"summary":"Run Transcribe Recording","security":[{"BearerAuth":[]}],"operationId":"downloadTranscribe","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Run Transcribe Recording","security":[{"BearerAuth":[]}],"operationId":"runTranscribe","tags":["Voice Recordings"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceRecording"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/transfers/reports":{"get":{"summary":"Gets a list of Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllVoiceTransferReport","tags":["Voice Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each VoiceTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoiceTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createVoiceTransferReport","tags":["Voice Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["blind","attended"]},"result":{"type":"string"},"transfererchannel":{"type":"string"},"transferercalleridnum":{"type":"string"},"transferercalleridname":{"type":"string"},"transfererconnectedlinenum":{"type":"string"},"transfererconnectedlinename":{"type":"string"},"transfereraccountcode":{"type":"string"},"transferercontext":{"type":"string"},"transfererexten":{"type":"string"},"transfererlinkedid":{"type":"string"},"transfereechannel":{"type":"string"},"transfereecalleridnum":{"type":"string"},"transfereecalleridname":{"type":"string"},"transfereeconnectedlinenum":{"type":"string"},"transfereeconnectedlinename":{"type":"string"},"transfereeaccountcode":{"type":"string"},"transfereecontext":{"type":"string"},"transfereeexten":{"type":"string"},"transfereelinkedid":{"type":"string"},"isexternal":{"type":"string","enum":["Yes","No"]},"context":{"type":"string"},"extension":{"type":"string"}}}}}},"responses":{"201":{"description":"VoiceTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/voice/transfers/reports/{id}":{"get":{"summary":"Gets a single Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getVoiceTransferReportById","tags":["Voice Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceTransferReport to get"}],"responses":{"200":{"description":"VoiceTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceTransferReport not found"}}},"put":{"summary":"Update an existing Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateVoiceTransferReportById","tags":["Voice Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["blind","attended"]},"result":{"type":"string"},"transfererchannel":{"type":"string"},"transferercalleridnum":{"type":"string"},"transferercalleridname":{"type":"string"},"transfererconnectedlinenum":{"type":"string"},"transfererconnectedlinename":{"type":"string"},"transfereraccountcode":{"type":"string"},"transferercontext":{"type":"string"},"transfererexten":{"type":"string"},"transfererlinkedid":{"type":"string"},"transfereechannel":{"type":"string"},"transfereecalleridnum":{"type":"string"},"transfereecalleridname":{"type":"string"},"transfereeconnectedlinenum":{"type":"string"},"transfereeconnectedlinename":{"type":"string"},"transfereeaccountcode":{"type":"string"},"transfereecontext":{"type":"string"},"transfereeexten":{"type":"string"},"transfereelinkedid":{"type":"string"},"isexternal":{"type":"string","enum":["Yes","No"]},"context":{"type":"string"},"extension":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceTransferReport not found"}}}},"/voice/transfers/reports/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteVoiceTransferReportById","tags":["Voice Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the VoiceTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"VoiceTransferReport not found"}}}},"/webbar/originate":{"post":{"summary":"Originate new webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarOriginate","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"callNumber":{"type":"string","description":"call number"},"userId":{"type":"integer","description":"user id"},"callerId":{"type":"string","description":"caller id"},"callbackUrl":{"type":"string","format":"uri","description":"callback uri"}},"required":["callNumber","userId","callerId","callbackUrl"]}}}},"responses":{"200":{"description":"web call originated successfully"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/hangup":{"post":{"summary":"hangup call","security":[{"BearerAuth":[]}],"operationId":"webBarHangup","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"session id"},"userId":{"type":"integer","description":"user id"}},"required":["sessionId","userId"]}}}},"responses":{"200":{"description":"Hangup success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/answer":{"post":{"summary":"answer new webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarAnswer","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"session id"},"userId":{"type":"integer","description":"user id"}},"required":["sessionId","userId"]}}}},"responses":{"200":{"description":"Answer success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/hold":{"post":{"summary":"hold webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarHold","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"session id"},"userId":{"type":"integer","description":"user id"}},"required":["userId"]}}}},"responses":{"200":{"description":"Hold success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/unhold":{"post":{"summary":"unhold webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarUnhold","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"session id"},"userId":{"type":"integer","description":"user id"}},"required":["sessionId","userId"]}}}},"responses":{"200":{"description":"Unhold success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/calls":{"post":{"summary":"retrieve webrtc call list for a user","security":[{"BearerAuth":[]}],"operationId":"webBarCalls","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload containing the user","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","description":"user id"}},"required":["userId"]}}}},"responses":{"200":{"description":"list of calls","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/webbar/transfer":{"post":{"summary":"blind transfer webrtc call","security":[{"BearerAuth":[]}],"operationId":"webBarTransfer","tags":["WebBar"],"requestBody":{"required":true,"description":"Request payload","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","description":"user id"},"sessionId":{"type":"string","description":"session id"},"transferNumber":{"type":"string","description":"transfer number"}},"required":["userId","sessionId","transferNumber"]}}}},"responses":{"200":{"description":"Transfer success"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts":{"get":{"summary":"Gets a list of Accounts","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappAccount","tags":["Whatsapp Accounts"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappAccount"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappAccount"}}}}},"206":{"description":"Partial (paged) collection of Accounts","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappAccount"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Account","security":[{"BearerAuth":[]}],"operationId":"createWhatsappAccount","tags":["Whatsapp Accounts"],"requestBody":{"required":true,"description":"data for creating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","default":"RR1qO3WWSMLNOqQM8V3jP6ZqLmuIDDnf"},"phone":{"type":"string"},"type":{"type":"string","enum":["twilio"]},"accountSid":{"type":"string"},"authToken":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":false},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"description":{"type":"string"}},"required":["name","key","remote"]}}}},"responses":{"201":{"description":"WhatsappAccount successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/describe":{"get":{"summary":"Gets table info about Accounts","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappAccount","tags":["Whatsapp Accounts"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}":{"get":{"summary":"Gets a single Account","security":[{"BearerAuth":[]}],"operationId":"getWhatsappAccountById","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount to get"}],"responses":{"200":{"description":"WhatsappAccount with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappAccount"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappAccount not found"}}},"put":{"summary":"Update an existing Account","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappAccountById","tags":["Whatsapp Accounts"],"requestBody":{"required":true,"description":"data for updating a new Account","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","default":"FMf1MjzZO3wZH7rudjIGZiO6b2Q6vmOz"},"phone":{"type":"string"},"type":{"type":"string","enum":["twilio"]},"accountSid":{"type":"string"},"authToken":{"type":"string"},"notificationTemplate":{"type":"string","default":"Account: {{account.name}}<br/>{{#queue}}Queue: {{queue.name}}<br/>{{/queue}}From : {{from}}"},"notificationSound":{"type":"boolean","default":false},"notificationShake":{"type":"boolean","default":false},"waitForTheAssignedAgent":{"type":"integer","default":10},"queueTransfer":{"type":"boolean","default":false},"queueTransferTimeout":{"type":"integer","default":300},"agentTransfer":{"type":"boolean","default":false},"agentTransferTimeout":{"type":"integer","default":300},"mandatoryDispositionPauseId":{"type":"integer","description":"Status to put when mandatory disposition is enabled"},"mandatoryDisposition":{"type":"boolean","description":"Enabled/disables mandatory dispo on a queue","default":false},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappAccount not found"}}}},"/whatsapp/accounts/{id}/dispositions":{"get":{"summary":"Gets account dispositions","security":[{"BearerAuth":[]}],"operationId":"getDispositions","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new disposition","security":[{"BearerAuth":[]}],"operationId":"addDisposition","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes dispositions from account","security":[{"BearerAuth":[]}],"operationId":"removeDispositions","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/canned_answers":{"get":{"summary":"Gets account canned answers","security":[{"BearerAuth":[]}],"operationId":"getAnswers","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new canned answer","security":[{"BearerAuth":[]}],"operationId":"addAnswer","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes canned answers from account","security":[{"BearerAuth":[]}],"operationId":"removeAnswers","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/users":{"get":{"summary":"Gets agents from whatsapp account","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a whatsapp account","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a whatsapp account","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/applications":{"get":{"summary":"Gets account applications","security":[{"BearerAuth":[]}],"operationId":"getApplications","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new applications","security":[{"BearerAuth":[]}],"operationId":"addApplications","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/notify":{"post":{"summary":"Notify new message","operationId":"notify","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"}}}},"/whatsapp/accounts/{id}/send":{"post":{"summary":"Send new whatsapp message","security":[{"BearerAuth":[]}],"operationId":"send","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/accounts/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Account","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappAccountById","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappAccount to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappAccount not found"}}}},"/whatsapp/applications":{"get":{"summary":"Gets a list of Applications","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappApplication","tags":["Whatsapp Applications"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappApplication"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappApplication"}}}}},"206":{"description":"Partial (paged) collection of Applications","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappApplication"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Application","security":[{"BearerAuth":[]}],"operationId":"createWhatsappApplication","tags":["Whatsapp Applications"],"requestBody":{"required":true,"description":"data for creating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}},"required":["priority","app"]}}}},"responses":{"201":{"description":"WhatsappApplication successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/applications/{id}":{"get":{"summary":"Gets a single Application","security":[{"BearerAuth":[]}],"operationId":"getWhatsappApplicationById","tags":["Whatsapp Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappApplication to get"}],"responses":{"200":{"description":"WhatsappApplication with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappApplication"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappApplication not found"}}},"put":{"summary":"Update an existing Application","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappApplicationById","tags":["Whatsapp Applications"],"requestBody":{"required":true,"description":"data for updating a new Application","content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string"},"description":{"type":"string"},"interval":{"type":"string","default":"*,*,*,*"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappApplication to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappApplication not found"}}}},"/whatsapp/applications/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Application","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappApplicationById","tags":["Whatsapp Applications"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappApplication to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappApplication not found"}}}},"/whatsapp/interactions":{"get":{"summary":"Gets a list of Interactions","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappInteraction","tags":["Whatsapp Interactions"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappInteraction"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappInteraction"}}}}},"206":{"description":"Partial (paged) collection of Interactions","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappInteraction"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Interaction","security":[{"BearerAuth":[]}],"operationId":"createWhatsappInteraction","tags":["Whatsapp Interactions"],"requestBody":{"required":true,"description":"data for creating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"phone":{"type":"string"},"read1stAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}},"required":["firstMsgDirection","lastMsgDirection"]}}}},"responses":{"201":{"description":"WhatsappInteraction successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/describe":{"get":{"summary":"Gets table info about Interactions","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappInteraction","tags":["Whatsapp Interactions"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/{id}":{"get":{"summary":"Gets a single Interaction","security":[{"BearerAuth":[]}],"operationId":"getWhatsappInteractionById","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction to get"}],"responses":{"200":{"description":"WhatsappInteraction with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappInteraction"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappInteraction not found"}}},"put":{"summary":"Update an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappInteractionById","tags":["Whatsapp Interactions"],"requestBody":{"required":true,"description":"data for updating a new Interaction","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean","default":false},"closedAt":{"type":"string"},"disposition":{"type":"string"},"secondDisposition":{"type":"string"},"thirdDisposition":{"type":"string"},"note":{"type":"string"},"phone":{"type":"string"},"read1stAt":{"type":"string"},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string"},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappInteraction not found"}}}},"/whatsapp/interactions/{id}/messages":{"get":{"summary":"Gets interaction messages","security":[{"BearerAuth":[]}],"operationId":"getMessages","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates new messages","security":[{"BearerAuth":[]}],"operationId":"addMessage","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/{id}/download":{"get":{"summary":"Gets interaction","security":[{"BearerAuth":[]}],"operationId":"download","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/{id}/tags":{"post":{"summary":"Add tags to the interaction","security":[{"BearerAuth":[]}],"operationId":"addTags","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes tags from interaction","security":[{"BearerAuth":[]}],"operationId":"removeTags","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/interactions/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Interaction","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappInteractionById","tags":["Whatsapp Interactions"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappInteraction to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappInteraction not found"}}}},"/whatsapp/messages":{"get":{"summary":"Gets a list of Messages","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappMessage","tags":["Whatsapp Messages"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappMessage"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappMessage"}}}}},"206":{"description":"Partial (paged) collection of Messages","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappMessage"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Message","security":[{"BearerAuth":[]}],"operationId":"createWhatsappMessage","tags":["Whatsapp Messages"],"requestBody":{"required":true,"description":"data for creating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"phone":{"type":"string"},"readAt":{"type":"string"},"secret":{"type":"boolean","default":false},"providerName":{"type":"string"},"providerResponse":{"type":"string"}},"required":["body","direction"]}}}},"responses":{"201":{"description":"WhatsappMessage successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/messages/describe":{"get":{"summary":"Gets table info about Messages","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappMessage","tags":["Whatsapp Messages"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/messages/{id}":{"get":{"summary":"Gets a single Message","security":[{"BearerAuth":[]}],"operationId":"getWhatsappMessageById","tags":["Whatsapp Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage to get"}],"responses":{"200":{"description":"WhatsappMessage with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappMessage"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappMessage not found"}}},"put":{"summary":"Update an existing Message","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappMessageById","tags":["Whatsapp Messages"],"requestBody":{"required":true,"description":"data for updating a new Message","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"read":{"type":"boolean","default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string"},"phone":{"type":"string"},"readAt":{"type":"string"},"secret":{"type":"boolean","default":false},"providerName":{"type":"string"},"providerResponse":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappMessage not found"}}}},"/whatsapp/messages/{id}/status":{"post":{"summary":"Receive message status","operationId":"status","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage"}],"responses":{"201":{"description":"successfully created"}}}},"/whatsapp/messages/{id}/accept":{"put":{"summary":"Accepts message","security":[{"BearerAuth":[]}],"operationId":"accept","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/messages/{id}/reject":{"put":{"summary":"Rejects message","security":[{"BearerAuth":[]}],"operationId":"reject","tags":["Whatsapp Accounts"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage"}],"responses":{"200":{"description":"successfully updated"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/messages/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Message","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappMessageById","tags":["Whatsapp Messages"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappMessage to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappMessage not found"}}}},"/whatsapp/queues":{"get":{"summary":"Gets a list of Queues","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappQueue","tags":["Whatsapp Queues"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappQueue"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappQueue"}}}}},"206":{"description":"Partial (paged) collection of Queues","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappQueue"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Queue","security":[{"BearerAuth":[]}],"operationId":"createWhatsappQueue","tags":["Whatsapp Queues"],"requestBody":{"required":true,"description":"data for creating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"WhatsappQueue successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/describe":{"get":{"summary":"Gets table info about Queues","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappQueue","tags":["Whatsapp Queues"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/{id}":{"get":{"summary":"Gets a single Queue","security":[{"BearerAuth":[]}],"operationId":"getWhatsappQueueById","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue to get"}],"responses":{"200":{"description":"WhatsappQueue with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappQueue"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueue not found"}}},"put":{"summary":"Update an existing Queue","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappQueueById","tags":["Whatsapp Queues"],"requestBody":{"required":true,"description":"data for updating a new Queue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"timeout":{"type":"integer"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"description":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueue not found"}}}},"/whatsapp/queues/{id}/members":{"get":{"summary":"GetMembers","security":[{"BearerAuth":[]}],"operationId":"getMembers","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/{id}/teams":{"get":{"summary":"Gets queues list","security":[{"BearerAuth":[]}],"operationId":"getTeams","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add teams to a queue","security":[{"BearerAuth":[]}],"operationId":"addTeams","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Remove teams from a queue","security":[{"BearerAuth":[]}],"operationId":"removeTeams","tags":["Teams"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/{id}/users":{"get":{"summary":"Gets queue agents","security":[{"BearerAuth":[]}],"operationId":"getAgents","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Add agents to a queue","security":[{"BearerAuth":[]}],"operationId":"addAgents","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"201":{"description":"successfully created"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"delete":{"summary":"Removes agents from a queue","security":[{"BearerAuth":[]}],"operationId":"removeAgents","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/queues/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Queue","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappQueueById","tags":["Whatsapp Queues"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueue to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueue not found"}}}},"/whatsapp/reports/queue":{"get":{"summary":"Gets a list of Whatsapp Queue Reports","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappQueueReport","tags":["Whatsapp Queue Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappQueueReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Whatsapp Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappQueueReport"}}}}},"206":{"description":"Partial (paged) collection of Whatsapp Queue Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappQueueReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Whatsapp Queue Report","security":[{"BearerAuth":[]}],"operationId":"createWhatsappQueueReport","tags":["Whatsapp Queue Reports"],"requestBody":{"required":true,"description":"data for creating a new Whatsapp Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}},"required":["uniqueid"]}}}},"responses":{"201":{"description":"WhatsappQueueReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/reports/queue/describe":{"get":{"summary":"Gets table info about Whatsapp Queue Reports","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappQueueReport","tags":["Whatsapp Queue Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/reports/queue/{id}":{"get":{"summary":"Gets a single Whatsapp Queue Report","security":[{"BearerAuth":[]}],"operationId":"getWhatsappQueueReportById","tags":["Whatsapp Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueueReport to get"}],"responses":{"200":{"description":"WhatsappQueueReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappQueueReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueueReport not found"}}},"put":{"summary":"Update an existing Whatsapp Queue Report","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappQueueReportById","tags":["Whatsapp Queue Reports"],"requestBody":{"required":true,"description":"data for updating a new Whatsapp Queue Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"from":{"type":"string"},"joinAt":{"type":"string"},"leaveAt":{"type":"string"},"acceptAt":{"type":"string"},"exitAt":{"type":"string"},"reason":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueueReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueueReport not found"}}}},"/whatsapp/reports/queue/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Whatsapp Queue Report","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappQueueReportById","tags":["Whatsapp Queue Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappQueueReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappQueueReport not found"}}}},"/whatsapp/reports/transfer":{"get":{"summary":"Gets a list of Whatsapp Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"listAllWhatsappTransferReport","tags":["Whatsapp Transfer Reports"],"parameters":[{"in":"query","name":"fields","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"return only specific fields for a result set. This parameter accepts a comma-separated list. E.g. `fields=id,name` will return only id and name of each object.","examples":{"fields":{"value":"id,name","summary":"A call returning only id and name of each WhatsappTransferReport"}}},{"in":"query","name":"filter","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"the result will be filtered by the value you specify. This parameter accepts a comma-separated list. E.g. `filter=john.doe,jane.miller` will return only records with name equal to `john.doe` or `jane.miller`","examples":{"name":{"value":"john.doe,jane.miller","summary":"A call returning a result set for records with name of john.doe or jane.miller"},"filter":{"value":"john","summary":"the result will be filtered by the value you specify"}}},{"in":"query","name":"sort","allowReserved":true,"style":"form","explode":false,"schema":{"type":"string"},"description":"sort a result set based on one or several fields. This parameter accepts a comma-separated list. Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-). E.g. `sort=id,-name` will sort results by `id` ascending and then `name` descending","examples":{"sort":{"value":"id,-name","summary":"sorting results by id ascending and then name descending"}}},{"in":"query","name":"offset","style":"form","explode":false,"schema":{"type":"number"},"description":"a number indicating the start position in the result set you want to return. E.g. `offset=5` will return a result set starting at 5th element.","examples":{"offset":{"value":5,"summary":"a result set starting at 5"}}},{"in":"query","name":"limit","style":"form","explode":false,"schema":{"type":"string"},"description":"a number indicating how many records past the start position you want returned (default = `100`). E.g. `limit=25` will return a maximum of `25` elements.","examples":{"sort":{"value":25,"summary":"returning no more than 25 records"}}}],"responses":{"200":{"description":"Entire collection of Whatsapp Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total. If there are 50 records in total, with a offset of 5 and a limit of 25, the returned Content-Range header would be '5-30/50'","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTransferReport"}}}}},"206":{"description":"Partial (paged) collection of Whatsapp Transfer Reports","headers":{"Content-Range":{"description":"paging data in the form start - end / total","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTransferReport"}}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}},"post":{"summary":"Creates a new Whatsapp Transfer Report","security":[{"BearerAuth":[]}],"operationId":"createWhatsappTransferReport","tags":["Whatsapp Transfer Reports"],"requestBody":{"required":true,"description":"data for creating a new Whatsapp Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"]},"transferredAt":{"type":"string"}},"required":["uniqueid","type"]}}}},"responses":{"201":{"description":"WhatsappTransferReport successfully created. Returns the created object representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/reports/transfer/describe":{"get":{"summary":"Gets table info about Whatsapp Transfer Reports","security":[{"BearerAuth":[]}],"operationId":"describeWhatsappTransferReport","tags":["Whatsapp Transfer Reports"],"responses":{"200":{"description":"succesfully retrieve the table info","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"}}}},"/whatsapp/reports/transfer/{id}":{"get":{"summary":"Gets a single Whatsapp Transfer Report","security":[{"BearerAuth":[]}],"operationId":"getWhatsappTransferReportById","tags":["Whatsapp Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappTransferReport to get"}],"responses":{"200":{"description":"WhatsappTransferReport with matching id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappTransferReport"}}}},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappTransferReport not found"}}},"put":{"summary":"Update an existing Whatsapp Transfer Report","security":[{"BearerAuth":[]}],"operationId":"updateWhatsappTransferReportById","tags":["Whatsapp Transfer Reports"],"requestBody":{"required":true,"description":"data for updating a new Whatsapp Transfer Report","content":{"application/json":{"schema":{"type":"object","properties":{"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"]},"transferredAt":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappTransferReport to be updated"}],"responses":{"200":{"description":"successful update"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappTransferReport not found"}}}},"/whatsapp/reports/transfer/{id}/destroy_many":{"delete":{"summary":"Destroy an existing Whatsapp Transfer Report","security":[{"BearerAuth":[]}],"operationId":"deleteWhatsappTransferReportById","tags":["Whatsapp Transfer Reports"],"parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"Numeric id of the WhatsappTransferReport to be deleted"}],"responses":{"204":{"description":"successfully deleted"},"401":{"description":"Not authenticated"},"403":{"description":"Access token does not have the required scope"},"404":{"description":"WhatsappTransferReport not found"}}}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"User":{"title":"User","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"fullname":{"type":"string"},"alias":{"type":"string","nullable":true},"email":{"type":"string"},"role":{"type":"string","enum":["admin","user","agent","telephone"]},"password":{"type":"string"},"provider":{"type":"string","nullable":true,"default":"local"},"internal":{"type":"integer","format":"int32"},"salt":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"userpic":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"online":{"type":"boolean","nullable":true,"default":false},"lastLoginAt":{"type":"string","format":"date-time","nullable":true},"voicePause":{"type":"boolean","nullable":true,"default":false},"chatPause":{"type":"boolean","nullable":true,"default":false},"mailPause":{"type":"boolean","nullable":true,"default":false},"faxPause":{"type":"boolean","nullable":true,"default":false},"smsPause":{"type":"boolean","nullable":true,"default":false},"whatsappPause":{"type":"boolean","nullable":true,"default":false},"openchannelPause":{"type":"boolean","nullable":true,"default":false},"pauseType":{"type":"string","nullable":true,"default":"DEFAULT PAUSE"},"lastPauseAt":{"type":"string","format":"date-time","nullable":true},"chatCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"mailCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"faxCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"smsCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"whatsappCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"openchannelCapacity":{"type":"integer","format":"int32","nullable":true,"default":0},"phoneBarAutoAnswer":{"type":"boolean","nullable":true,"default":false},"phoneBarEnableSettings":{"type":"boolean","nullable":true,"default":true},"phoneBarListenPort":{"type":"integer","format":"int32","nullable":true,"default":5160},"phoneBarExpires":{"type":"integer","format":"int32","nullable":true,"default":120},"phoneBarRemoteControl":{"type":"boolean","nullable":true,"default":false},"phoneBarRemoteControlPort":{"type":"integer","format":"int32","nullable":true,"default":9888},"phoneBarEnableRecording":{"type":"boolean","nullable":true,"default":false},"phoneBarRingInUse":{"type":"boolean","nullable":true,"default":false},"chanspy":{"type":"boolean","nullable":true,"default":false},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true,"default":"dynamic"},"ipaddr":{"type":"string","nullable":true},"port":{"type":"integer","format":"int32","nullable":true},"regseconds":{"type":"integer","format":"int32","nullable":true},"fullcontact":{"type":"string","nullable":true},"regserver":{"type":"string","nullable":true},"useragent":{"type":"string","nullable":true},"lastms":{"type":"integer","format":"int32","nullable":true},"type":{"type":"string","enum":["friend","user","peer"],"nullable":true,"default":"friend"},"context":{"type":"string","nullable":true,"default":"from-sip"},"callingpres":{"type":"string","enum":["ALLOWED_NOT_SCREENED","ALLOWED_PASSED_SCREEN","ALLOWED_FAILED_SCREEN","ALLOWED","PROHIB_NOT_SCREENED","PROHIB_PASSED_SCREEN","PROHIB_FAILED_SCREEN","PROHIB"],"nullable":true},"deny":{"type":"string","nullable":true},"permit":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"md5secret":{"type":"string","nullable":true},"remotesecret":{"type":"string","nullable":true},"transport":{"type":"string","nullable":true,"default":"udp"},"dtmfmode":{"type":"string","enum":["rfc2833","info","shortinfo","inband","auto"],"nullable":true,"default":"rfc2833"},"directmedia":{"type":"string","enum":["yes","no","nonat","update","outgoing"],"nullable":true,"default":"no"},"directrtpsetup":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"directmediapermit":{"type":"string","nullable":true},"directmediadeny":{"type":"string","nullable":true},"nat":{"type":"string","nullable":true,"default":"force_rport,comedia"},"callgroup":{"type":"string","nullable":true},"namedcallgroup":{"type":"string","nullable":true},"pickupgroup":{"type":"string","nullable":true},"namedpickupgroup":{"type":"string","nullable":true},"language":{"type":"string","nullable":true,"default":"en"},"tonezone":{"type":"string","nullable":true},"disallow":{"type":"string","default":"all"},"allow":{"type":"string","default":"ulaw;alaw;gsm"},"autoframing":{"type":"string","enum":["yes","no"],"nullable":true},"insecure":{"type":"string","nullable":true},"trustrpid":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"trust_id_outbound":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"progressinband":{"type":"string","enum":["yes","no","never"],"nullable":true},"promiscredir":{"type":"string","enum":["yes","no"],"nullable":true},"useclientcode":{"type":"string","enum":["yes","no"],"nullable":true},"accountcode":{"type":"integer","format":"int32","nullable":true},"setvar":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true,"default":"\"\" <>"},"amaflags":{"type":"string","nullable":true},"callcounter":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"busylevel":{"type":"integer","format":"int32","nullable":true},"allowoverlap":{"type":"string","enum":["yes","no"],"nullable":true},"allowsubscribe":{"type":"string","enum":["yes","no"],"nullable":true},"allowtransfer":{"type":"string","enum":["yes","no"],"nullable":true},"ignoresdpversion":{"type":"string","enum":["yes","no"],"nullable":true},"subscribecontext":{"type":"string","nullable":true},"template":{"type":"string","nullable":true},"videosupport":{"type":"string","enum":["yes","no","always"],"nullable":true,"default":"no"},"maxcallbitrate":{"type":"integer","format":"int32","nullable":true},"rfc2833compensate":{"type":"string","enum":["yes","no"],"nullable":true},"mailbox":{"type":"string","nullable":true},"session_timers":{"type":"string","enum":["accept","refuse","originate"],"nullable":true},"session_expires":{"type":"integer","format":"int32","nullable":true},"session_minse":{"type":"integer","format":"int32","nullable":true},"session_refresher":{"type":"string","enum":["uac","uas"],"nullable":true,"default":"uas"},"t38pt_usertpsource":{"type":"string","nullable":true},"regexten":{"type":"string","nullable":true},"fromdomain":{"type":"string","nullable":true},"fromuser":{"type":"string","nullable":true},"qualify":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"keepalive":{"type":"integer","format":"int32","nullable":true},"defaultip":{"type":"string","nullable":true},"defaultuser":{"type":"string","nullable":true},"rtptimeout":{"type":"integer","format":"int32","nullable":true},"rtpholdtimeout":{"type":"integer","format":"int32","nullable":true},"rtpkeepalive":{"type":"integer","format":"int32","nullable":true},"sendrpid":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"outboundproxy":{"type":"string","nullable":true},"callbackextension":{"type":"string","nullable":true},"timert1":{"type":"integer","format":"int32","nullable":true},"timerb":{"type":"integer","format":"int32","nullable":true},"qualifyfreq":{"type":"integer","format":"int32","nullable":true},"contactpermit":{"type":"string","nullable":true},"contactdeny":{"type":"string","nullable":true},"contactacl":{"type":"string","nullable":true},"unsolicited_mailbox":{"type":"string","nullable":true},"use_q850_reason":{"type":"string","nullable":true},"maxforwards":{"type":"integer","format":"int32","nullable":true},"encryption":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"avpf":{"type":"string","enum":["yes","no"],"nullable":true},"force_avp":{"type":"string","enum":["yes","no"],"nullable":true},"icesupport":{"type":"string","enum":["yes","no"],"nullable":true},"dtlsenable":{"type":"string","enum":["yes","no"],"nullable":true},"dtlsverify":{"type":"string","enum":["yes","no","fingerprint","certificate"],"nullable":true},"dtlsrekey":{"type":"integer","format":"int32","nullable":true},"dtlscertfile":{"type":"string","nullable":true},"dtlsprivatekey":{"type":"string","nullable":true},"dtlscipher":{"type":"string","nullable":true},"dtlscafile":{"type":"string","nullable":true},"dtlscapath":{"type":"string","nullable":true},"dtlssetup":{"type":"string","enum":["active","passive","actpass"],"nullable":true},"dtlsfingerprint":{"type":"string","nullable":true},"usereqphone":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"recordonfeature":{"type":"string","nullable":true},"recordofffeature":{"type":"string","nullable":true},"call_limit":{"type":"integer","format":"int32","nullable":true,"default":10},"registertrying":{"type":"string","enum":["yes","no"],"nullable":true},"subscribemwi":{"type":"string","enum":["yes","no"],"nullable":true},"vmexten":{"type":"string","nullable":true},"mohinterpret":{"type":"string","nullable":true},"mohsuggest":{"type":"string","nullable":true},"parkinglot":{"type":"string","nullable":true},"canreinvite":{"type":"string","enum":["yes","no","nonat","update","update,nonat"],"nullable":true,"default":"no"},"loginInPause":{"type":"boolean","nullable":true,"default":false},"resetPasswordToken":{"type":"string","nullable":true},"resetPasswordExpires":{"type":"string","format":"date-time","nullable":true},"passwordResetAt":{"type":"string","format":"date-time","nullable":true,"default":null},"previousPasswords":{"type":"string","nullable":true},"showWebBar":{"type":"integer","format":"int32","nullable":true,"default":0},"permissions":{"type":"string","nullable":true},"phoneBarUnconditionalNumber":{"type":"string","nullable":true},"phoneBarNoReplyNumber":{"type":"string","nullable":true},"phoneBarBusyNumber":{"type":"string","nullable":true},"phoneBarUnconditional":{"type":"boolean","nullable":true,"default":false},"phoneBarNoReply":{"type":"boolean","nullable":true,"default":false},"phoneBarBusy":{"type":"boolean","nullable":true,"default":false},"phoneBarDnd":{"type":"boolean","nullable":true,"default":true},"phoneBarUnansweredCallBadge":{"type":"boolean","nullable":true,"default":true},"phoneBarEnableDtmfTone":{"type":"boolean","nullable":true,"default":false},"phoneBarAutoAnswerDelay":{"type":"integer","format":"int32","nullable":true,"default":0},"extensionMonitor":{"type":"string","nullable":true,"default":""},"crudPermissions":{"type":"integer","format":"int32","nullable":true,"default":0},"rtcp_mux":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"allowmessenger":{"type":"boolean","nullable":true,"default":true},"phoneBarOutboundProxy":{"type":"string","nullable":true},"phoneBarEnableJaws":{"type":"boolean","nullable":true,"default":false},"phoneBarEnableScreenRecordingByAgent":{"type":"boolean","nullable":true,"default":false},"phoneBarEnableVideoRecording":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"phoneBarEnableAutomaticScreenRecording":{"type":"boolean","nullable":true,"default":false},"phoneBarPrefixRequired":{"type":"boolean","nullable":true,"default":false},"hotdesk":{"type":"boolean","nullable":true,"default":false},"interface":{"type":"string","nullable":true,"default":null},"privacyEnabled":{"type":"boolean","nullable":true,"default":false},"apiKeyNonce":{"type":"string","nullable":true},"apiKeyIat":{"type":"string","nullable":true},"screenrecording":{"type":"boolean","nullable":true,"default":false},"blocked":{"type":"boolean","nullable":true,"default":false},"blockedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"loginAttempts":{"type":"integer","format":"int32","nullable":true,"default":0},"disabled":{"type":"boolean","nullable":true,"default":false},"settingsEnabled":{"type":"boolean","nullable":true,"default":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userProfileId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","fullname","email","role","password","provider","internal","online","voicePause","chatPause","mailPause","faxPause","smsPause","whatsappPause","openchannelPause","pauseType","chatCapacity","mailCapacity","faxCapacity","smsCapacity","whatsappCapacity","openchannelCapacity","phoneBarAutoAnswer","phoneBarEnableSettings","phoneBarListenPort","phoneBarExpires","phoneBarRemoteControl","phoneBarRemoteControlPort","phoneBarEnableRecording","phoneBarRingInUse","chanspy","host","type","context","transport","dtmfmode","directmedia","directrtpsetup","nat","language","disallow","allow","trustrpid","trust_id_outbound","callerid","callcounter","videosupport","session_refresher","qualify","sendrpid","encryption","usereqphone","call_limit","canreinvite","loginInPause","passwordResetAt","showWebBar","phoneBarUnconditional","phoneBarNoReply","phoneBarBusy","phoneBarDnd","phoneBarUnansweredCallBadge","phoneBarEnableDtmfTone","phoneBarAutoAnswerDelay","extensionMonitor","crudPermissions","rtcp_mux","allowmessenger","phoneBarEnableJaws","phoneBarEnableScreenRecordingByAgent","phoneBarEnableAutomaticScreenRecording","phoneBarPrefixRequired","hotdesk","interface","privacyEnabled","screenrecording","blocked","blockedAt","loginAttempts","disabled","settingsEnabled","createdAt","updatedAt"]},"VoiceChanSpy":{"title":"VoiceChanSpy","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"prefix":{"type":"string"},"options":{"type":"string","nullable":true},"auth":{"type":"boolean","nullable":true,"default":false},"password":{"type":"string","nullable":true},"record":{"type":"boolean","nullable":true,"default":false},"recordingFormat":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","prefix","auth","record","createdAt","updatedAt"]},"VoiceContext":{"title":"VoiceContext","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"defaultEntry":{"type":"boolean","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","defaultEntry","createdAt","updatedAt"]},"VoiceExtension":{"title":"VoiceExtension","type":"object","properties":{"id":{"type":"integer","format":"int32"},"context":{"type":"string"},"exten":{"type":"string"},"priority":{"type":"string","default":"1"},"tag":{"type":"string","default":"--"},"app":{"type":"string","default":"NoOp"},"appdata":{"type":"string","maxLength":4096,"nullable":true,"default":""},"type":{"type":"string","enum":["inbound","outbound","internal","inbound-fax","outbound-fax","system","any"]},"description":{"type":"string","nullable":true},"interval":{"type":"string","default":"*,*,*,*"},"IntervalId":{"type":"integer","format":"int32","nullable":true},"isApp":{"type":"boolean","default":false},"appType":{"type":"string","nullable":true,"default":null},"callerID":{"type":"string","nullable":true},"record":{"type":"boolean","nullable":true,"default":false},"cutdigits":{"type":"integer","format":"int32","nullable":true},"recordingFormat":{"type":"string","nullable":true,"default":"wav"},"answer":{"type":"boolean","nullable":true,"default":true},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"ChanSpyId":{"type":"integer","format":"int32","nullable":true},"VoiceContextId":{"type":"integer","format":"int32","nullable":true},"VoiceExtensionId":{"type":"integer","format":"int32","nullable":true},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"VoicePrefixId":{"type":"integer","format":"int32","nullable":true}},"required":["id","context","exten","priority","tag","app","appdata","type","interval","isApp","appType","record","recordingFormat","answer","createdAt","updatedAt"]},"VoiceMusicOnHold":{"title":"VoiceMusicOnHold","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"mode":{"type":"string","enum":["custom","files","mp3nb","quietmp3nb","quietmp3","mp3"],"nullable":true,"default":"files"},"directory":{"type":"string","nullable":true},"application":{"type":"string","nullable":true},"digit":{"type":"string","nullable":true},"sort":{"type":"string","nullable":true,"default":"alpha"},"format":{"type":"string","nullable":true},"stamp":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"defaultEntry":{"type":"boolean","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","mode","sort","defaultEntry","createdAt","updatedAt"]},"VoiceQueue":{"title":"VoiceQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["inbound","outbound"],"default":"inbound"},"musiconhold":{"type":"string","nullable":true,"default":"default"},"announce":{"type":"string","nullable":true,"default":""},"strategy":{"type":"string","enum":["rr","ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"],"default":"ringall"},"servicelevel":{"type":"integer","format":"int32","nullable":true,"default":0},"context":{"type":"string","nullable":true,"default":null},"penaltymemberslimit":{"type":"integer","format":"int32","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true,"default":15},"retry":{"type":"integer","format":"int32","nullable":true,"default":2},"timeoutpriority":{"type":"string","nullable":true},"weight":{"type":"integer","format":"int32","nullable":true,"default":0},"wrapuptime":{"type":"integer","format":"int32","nullable":true,"default":0},"autofill":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"autopause":{"type":"string","enum":["yes","no","all"],"nullable":true,"default":"no"},"autopausedelay":{"type":"integer","format":"int32","nullable":true},"autopausebusy":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"autopauseunavail":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"maxlen":{"type":"integer","format":"int32","nullable":true,"default":0},"setinterfacevar":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"setqueueentryvar":{"type":"string","enum":["yes","no"],"nullable":true},"setqueuevar":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"eventmemberstatus":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"membermacro":{"type":"string","nullable":true},"membergosub":{"type":"string","nullable":true},"announce_frequency":{"type":"integer","format":"int32","nullable":true,"default":0},"min_announce_frequency":{"type":"integer","format":"int32","nullable":true,"default":0},"periodic_announce_frequency":{"type":"integer","format":"int32","nullable":true,"default":0},"random_periodic_announce":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"relative_periodic_announce":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"announce_holdtime":{"type":"string","enum":["yes","no","once"],"nullable":true,"default":"no"},"announce_position":{"type":"string","nullable":true,"default":"no"},"announce_to_first_user":{"type":"string","enum":["yes","no"],"nullable":true},"announce_position_limit":{"type":"integer","format":"int32","nullable":true},"announce_round_seconds":{"type":"string","enum":["0","5","10","15","20","30"],"nullable":true,"default":"0"},"monitor_format":{"type":"string","nullable":true,"default":""},"monitor_type":{"type":"string","nullable":true},"queue_youarenext":{"type":"string","nullable":true,"default":null},"queue_thereare":{"type":"string","nullable":true,"default":null},"queue_callswaiting":{"type":"string","nullable":true,"default":null},"queue_holdtime":{"type":"string","nullable":true,"default":null},"queue_minute":{"type":"string","nullable":true,"default":null},"queue_minutes":{"type":"string","nullable":true,"default":null},"queue_seconds":{"type":"string","nullable":true,"default":null},"queue_thankyou":{"type":"string","nullable":true,"default":null},"queue_reporthold":{"type":"string","nullable":true},"queue_quantity1":{"type":"string","nullable":true},"queue_quantity2":{"type":"string","nullable":true},"queue_periodic_announce":{"type":"string","nullable":true},"queue_less_than":{"type":"string","nullable":true},"periodic_announce":{"type":"string","nullable":true},"joinempty":{"type":"string","nullable":true,"default":"yes"},"leavewhenempty":{"type":"string","nullable":true,"default":"no"},"reportholdtime":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"ringinuse":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"memberdelay":{"type":"integer","format":"int32","nullable":true,"default":0},"timeoutrestart":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"defaultrule":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"acw":{"type":"boolean","nullable":true,"default":0},"acwTimeout":{"type":"integer","format":"int32","nullable":true,"default":10},"dialActive":{"type":"boolean","nullable":true,"default":0},"dialMethod":{"type":"string","enum":["preview","progressive","power","predictive","booked"],"nullable":true,"default":"progressive"},"dialLimitChannel":{"type":"integer","format":"int32","nullable":true,"default":0},"dialLimitQueue":{"type":"integer","format":"int32","nullable":true,"default":0},"dialPowerLevel":{"type":"number","format":"float","nullable":true,"default":1},"dialPredictiveOptimization":{"type":"string","enum":["agentBusyFactor","dropRate"],"nullable":true,"default":"dropRate"},"dialPredictiveOptimizationPercentage":{"type":"number","format":"float","nullable":true,"default":3},"dialPredictiveInterval":{"type":"integer","format":"int32","nullable":true,"default":10},"dialOriginateCallerIdName":{"type":"string","nullable":true},"dialOriginateCallerIdNumber":{"type":"string","nullable":true},"dialOriginateTimeout":{"type":"integer","format":"int32","nullable":true,"default":30},"dialQueueOptions":{"type":"string","nullable":true,"default":"tTxX"},"dialQueueTimeout":{"type":"integer","format":"int32","nullable":true,"default":3},"dialQueueProject":{"type":"string","nullable":true},"dialCongestionMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialCongestionRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialBusyMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialBusyRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialNoAnswerMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialNoAnswerRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialGlobalMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":4},"dialTimezone":{"type":"string","nullable":true,"default":null},"dialGlobalInterval":{"type":"string","nullable":true,"default":"07:00-22:00,*,*,*"},"dialPrefix":{"type":"string","nullable":true,"default":null},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"nullable":true,"default":"always"},"dialAMDActive":{"type":"boolean","nullable":true,"default":0},"dialAMDInitialSilence":{"type":"integer","format":"int32","nullable":true,"default":2500},"dialAMDGreeting":{"type":"integer","format":"int32","nullable":true,"default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","format":"int32","nullable":true,"default":800},"dialAMDTotalAnalysisTime":{"type":"integer","format":"int32","nullable":true,"default":5000},"dialAMDMinWordLength":{"type":"integer","format":"int32","nullable":true,"default":100},"dialAMDBetweenWordsSilence":{"type":"integer","format":"int32","nullable":true,"default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAMDSilenceThreshold":{"type":"integer","format":"int32","nullable":true,"default":256},"dialAMDMaximumWordLength":{"type":"integer","format":"int32","nullable":true,"default":5000},"dialRecallMeTimeout":{"type":"integer","format":"int32","nullable":true,"default":30},"dialRecallInQueue":{"type":"boolean","nullable":true,"default":0},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"nullable":true,"default":"DESC"},"dialQueueProject2":{"type":"string","nullable":true},"dialAgiAfterHangupClient":{"type":"boolean","nullable":true,"default":false},"dialAgiAfterHangupAgent":{"type":"boolean","nullable":true,"default":false},"dialRandomLastDigitCallerIdNumber":{"type":"integer","format":"int32","nullable":true,"default":0},"dialCutDigit":{"type":"integer","format":"int32","nullable":true,"default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialDropMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialDropRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialAbandonedMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAbandonedRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialMachineMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialMachineRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialAgentRejectMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAgentRejectRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"dialPredictiveIntervalMaxThreshold":{"type":"integer","format":"int32","nullable":true,"default":20},"dialPredictiveIntervalMinThreshold":{"type":"integer","format":"int32","nullable":true,"default":10},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TrunkId":{"type":"integer","format":"int32","nullable":true},"TrunkBackupId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","type","musiconhold","announce","strategy","servicelevel","context","timeout","retry","weight","wrapuptime","autofill","autopause","autopausebusy","autopauseunavail","maxlen","setinterfacevar","setqueuevar","eventmemberstatus","announce_frequency","min_announce_frequency","periodic_announce_frequency","random_periodic_announce","relative_periodic_announce","announce_holdtime","announce_position","announce_round_seconds","monitor_format","queue_youarenext","queue_thereare","queue_callswaiting","queue_holdtime","queue_minute","queue_minutes","queue_seconds","queue_thankyou","joinempty","leavewhenempty","reportholdtime","ringinuse","memberdelay","timeoutrestart","acw","acwTimeout","dialActive","dialMethod","dialLimitChannel","dialLimitQueue","dialPowerLevel","dialPredictiveOptimization","dialPredictiveOptimizationPercentage","dialPredictiveInterval","dialOriginateTimeout","dialQueueOptions","dialQueueTimeout","dialCongestionMaxRetry","dialCongestionRetryFrequency","dialBusyMaxRetry","dialBusyRetryFrequency","dialNoAnswerMaxRetry","dialNoAnswerRetryFrequency","dialGlobalMaxRetry","dialTimezone","dialGlobalInterval","dialPrefix","dialCheckDuplicateType","dialAMDActive","dialAMDInitialSilence","dialAMDGreeting","dialAMDAfterGreetingSilence","dialAMDTotalAnalysisTime","dialAMDMinWordLength","dialAMDBetweenWordsSilence","dialAMDMaximumNumberOfWords","dialAMDSilenceThreshold","dialAMDMaximumWordLength","dialRecallMeTimeout","dialRecallInQueue","dialOrderByScheduledAt","dialAgiAfterHangupClient","dialAgiAfterHangupAgent","dialRandomLastDigitCallerIdNumber","dialCutDigit","dialNoSuchNumberMaxRetry","dialNoSuchNumberRetryFrequency","dialDropMaxRetry","dialDropRetryFrequency","dialAbandonedMaxRetry","dialAbandonedRetryFrequency","dialMachineMaxRetry","dialMachineRetryFrequency","dialAgentRejectMaxRetry","dialAgentRejectRetryFrequency","mandatoryDisposition","dialPredictiveIntervalMaxThreshold","dialPredictiveIntervalMinThreshold","createdAt","updatedAt"]},"VoiceRecording":{"title":"VoiceRecording","type":"object","properties":{"id":{"type":"integer","format":"int32"},"format":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"uniqueid":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"rating":{"type":"integer","format":"int32","nullable":true},"queue":{"type":"string","nullable":true},"userDisposition":{"type":"string","nullable":true},"userSecondDisposition":{"type":"string","nullable":true},"userThirdDisposition":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"transcribeName":{"type":"string","nullable":true},"transcribeStatus":{"type":"string","nullable":true,"default":"NEW"},"fileUri":{"type":"string","nullable":true},"fileText":{"type":"string","nullable":true},"failureReason":{"type":"string","nullable":true},"sentiment":{"type":"string","nullable":true},"sPositive":{"type":"number","format":"float","nullable":true},"sNegative":{"type":"number","format":"float","nullable":true},"sNeutral":{"type":"number","format":"float","nullable":true},"sMixed":{"type":"number","format":"float","nullable":true},"tempSentiment":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true}},"required":["id","transcribeStatus","tempSentiment"]},"ScreenRecording":{"title":"ScreenRecording","type":"object","properties":{"id":{"type":"integer","format":"int32"},"format":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"interactionid":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"rating":{"type":"integer","format":"int32","nullable":true},"duration":{"type":"integer","format":"int32","nullable":true},"startedAt":{"type":"string","format":"date-time","nullable":true},"closedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true}},"required":["id"]},"VoiceMail":{"title":"VoiceMail","type":"object","properties":{"id":{"type":"integer","format":"int32"},"customer_id":{"type":"string","nullable":true},"context":{"type":"string","nullable":true,"default":"from-voicemail"},"mailbox":{"type":"string","default":""},"password":{"type":"string","nullable":true},"fullname":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"pager":{"type":"string","nullable":true},"tz":{"type":"string","nullable":true,"default":"central"},"attach":{"type":"string","enum":["yes","no"],"default":"yes"},"saycid":{"type":"string","enum":["yes","no"],"default":"yes"},"dialout":{"type":"string","nullable":true},"callback":{"type":"string","nullable":true},"review":{"type":"string","enum":["yes","no"],"default":"no"},"operator":{"type":"string","enum":["yes","no"],"default":"no"},"envelope":{"type":"string","enum":["yes","no"],"default":"no"},"sayduration":{"type":"string","enum":["yes","no"],"default":"no"},"saydurationm":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"default":1},"sendvoicemail":{"type":"string","enum":["yes","no"],"default":"no"},"delete":{"type":"string","enum":["yes","no"],"default":"no"},"nextaftercmd":{"type":"string","enum":["yes","no"],"default":"yes"},"forcename":{"type":"string","enum":["yes","no"],"default":"no"},"forcegreetings":{"type":"string","enum":["yes","no"],"default":"no"},"hidefromdir":{"type":"string","enum":["yes","no"],"default":"yes"},"stamp":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"emailsubject":{"type":"string","nullable":true},"emailbody":{"type":"string","nullable":true},"maxsecs":{"type":"integer","format":"int32","default":180},"maxmsg":{"type":"integer","format":"int32","default":100},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true}},"required":["id","context","mailbox","tz","attach","saycid","review","operator","envelope","sayduration","saydurationm","sendvoicemail","delete","nextaftercmd","forcename","forcegreetings","hidefromdir","maxsecs","maxmsg","createdAt","updatedAt"]},"VoiceMailMessage":{"title":"VoiceMailMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"msgnum":{"type":"integer","format":"int32","default":0},"dir":{"type":"string","nullable":true,"default":""},"context":{"type":"string","nullable":true,"default":""},"macrocontext":{"type":"string","nullable":true,"default":""},"callerid":{"type":"string","nullable":true,"default":""},"origtime":{"type":"string","nullable":true,"default":""},"duration":{"type":"string","nullable":true,"default":""},"mailboxuser":{"type":"string","nullable":true,"default":""},"mailboxcontext":{"type":"string","nullable":true,"default":""},"recording":{"type":"string","format":"byte","nullable":true,"default":null},"flag":{"type":"string","nullable":true,"default":""},"msg_id":{"type":"string","nullable":true,"default":""},"stamp":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]}},"required":["id","msgnum","dir","context","macrocontext","callerid","origtime","duration","mailboxuser","mailboxcontext","recording","flag","msg_id","stamp"]},"VoiceCallReport":{"title":"VoiceCallReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string","nullable":true},"type":{"type":"string","enum":["inbound","internal","outbound","inbound-fax","outbound-fax","dialer"],"nullable":true},"tag":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"destination":{"type":"string","nullable":true},"destinationcontext":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"destinationchannel":{"type":"string","nullable":true},"lastapplication":{"type":"string","nullable":true},"lastdata":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"systemanswertime":{"type":"string","format":"date-time","nullable":true},"answertime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"duration":{"type":"integer","format":"int32","nullable":true},"billableseconds":{"type":"integer","format":"int32","nullable":true},"mohtime":{"type":"integer","format":"int32","nullable":true,"default":0},"disposition":{"type":"string","nullable":true},"amaflags":{"type":"string","nullable":true},"userfield":{"type":"string","nullable":true},"userDisposition":{"type":"string","nullable":true},"userSecondDisposition":{"type":"string","nullable":true},"userThirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"prefix":{"type":"string","nullable":true},"routeid":{"type":"integer","format":"int32","nullable":true},"sipcallid":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","mohtime","createdAt","updatedAt"]},"VoiceDialReport":{"title":"VoiceDialReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"privilege":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"channelstate":{"type":"integer","format":"int32","nullable":true},"channelstatedesc":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"priority":{"type":"integer","format":"int32","nullable":true},"uniqueid":{"type":"string","nullable":true},"linkedid":{"type":"string","nullable":true},"destchannel":{"type":"string","nullable":true},"destchannelstate":{"type":"integer","format":"int32","nullable":true},"destchannelstatedesc":{"type":"string","nullable":true},"destcalleridnum":{"type":"string","nullable":true},"destcalleridname":{"type":"string","nullable":true},"destconnectedlinenum":{"type":"string","nullable":true},"destconnectedlinename":{"type":"string","nullable":true},"destlanguage":{"type":"string","nullable":true},"destaccountcode":{"type":"string","nullable":true},"destcontext":{"type":"string","nullable":true},"destexten":{"type":"string","nullable":true},"destpriority":{"type":"integer","format":"int32","nullable":true},"destuniqueid":{"type":"string","nullable":true},"destlinkedid":{"type":"string","nullable":true},"dialstring":{"type":"string","nullable":true},"dialstatus":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"answertime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"lastevent":{"type":"string","nullable":true},"routeId":{"type":"integer","format":"int32","nullable":true},"duration":{"type":"integer","format":"int32","nullable":true},"holdtime":{"type":"integer","format":"int32","nullable":true},"billableseconds":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"VoiceAgentReport":{"title":"VoiceAgentReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"interface":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"agentcalledAt":{"type":"string","format":"date-time","nullable":true},"agentconnectAt":{"type":"string","format":"date-time","nullable":true},"agentcompleteAt":{"type":"string","format":"date-time","nullable":true},"agentringnoanswerAt":{"type":"string","format":"date-time","nullable":true},"agentdumpAt":{"type":"string","format":"date-time","nullable":true},"holdtime":{"type":"integer","format":"int32","nullable":true},"agentcomplete":{"type":"boolean","nullable":true,"default":false},"agentringnoanswer":{"type":"boolean","nullable":true,"default":false},"agentdump":{"type":"boolean","nullable":true,"default":false},"talktime":{"type":"integer","format":"int32","nullable":true},"agentacw":{"type":"boolean","nullable":true,"default":false},"acwtime":{"type":"integer","format":"int32","nullable":true},"reason":{"type":"string","nullable":true},"lastevent":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"channelstate":{"type":"integer","format":"int32","nullable":true},"channelstatedesc":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"destchannel":{"type":"string","nullable":true},"destchannelstate":{"type":"integer","format":"int32","nullable":true},"destchannelstatedesc":{"type":"string","nullable":true},"destcalleridnum":{"type":"string","nullable":true},"destcalleridname":{"type":"string","nullable":true},"destconnectedlinenum":{"type":"string","nullable":true},"destconnectedlinename":{"type":"string","nullable":true},"destlanguage":{"type":"string","nullable":true},"destaccountcode":{"type":"string","nullable":true},"destcontext":{"type":"string","nullable":true},"destexten":{"type":"string","nullable":true},"destpriority":{"type":"string","nullable":true},"destuniqueid":{"type":"string","nullable":true},"answeredelsewheredestinationuniqueid":{"type":"string","nullable":true},"answeredelsewheremembername":{"type":"string","nullable":true},"transfer":{"type":"boolean","nullable":true,"default":false},"transfertype":{"type":"string","nullable":true},"transferexten":{"type":"string","nullable":true},"transferuniqueid":{"type":"string","nullable":true},"agententerreason":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","agentcomplete","agentringnoanswer","agentdump","agentacw","transfer","agententerreason","createdAt","updatedAt"]},"VoiceQueueReport":{"title":"VoiceQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"queuecallerjoinAt":{"type":"string","format":"date-time","nullable":true},"queuecallerleaveAt":{"type":"string","format":"date-time","nullable":true},"position":{"type":"integer","format":"int32","nullable":true},"count":{"type":"integer","format":"int32","nullable":true},"queuecallerabandon":{"type":"boolean","nullable":true,"default":false},"queuecallerabandonAt":{"type":"string","format":"date-time","nullable":true},"queuecallercomplete":{"type":"boolean","nullable":true,"default":false},"queuecallercompleteAt":{"type":"string","format":"date-time","nullable":true},"queuecallerexit":{"type":"boolean","nullable":true,"default":false},"queuecallerexitAt":{"type":"string","format":"date-time","nullable":true},"queuecallerexitreason":{"type":"string","nullable":true},"originalposition":{"type":"integer","format":"int32","nullable":true},"channel":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"holdtime":{"type":"integer","format":"int32","nullable":true},"mohtime":{"type":"integer","format":"int32","nullable":true,"default":0},"assigned":{"type":"boolean","nullable":true,"default":false},"lastAssignedTo":{"type":"string","nullable":true},"transfer":{"type":"boolean","nullable":true,"default":false},"transfertype":{"type":"string","nullable":true},"transferexten":{"type":"string","nullable":true},"transferuniqueid":{"type":"string","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"queuecallerenterreason":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","queuecallerabandon","queuecallercomplete","queuecallerexit","mohtime","assigned","transfer","queuecallerenterreason","createdAt","updatedAt"]},"MemberReport":{"title":"MemberReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"channel":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"interface":{"type":"string","nullable":true},"type":{"type":"string","nullable":true,"default":"DEFAULT PAUSE"},"duration":{"type":"integer","format":"int32","nullable":true},"enterAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"data1":{"type":"string","nullable":true},"data2":{"type":"string","nullable":true},"data3":{"type":"string","nullable":true},"data4":{"type":"string","nullable":true},"data5":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"internal":{"type":"integer","format":"int32","nullable":true},"uniqueid":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","createdAt","updatedAt"]},"Trunk":{"title":"Trunk","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["friend","user","peer"],"default":"friend"},"context":{"type":"string","default":"from-voip-provider"},"callingpres":{"type":"string","enum":["ALLOWED_NOT_SCREENED","ALLOWED_PASSED_SCREEN","ALLOWED_FAILED_SCREEN","ALLOWED","PROHIB_NOT_SCREENED","PROHIB_PASSED_SCREEN","PROHIB_FAILED_SCREEN","PROHIB"],"nullable":true},"deny":{"type":"string","nullable":true},"permit":{"type":"string","nullable":true},"secret":{"type":"string","nullable":true},"md5secret":{"type":"string","nullable":true},"remotesecret":{"type":"string","nullable":true},"transport":{"type":"string","nullable":true,"default":"udp"},"dtmfmode":{"type":"string","enum":["rfc2833","info","shortinfo","inband","auto"],"nullable":true,"default":"rfc2833"},"directmedia":{"type":"string","enum":["yes","no","nonat","update","outgoing"],"nullable":true,"default":"no"},"directrtpsetup":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"directmediapermit":{"type":"string","nullable":true},"directmediadeny":{"type":"string","nullable":true},"nat":{"type":"string","nullable":true,"default":"force_rport,comedia"},"callgroup":{"type":"string","nullable":true},"namedcallgroup":{"type":"string","nullable":true},"pickupgroup":{"type":"string","nullable":true},"namedpickupgroup":{"type":"string","nullable":true},"language":{"type":"string","nullable":true,"default":"en"},"tonezone":{"type":"string","nullable":true},"disallow":{"type":"string","nullable":true,"default":"all"},"allow":{"type":"string","default":"ulaw;alaw;gsm"},"autoframing":{"type":"string","enum":["yes","no"],"nullable":true},"insecure":{"type":"string","nullable":true,"default":"port,invite"},"trustrpid":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"trust_id_outbound":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"progressinband":{"type":"string","enum":["yes","no","never"],"nullable":true},"promiscredir":{"type":"string","enum":["yes","no"],"nullable":true},"useclientcode":{"type":"string","enum":["yes","no"],"nullable":true},"accountcode":{"type":"integer","format":"int32","nullable":true},"setvar":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true,"default":"\"\" <>"},"amaflags":{"type":"string","nullable":true},"callcounter":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"busylevel":{"type":"integer","format":"int32","nullable":true},"allowoverlap":{"type":"string","enum":["yes","no"],"nullable":true},"allowsubscribe":{"type":"string","enum":["yes","no"],"nullable":true},"allowtransfer":{"type":"string","enum":["yes","no"],"nullable":true},"ignoresdpversion":{"type":"string","enum":["yes","no"],"nullable":true},"subscribecontext":{"type":"string","nullable":true},"template":{"type":"string","nullable":true},"videosupport":{"type":"string","enum":["yes","no","always"],"nullable":true,"default":"no"},"maxcallbitrate":{"type":"integer","format":"int32","nullable":true},"rfc2833compensate":{"type":"string","enum":["yes","no"],"nullable":true},"mailbox":{"type":"string","nullable":true},"session_timers":{"type":"string","enum":["accept","refuse","originate"],"nullable":true},"session_expires":{"type":"integer","format":"int32","nullable":true},"session_minse":{"type":"integer","format":"int32","nullable":true},"session_refresher":{"type":"string","enum":["uac","uas"],"nullable":true,"default":"uas"},"t38pt_usertpsource":{"type":"string","nullable":true},"regexten":{"type":"string","nullable":true},"fromdomain":{"type":"string","nullable":true},"fromuser":{"type":"string","nullable":true},"port":{"type":"integer","format":"int32","nullable":true},"qualify":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"keepalive":{"type":"integer","format":"int32","nullable":true},"defaultip":{"type":"string","nullable":true},"defaultuser":{"type":"string","nullable":true},"rtptimeout":{"type":"integer","format":"int32","nullable":true},"rtpholdtimeout":{"type":"integer","format":"int32","nullable":true},"rtpkeepalive":{"type":"integer","format":"int32","nullable":true},"sendrpid":{"type":"string","enum":["yes","no","pai"],"nullable":true,"default":"no"},"outboundproxy":{"type":"string","nullable":true},"callbackextension":{"type":"string","nullable":true},"timert1":{"type":"integer","format":"int32","nullable":true},"timerb":{"type":"integer","format":"int32","nullable":true},"qualifyfreq":{"type":"integer","format":"int32","nullable":true},"contactpermit":{"type":"string","nullable":true},"contactdeny":{"type":"string","nullable":true},"contactacl":{"type":"string","nullable":true},"unsolicited_mailbox":{"type":"string","nullable":true},"use_q850_reason":{"type":"string","nullable":true},"maxforwards":{"type":"integer","format":"int32","nullable":true},"encryption":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"avpf":{"type":"string","enum":["yes","no"],"nullable":true},"force_avp":{"type":"string","enum":["yes","no"],"nullable":true},"icesupport":{"type":"string","enum":["yes","no"],"nullable":true},"dtlsenable":{"type":"string","enum":["yes","no"],"nullable":true},"dtlsverify":{"type":"string","enum":["yes","no","fingerprint","certificate"],"nullable":true},"dtlsrekey":{"type":"integer","format":"int32","nullable":true},"dtlscertfile":{"type":"string","nullable":true},"dtlsprivatekey":{"type":"string","nullable":true},"dtlscipher":{"type":"string","nullable":true},"dtlscafile":{"type":"string","nullable":true},"dtlscapath":{"type":"string","nullable":true},"dtlssetup":{"type":"string","enum":["active","passive","actpass"],"nullable":true},"dtlsfingerprint":{"type":"string","nullable":true},"usereqphone":{"type":"string","enum":["yes","no"],"nullable":true,"default":"no"},"recordonfeature":{"type":"string","nullable":true},"recordofffeature":{"type":"string","nullable":true},"call_limit":{"type":"integer","format":"int32","nullable":true,"default":1000},"registertrying":{"type":"string","enum":["yes","no"],"nullable":true},"subscribemwi":{"type":"string","enum":["yes","no"],"nullable":true},"vmexten":{"type":"string","nullable":true},"mohinterpret":{"type":"string","nullable":true},"mohsuggest":{"type":"string","nullable":true},"parkinglot":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true,"default":"dynamic"},"canreinvite":{"type":"string","enum":["yes","no","nonat","update","update,nonat"],"nullable":true,"default":"no"},"registry":{"type":"string","nullable":true},"otherFields":{"type":"string","nullable":true},"active":{"type":"boolean","default":true},"t38pt_udptl":{"type":"string","nullable":true,"default":"no"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","type","context","transport","dtmfmode","directmedia","directrtpsetup","nat","language","disallow","allow","insecure","trustrpid","trust_id_outbound","callerid","callcounter","videosupport","session_refresher","qualify","sendrpid","encryption","usereqphone","call_limit","host","canreinvite","active","t38pt_udptl","createdAt","updatedAt"]},"VoiceTransferReport":{"title":"VoiceTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["blind","attended"],"nullable":true},"result":{"type":"string","nullable":true},"transfererchannel":{"type":"string","nullable":true},"transferercalleridnum":{"type":"string","nullable":true},"transferercalleridname":{"type":"string","nullable":true},"transfererconnectedlinenum":{"type":"string","nullable":true},"transfererconnectedlinename":{"type":"string","nullable":true},"transfereraccountcode":{"type":"string","nullable":true},"transferercontext":{"type":"string","nullable":true},"transfererexten":{"type":"string","nullable":true},"transfererlinkedid":{"type":"string","nullable":true},"transfereechannel":{"type":"string","nullable":true},"transfereecalleridnum":{"type":"string","nullable":true},"transfereecalleridname":{"type":"string","nullable":true},"transfereeconnectedlinenum":{"type":"string","nullable":true},"transfereeconnectedlinename":{"type":"string","nullable":true},"transfereeaccountcode":{"type":"string","nullable":true},"transfereecontext":{"type":"string","nullable":true},"transfereeexten":{"type":"string","nullable":true},"transfereelinkedid":{"type":"string","nullable":true},"isexternal":{"type":"string","enum":["Yes","No"],"nullable":true},"context":{"type":"string","nullable":true},"extension":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"UserVoiceQueueRt":{"title":"UserVoiceQueueRt","type":"object","properties":{"uniqueid":{"type":"integer","format":"int32","nullable":true},"membername":{"type":"string"},"UserId":{"type":"integer","format":"int32"},"queue_name":{"type":"string"},"VoiceQueueId":{"type":"integer","format":"int32"},"interface":{"type":"string"},"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"paused":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["membername","UserId","queue_name","VoiceQueueId","interface","penalty","paused","createdAt","updatedAt"]},"UserVoiceQueue":{"title":"UserVoiceQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserChatQueue":{"title":"UserChatQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"ChatQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserMailQueue":{"title":"UserMailQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"MailQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserFaxQueue":{"title":"UserFaxQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"assigned":{"type":"integer","format":"int32","nullable":true,"default":0},"queue":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"FaxQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","assigned","createdAt","updatedAt"]},"UserSmsQueue":{"title":"UserSmsQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"SmsQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserOpenchannelQueue":{"title":"UserOpenchannelQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"OpenchannelQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"UserWhatsappQueue":{"title":"UserWhatsappQueue","type":"object","properties":{"penalty":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"WhatsappQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["penalty","createdAt","updatedAt"]},"MailServerIn":{"title":"MailServerIn","type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true},"authentication":{"type":"boolean","nullable":true,"default":true},"user":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"port":{"type":"integer","format":"int32","nullable":true},"tls":{"type":"boolean","nullable":true,"default":true},"mailbox":{"type":"string","nullable":true,"default":"INBOX"},"connTimeout":{"type":"integer","format":"int32","nullable":true,"default":10},"authTimeout":{"type":"integer","format":"int32","nullable":true,"default":5},"service":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","authentication","tls","mailbox","connTimeout","authTimeout","createdAt","updatedAt"]},"MailServerOut":{"title":"MailServerOut","type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true},"user":{"type":"string","nullable":true},"pass":{"type":"string","nullable":true},"port":{"type":"integer","format":"int32","nullable":true},"secure":{"type":"boolean","nullable":true,"default":false},"service":{"type":"string","nullable":true},"authentication":{"type":"boolean","nullable":true,"default":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","secure","authentication","createdAt","updatedAt"]},"MailAccount":{"title":"MailAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"name":{"type":"string"},"service":{"type":"boolean","nullable":true,"default":false},"email":{"type":"string","nullable":true},"active":{"type":"boolean","nullable":true,"default":true},"key":{"type":"string"},"template":{"type":"string","nullable":true},"markAsUnread":{"type":"boolean","nullable":true,"default":false},"fontFamily":{"type":"string","default":"Arial,Helvetica,sans-serif"},"fontSize":{"type":"integer","format":"int32","nullable":true,"default":13},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true,"default":null},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true},"TemplateId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","service","active","key","markAsUnread","fontFamily","fontSize","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDispositionPauseId","mandatoryDisposition","createdAt","updatedAt"]},"MailQueue":{"title":"MailQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"MailSubstatus":{"title":"MailSubstatus","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"MailInteraction":{"title":"MailInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"inReplyTo":{"type":"string","maxLength":510,"nullable":true},"to":{"type":"string","nullable":true},"cc":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"attach":{"type":"boolean","nullable":true,"default":false},"read1stAt":{"type":"string","format":"date-time","nullable":true},"substatus":{"type":"string","maxLength":60,"nullable":true},"substatusAt":{"type":"string","format":"date-time","nullable":true},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgBody":{"type":"string","nullable":true},"lastMsgText":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","attach","firstMsgDirection","lastMsgDirection","createdAt","updatedAt"]},"MailMessage":{"title":"MailMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"plainBody":{"type":"string","nullable":true},"read":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string","maxLength":510,"nullable":true},"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true},"cc":{"type":"string","nullable":true},"bcc":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"sentAt":{"type":"string","format":"date-time","nullable":true},"attach":{"type":"integer","format":"int32","nullable":true,"default":0},"secret":{"type":"boolean","nullable":true,"default":false},"readAt":{"type":"string","format":"date-time","nullable":true},"originTo":{"type":"string","nullable":true},"originCc":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"MailInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","direction","attach","secret","createdAt","updatedAt"]},"MailApplication":{"title":"MailApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"MailQueueId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"MailQueueReport":{"title":"MailQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"MailInteractionId":{"type":"integer","format":"int32","nullable":true},"MailMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"MailQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"Dashboard":{"title":"Dashboard","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"DashboardItem":{"title":"DashboardItem","type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string","maxLength":20},"attrs":{"type":"string","nullable":true},"sizeX":{"type":"integer","format":"int32","default":1},"sizeY":{"type":"integer","format":"int32","default":1},"row":{"type":"integer","format":"int32","nullable":true},"col":{"type":"integer","format":"int32","nullable":true},"background":{"type":"string","default":"#ffffff"},"foreground":{"type":"string","default":"#2196f3"},"link":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"DashboardId":{"type":"integer","format":"int32","nullable":true}},"required":["id","title","type","sizeX","sizeY","background","foreground","createdAt","updatedAt"]},"FaxAccount":{"title":"FaxAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"ecm":{"type":"string","enum":["yes","no"],"nullable":true,"default":"yes"},"headerinfo":{"type":"string","nullable":true,"default":"xCALLY Motion Fax"},"localstationid":{"type":"string","nullable":true},"minrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"nullable":true,"default":"4800"},"maxrate":{"type":"string","enum":["2400","4800","7200","9600","12000","14400"],"nullable":true,"default":"14400"},"modem":{"type":"string","nullable":true,"default":"v17,v27,v29"},"gateway":{"type":"string","nullable":true,"default":"no"},"faxdetect":{"type":"string","nullable":true,"default":"no"},"t38timeout":{"type":"integer","format":"int32","nullable":true,"default":5000},"tech":{"type":"string","enum":["SIP","IAX","DADHI","KHOMP"],"nullable":true,"default":"SIP"},"key":{"type":"string"},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true,"default":null},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TrunkId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","ecm","headerinfo","minrate","maxrate","modem","gateway","faxdetect","t38timeout","tech","key","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDispositionPauseId","mandatoryDisposition","createdAt","updatedAt"]},"FaxApplication":{"title":"FaxApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"FaxQueueId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"FaxInteraction":{"title":"FaxInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"fax":{"type":"string","nullable":true},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","firstMsgDirection","lastMsgDirection","createdAt","updatedAt"]},"FaxMessage":{"title":"FaxMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"failMessage":{"type":"string","nullable":true,"default":null},"readAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"FaxInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"AttachmentId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","direction","failMessage","createdAt","updatedAt"]},"FaxQueue":{"title":"FaxQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32"},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"]},"lastAgent":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","timeout","strategy","lastAgent","createdAt","updatedAt"]},"FaxQueueReport":{"title":"FaxQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"FaxInteractionId":{"type":"integer","format":"int32","nullable":true},"FaxMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"FaxQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"SmsAccount":{"title":"SmsAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"type":{"type":"string","enum":["twilio","skebby","connectel","clicksend","plivo","clickatell","csc","infobip","intelepeer"],"nullable":true},"accountSid":{"type":"string","nullable":true},"authId":{"type":"string","nullable":true},"authToken":{"type":"string","nullable":true},"smsMethod":{"type":"string","enum":["SI","TI","GP"],"nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"apiKey":{"type":"string","nullable":true},"senderString":{"type":"string","nullable":true},"deliveryReport":{"type":"boolean","nullable":true,"default":false},"description":{"type":"string","nullable":true},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"baseUrl":{"type":"string","nullable":true},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","key","remote","token","deliveryReport","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDisposition","createdAt","updatedAt"]},"SmsApplication":{"title":"SmsApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"SmsQueueId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"SmsInteraction":{"title":"SmsInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","firstMsgDirection","lastMsgDirection","createdAt","updatedAt"]},"SmsMessage":{"title":"SmsMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string","maxLength":190,"nullable":true},"phone":{"type":"string","nullable":true},"readAt":{"type":"string","format":"date-time","nullable":true},"secret":{"type":"boolean","nullable":true,"default":false},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"SmsInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","direction","secret","createdAt","updatedAt"]},"SmsQueue":{"title":"SmsQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"OpenchannelAccount":{"title":"OpenchannelAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"replyUri":{"type":"string","nullable":true},"key":{"type":"string"},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"mapKey":{"type":"string","nullable":true},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true,"default":null},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","token","key","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDispositionPauseId","mandatoryDisposition","createdAt","updatedAt"]},"OpenchannelApplication":{"title":"OpenchannelApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"OpenchannelQueueId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"OpenchannelInteraction":{"title":"OpenchannelInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"threadId":{"type":"string","nullable":true},"externalUrl":{"type":"string","nullable":true},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"from":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","lastMsgDirection","createdAt","updatedAt"]},"OpenchannelMessage":{"title":"OpenchannelMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"secret":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string","format":"date-time","nullable":true},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"OpenchannelInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"AttachmentId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","secret","direction","createdAt","updatedAt"]},"OpenchannelQueue":{"title":"OpenchannelQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"ChatWebsite":{"title":"ChatWebsite","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"address":{"type":"string"},"description":{"type":"string","nullable":true},"mapKey":{"type":"string","nullable":true,"default":"email"},"mapKeyOffline":{"type":"string","nullable":true,"default":"email"},"key":{"type":"string"},"agentAlias":{"type":"string","nullable":true,"default":"Agent"},"customerAlias":{"type":"string","nullable":true,"default":"Me"},"color":{"type":"string","default":"#011F6A"},"color_button":{"type":"string","default":"#011F6A"},"textColor":{"type":"string","default":"#ffffff"},"fontSize":{"type":"integer","format":"int32","nullable":true,"default":15},"remote":{"type":"string","nullable":true},"animation":{"type":"boolean","nullable":true,"default":true},"header_shape":{"type":"string","enum":["rounded","squared"],"nullable":true,"default":"rounded"},"header_online":{"type":"string","nullable":true,"default":"We are here!"},"start_chat_button":{"type":"string","nullable":true,"default":"Chat"},"offline_chat_button":{"type":"string","nullable":true,"default":"Send"},"header_offline":{"type":"string","nullable":true,"default":"Contact us"},"download_transcript":{"type":"boolean","nullable":true,"default":true},"timeout":{"type":"integer","format":"int32","nullable":true,"default":0},"whiteLabel":{"type":"string","nullable":true,"default":"Powered by xCALLY"},"defaultWhiteLabel":{"type":"boolean","nullable":true,"default":true},"sitepic":{"type":"string","nullable":true},"closingQuestion":{"type":"string","nullable":true,"default":"Do you want to close the interaction?"},"formSubmitSuccessMessage":{"type":"string","nullable":true,"default":"Form properly submitted"},"formSubmitFailureMessage":{"type":"string","nullable":true,"default":"Form submission error"},"noteTitle":{"type":"string","nullable":true,"default":"Note"},"placeholderMessage":{"type":"string","nullable":true,"default":"Type a message"},"closingMessage":{"type":"string","nullable":true,"default":"Thanks you for your time!"},"closingMessageButton":{"type":"string","nullable":true,"default":"Send"},"skipMessageButton":{"type":"string","nullable":true,"default":"Skip"},"conditionAgreement":{"type":"boolean","nullable":true,"default":false},"enableRating":{"type":"boolean","nullable":true,"default":false},"enableFeedback":{"type":"boolean","nullable":true,"default":false},"enableSendButton":{"type":"boolean","nullable":true,"default":false},"feedbackTitle":{"type":"string","nullable":true,"default":"Feedback"},"ratingType":{"type":"string","enum":["star","thumb"],"nullable":true,"default":"star"},"ratingStarsNumber":{"type":"integer","format":"int32","nullable":true,"default":5},"onlineForm":{"type":"string","nullable":true},"offlineForm":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"autoclose":{"type":"boolean","nullable":true,"default":true},"enableCustomerWriting":{"type":"boolean","nullable":true,"default":false},"forwardTranscript":{"type":"boolean","nullable":true,"default":false},"forwardTranscriptMessage":{"type":"string","nullable":true},"forwardOffline":{"type":"boolean","nullable":true,"default":false},"forwardOfflineAddress":{"type":"string","nullable":true},"waitingTitle":{"type":"string","nullable":true,"default":"All of our agents are busy at this time. Your chat is very important to us."},"waitingMessage":{"type":"string","nullable":true,"default":"Please hold and we will answer your request as soon as possible."},"offlineMessageSubject":{"type":"string","nullable":true,"default":"New offline message from websiteName"},"offlineMessageBody":{"type":"string","nullable":true,"default":"You received a new offline message from websiteName. Here you can find the details of the request:"},"enableUnmanagedNote":{"type":"boolean","nullable":true,"default":true},"unmanagedMessage":{"type":"string","nullable":true,"default":"Your request has not been processed."},"skipUnmanaged":{"type":"string","nullable":true,"default":"Skip"},"sendUnmanaged":{"type":"string","nullable":true,"default":"Send"},"enableCustomerAttachment":{"type":"boolean","nullable":true,"default":false},"enableCustomerCheckmarks":{"type":"boolean","nullable":true,"default":false},"agentAvatar":{"type":"string","nullable":true},"showAgentAvatar":{"type":"boolean","nullable":true,"default":false},"timezone":{"type":"string","nullable":true},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":true},"notificationShake":{"type":"boolean","nullable":true,"default":false},"hideWhenOffline":{"type":"boolean","nullable":true,"default":false},"agentIdentifier":{"type":"string","nullable":true,"default":"website_alias"},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"alignment":{"type":"string","nullable":true,"default":"bottom_right"},"verticalAlignment":{"type":"integer","format":"int32","nullable":true,"default":30},"messagesAlignment":{"type":"string","nullable":true,"default":"alternate"},"defaultTitle":{"type":"string","nullable":true},"customerAvatar":{"type":"string","nullable":true},"showCustomerAvatar":{"type":"boolean","nullable":true,"default":false},"messageFontSize":{"type":"integer","format":"int32","nullable":true,"default":12},"backgroundColor":{"type":"string","default":"#fafafa"},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"systemAlias":{"type":"string","nullable":true,"default":"System"},"systemAvatar":{"type":"string","nullable":true},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"vidaooEscalation":{"type":"boolean","nullable":true,"default":false},"vidaooApiKey":{"type":"string","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","address","mapKey","mapKeyOffline","key","agentAlias","customerAlias","color","color_button","textColor","fontSize","animation","header_shape","header_online","start_chat_button","offline_chat_button","header_offline","download_transcript","timeout","whiteLabel","defaultWhiteLabel","closingQuestion","formSubmitSuccessMessage","formSubmitFailureMessage","noteTitle","placeholderMessage","closingMessage","closingMessageButton","skipMessageButton","conditionAgreement","enableRating","enableFeedback","enableSendButton","feedbackTitle","ratingType","ratingStarsNumber","onlineForm","offlineForm","token","autoclose","enableCustomerWriting","forwardTranscript","forwardOffline","waitingTitle","waitingMessage","offlineMessageSubject","offlineMessageBody","enableUnmanagedNote","unmanagedMessage","skipUnmanaged","sendUnmanaged","enableCustomerAttachment","enableCustomerCheckmarks","showAgentAvatar","notificationTemplate","notificationSound","notificationShake","hideWhenOffline","agentIdentifier","waitForTheAssignedAgent","alignment","verticalAlignment","messagesAlignment","showCustomerAvatar","messageFontSize","backgroundColor","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","systemAlias","mandatoryDisposition","vidaooEscalation","vidaooApiKey","createdAt","updatedAt"]},"OpenchannelQueueReport":{"title":"OpenchannelQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"OpenchannelInteractionId":{"type":"integer","format":"int32","nullable":true},"OpenchannelMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"OpenchannelQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"ChatApplication":{"title":"ChatApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ChatQueueId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"ChatInteraction":{"title":"ChatInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"ratingValue":{"type":"integer","format":"int32","nullable":true},"ratingType":{"type":"string","enum":["star","thumb"],"nullable":true,"default":"star"},"ratingMessage":{"type":"string","nullable":true},"pathTranscript":{"type":"string","nullable":true},"mailTranscript":{"type":"string","nullable":true},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"browserName":{"type":"string","nullable":true},"browserVersion":{"type":"string","nullable":true},"osName":{"type":"string","nullable":true},"osVersion":{"type":"string","nullable":true},"deviceModel":{"type":"string","nullable":true},"deviceVendor":{"type":"string","nullable":true},"deviceType":{"type":"string","nullable":true},"referer":{"type":"string","nullable":true},"customerIp":{"type":"string","nullable":true},"formData":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"closeReason":{"type":"string","nullable":true},"customerPort":{"type":"string","nullable":true},"vidaooSessionId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","ratingType","lastMsgDirection","createdAt","updatedAt"]},"ChatMessage":{"title":"ChatMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"secret":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"readAt":{"type":"string","format":"date-time","nullable":true},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"ChatInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"AttachmentId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","secret","direction","createdAt","updatedAt"]},"ChatOfflineMessage":{"title":"ChatOfflineMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ContactId":{"type":"integer","format":"int32","nullable":true},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","createdAt","updatedAt"]},"ChatQueue":{"title":"ChatQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"ChatGroup":{"title":"ChatGroup","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"write":{"type":"boolean","nullable":true,"default":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","write","createdAt","updatedAt"]},"ChatProactiveAction":{"title":"ChatProactiveAction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["mouseOver","timeout"],"nullable":true,"default":"mouseOver"},"selector":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","type","createdAt","updatedAt"]},"CmCompany":{"title":"CmCompany","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"vat":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"emailDomain":{"type":"string","nullable":true},"sStreet":{"type":"string","nullable":true},"sPostalCode":{"type":"string","nullable":true},"sCity":{"type":"string","nullable":true},"sCountry":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"CmContact":{"title":"CmContact","type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"facebook":{"type":"string","nullable":true},"fb_data":{"type":"string","nullable":true},"twitter":{"type":"string","nullable":true},"skype":{"type":"string","nullable":true},"teams":{"type":"string","nullable":true},"viber":{"type":"string","nullable":true},"line":{"type":"string","nullable":true},"wechat":{"type":"string","nullable":true},"telegram":{"type":"string","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"priority":{"type":"integer","format":"int32","nullable":true,"default":2},"scheduledat":{"type":"string","format":"date-time","nullable":true,"default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time","nullable":true},"CompanyId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","firstName","priority","scheduledat","createdAt","updatedAt"]},"CmHopper":{"title":"CmHopper","type":"object","properties":{"id":{"type":"integer","format":"int32"},"phone":{"type":"string"},"active":{"type":"boolean","nullable":true,"default":false},"scheduledat":{"type":"string","format":"date-time","nullable":true,"default":"2020-12-04 20:00:00"},"countbusyretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countcongestionretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countnoanswerretry":{"type":"integer","format":"int32","nullable":true,"default":0},"callback":{"type":"boolean","nullable":true,"default":false},"callbackuniqueid":{"type":"string","nullable":true,"default":null},"callbackat":{"type":"string","format":"date-time","nullable":true},"priority":{"type":"integer","format":"int32","nullable":true,"default":2},"recallme":{"type":"boolean","nullable":true,"default":false},"ContactId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"CampaignId":{"type":"integer","format":"int32","nullable":true},"countnosuchnumberretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countdropretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countabandonedretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countmachineretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countagentrejectretry":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OwnerId":{"type":"integer","format":"int32","nullable":true}},"required":["id","phone","active","scheduledat","countbusyretry","countcongestionretry","countnoanswerretry","callback","callbackuniqueid","priority","recallme","countnosuchnumberretry","countdropretry","countabandonedretry","countmachineretry","countagentrejectretry","createdAt","updatedAt"]},"CmHopperBlack":{"title":"CmHopperBlack","type":"object","properties":{"id":{"type":"integer","format":"int32"},"phone":{"type":"string"},"ContactId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"CampaignId":{"type":"integer","format":"int32","nullable":true}},"required":["id","phone","createdAt","updatedAt"]},"CmHopperFinal":{"title":"CmHopperFinal","type":"object","properties":{"id":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32","nullable":true},"statedesc":{"type":"string","nullable":true},"scheduledat":{"type":"string","format":"date-time","nullable":true},"countbusyretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countcongestionretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countnoanswerretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countglobal":{"type":"integer","format":"int32","nullable":true,"default":0},"uniqueid":{"type":"string","nullable":true},"originatecalleridnum":{"type":"string","nullable":true},"originatecalleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"responsetime":{"type":"string","format":"date-time","nullable":true},"answertime":{"type":"string","format":"date-time","nullable":true},"droptime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"ringtime":{"type":"integer","format":"int32","nullable":true,"default":0},"holdtime":{"type":"integer","format":"int32","nullable":true,"default":0},"talktime":{"type":"integer","format":"int32","nullable":true,"default":0},"followuptime":{"type":"integer","format":"int32","nullable":true,"default":0},"dropreason":{"type":"string","nullable":true},"campaign":{"type":"string","nullable":true},"campaigntype":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"dispositionat":{"type":"string","format":"date-time","nullable":true},"amd":{"type":"boolean","nullable":true,"default":false},"fax":{"type":"boolean","nullable":true,"default":false},"blacklist":{"type":"boolean","nullable":true,"default":false},"rescheduled":{"type":"boolean","nullable":true,"default":false},"rescheduledat":{"type":"string","format":"date-time","nullable":true},"callback":{"type":"boolean","nullable":true,"default":false},"callbackuniqueid":{"type":"string","nullable":true,"default":null},"callbackat":{"type":"string","format":"date-time","nullable":true},"deleted":{"type":"string","nullable":true,"default":null},"deletedat":{"type":"string","format":"date-time","nullable":true},"recallme":{"type":"boolean","nullable":true,"default":false},"agiafterat":{"type":"string","format":"date-time","nullable":true},"countnosuchnumberretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countdropretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countabandonedretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countmachineretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countagentrejectretry":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"CampaignId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","countbusyretry","countcongestionretry","countnoanswerretry","countglobal","ringtime","holdtime","talktime","followuptime","amd","fax","blacklist","rescheduled","callback","callbackuniqueid","deleted","recallme","countnosuchnumberretry","countdropretry","countabandonedretry","countmachineretry","countagentrejectretry","createdAt","updatedAt"]},"CmHopperHistory":{"title":"CmHopperHistory","type":"object","properties":{"id":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32","nullable":true},"statedesc":{"type":"string","nullable":true},"scheduledat":{"type":"string","format":"date-time","nullable":true},"countbusyretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countcongestionretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countnoanswerretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countglobal":{"type":"integer","format":"int32","nullable":true,"default":0},"uniqueid":{"type":"string","nullable":true},"originatecalleridnum":{"type":"string","nullable":true},"originatecalleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"responsetime":{"type":"string","format":"date-time","nullable":true},"answertime":{"type":"string","format":"date-time","nullable":true},"droptime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"ringtime":{"type":"integer","format":"int32","nullable":true,"default":0},"holdtime":{"type":"integer","format":"int32","nullable":true,"default":0},"talktime":{"type":"integer","format":"int32","nullable":true,"default":0},"followuptime":{"type":"integer","format":"int32","nullable":true,"default":0},"dropreason":{"type":"string","nullable":true},"campaign":{"type":"string","nullable":true},"campaigntype":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"amd":{"type":"boolean","nullable":true,"default":false},"fax":{"type":"boolean","nullable":true,"default":false},"callback":{"type":"boolean","nullable":true,"default":false},"callbackuniqueid":{"type":"string","nullable":true,"default":null},"callbackat":{"type":"string","format":"date-time","nullable":true},"recallme":{"type":"boolean","nullable":true,"default":false},"editedat":{"type":"string","format":"date-time","nullable":true},"edited":{"type":"boolean","nullable":true,"default":false},"countnosuchnumberretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countdropretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countabandonedretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countmachineretry":{"type":"integer","format":"int32","nullable":true,"default":0},"countagentrejectretry":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"CampaignId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","countbusyretry","countcongestionretry","countnoanswerretry","countglobal","ringtime","holdtime","talktime","followuptime","amd","fax","callback","callbackuniqueid","recallme","edited","countnosuchnumberretry","countdropretry","countabandonedretry","countmachineretry","countagentrejectretry","createdAt","updatedAt"]},"ReportAgentPreview":{"title":"ReportAgentPreview","type":"object","properties":{"id":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32","nullable":true},"statedesc":{"type":"string","nullable":true},"scheduledat":{"type":"string","format":"date-time","nullable":true},"uniqueid":{"type":"string","nullable":true},"starttime":{"type":"string","format":"date-time","nullable":true},"responsetime":{"type":"string","format":"date-time","nullable":true},"ringtime":{"type":"integer","format":"int32","nullable":true,"default":0},"campaign":{"type":"string","nullable":true},"campaigntype":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","ringtime","createdAt","updatedAt"]},"CmCustomField":{"title":"CmCustomField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"alias":{"type":"string"},"type":{"type":"string"},"values":{"type":"string","nullable":true},"required":{"type":"boolean","nullable":true,"default":false},"clickToAction":{"type":"boolean","nullable":true,"default":false},"actionType":{"type":"string","enum":["voice"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","alias","type","required","clickToAction","createdAt","updatedAt"]},"Action":{"title":"Action","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"action":{"type":"string"},"data1":{"type":"string","maxLength":4096,"nullable":true},"data2":{"type":"string","maxLength":4096,"nullable":true},"data3":{"type":"string","maxLength":4096,"nullable":true},"data4":{"type":"string","maxLength":4096,"nullable":true},"data5":{"type":"string","maxLength":4096,"nullable":true},"data6":{"type":"string","nullable":true},"data7":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AutomationId":{"type":"integer","format":"int32","nullable":true},"TriggerId":{"type":"integer","format":"int32","nullable":true}},"required":["id","action","createdAt","updatedAt"]},"Automation":{"title":"Automation","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"channel":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"status":{"type":"boolean","nullable":true,"default":false},"timeout":{"type":"integer","format":"int32","nullable":true,"default":10},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","status","timeout","createdAt","updatedAt"]},"CannedAnswer":{"title":"CannedAnswer","type":"object","properties":{"id":{"type":"integer","format":"int32"},"key":{"type":"string"},"value":{"type":"string"},"description":{"type":"string","nullable":true},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","key","value","createdAt","updatedAt"]},"Disposition":{"title":"Disposition","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"level":{"type":"string","enum":["first","second","third"],"default":"first"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"FaxAccountId":{"type":"integer","format":"int32","nullable":true},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"OpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"ParentId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","level","createdAt","updatedAt"]},"Condition":{"title":"Condition","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AutomationAllId":{"type":"integer","format":"int32","nullable":true},"AutomationAnyId":{"type":"integer","format":"int32","nullable":true},"TriggerAllId":{"type":"integer","format":"int32","nullable":true},"TriggerAnyId":{"type":"integer","format":"int32","nullable":true}},"required":["id","field","operator","value","createdAt","updatedAt"]},"Interval":{"title":"Interval","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"IntervalId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"Pause":{"title":"Pause","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"Cdr":{"title":"Cdr","type":"object","properties":{"id":{"type":"integer","format":"int32"},"calldate":{"type":"string","format":"date-time","default":"1970-01-01 00:00:01"},"clid":{"type":"string","nullable":true},"src":{"type":"string","nullable":true},"dst":{"type":"string","nullable":true},"dcontext":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"dstchannel":{"type":"string","nullable":true},"lastapp":{"type":"string","nullable":true},"lastdata":{"type":"string","nullable":true},"duration":{"type":"integer","format":"int32","default":0},"billsec":{"type":"integer","format":"int32","default":0},"disposition":{"type":"string","nullable":true},"amaflags":{"type":"integer","format":"int32","default":0},"accountcode":{"type":"string","nullable":true},"userfield":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"linkedid":{"type":"string","nullable":true},"sequence":{"type":"string","nullable":true},"peeraccount":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"tag":{"type":"string","nullable":true}},"required":["id","calldate","duration","billsec","amaflags"]},"VoiceQueuesLog":{"title":"VoiceQueuesLog","type":"object","properties":{"id":{"type":"integer","format":"int32"},"time":{"type":"string","nullable":true},"callid":{"type":"string","default":""},"queuename":{"type":"string","default":""},"agent":{"type":"string","default":""},"event":{"type":"string","default":""},"data":{"type":"string","default":""},"data1":{"type":"string","default":""},"data2":{"type":"string","default":""},"data3":{"type":"string","default":""},"data4":{"type":"string","default":""},"data5":{"type":"string","default":""},"dtm":{"type":"string","format":"date-time","default":"2020-12-04 20:00:00"}},"required":["id","callid","queuename","agent","event","data","data1","data2","data3","data4","data5","dtm"]},"Schedule":{"title":"Schedule","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"active":{"type":"boolean","default":false},"cron":{"type":"string","default":"0 0 * * *"},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"subtractNumber":{"type":"integer","format":"int32","default":1},"subtractUnit":{"type":"string","enum":["years","quarters","months","weeks","days","hours","minutes"],"default":"days"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"type":{"type":"string","enum":["custom","default"],"default":"custom"},"sendMail":{"type":"boolean","nullable":true,"default":false},"email":{"type":"string","nullable":true},"cc":{"type":"string","nullable":true},"bcc":{"type":"string","nullable":true},"sendIfEmpty":{"type":"boolean","nullable":true,"default":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailAccountId":{"type":"integer","format":"int32","nullable":true},"DefaultReportId":{"type":"integer","format":"int32","nullable":true},"CustomReportId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","active","cron","startAt","endAt","subtractNumber","subtractUnit","output","type","sendMail","sendIfEmpty","createdAt","updatedAt"]},"Sound":{"title":"Sound","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"save_name":{"type":"string","nullable":true},"display_name":{"type":"string","nullable":true,"default":""},"description":{"type":"string","nullable":true},"original_format":{"type":"string","nullable":true},"original_duration":{"type":"number","format":"float","nullable":true},"original_sampleCount":{"type":"integer","format":"int64","nullable":true},"original_channelCount":{"type":"integer","format":"int32","nullable":true},"original_bitRate":{"type":"integer","format":"int64","nullable":true},"original_sampleRate":{"type":"integer","format":"int32","nullable":true},"converted_format":{"type":"string","nullable":true},"converted_duration":{"type":"number","format":"float","nullable":true},"converted_sampleCount":{"type":"integer","format":"int64","nullable":true},"converted_channelCount":{"type":"integer","format":"int32","nullable":true},"converted_bitRate":{"type":"integer","format":"int64","nullable":true},"converted_sampleRate":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","display_name","createdAt","updatedAt"]},"Tag":{"title":"Tag","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"color":{"type":"string","nullable":true,"default":"#0091EA"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","color","createdAt","updatedAt"]},"Template":{"title":"Template","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"Trigger":{"title":"Trigger","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"status":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","status","createdAt","updatedAt"]},"Variable":{"title":"Variable","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"Integration":{"title":"Integration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"version":{"type":"string"},"main":{"type":"string","nullable":true,"default":"app.js"},"filename":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"size":{"type":"integer","format":"int32","nullable":true},"active":{"type":"boolean","nullable":true,"default":false},"author":{"type":"string","nullable":true},"logo":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"link":{"type":"string","nullable":true,"default":"#"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","version","main","active","link","createdAt","updatedAt"]},"IntegrationReport":{"title":"IntegrationReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"integration":{"type":"string","nullable":true},"eventChannel":{"type":"string","nullable":true},"exitStatus":{"type":"string","nullable":true},"ticketId":{"type":"string","nullable":true},"integrationId":{"type":"integer","format":"int32","nullable":true},"contacts":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"interface":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"agentcalledAt":{"type":"string","format":"date-time","nullable":true},"agentconnectAt":{"type":"string","format":"date-time","nullable":true},"holdtime":{"type":"integer","format":"int32","nullable":true},"agentcomplete":{"type":"boolean","nullable":true,"default":false},"agentcompleteAt":{"type":"string","format":"date-time","nullable":true},"talktime":{"type":"integer","format":"int32","nullable":true},"agentacw":{"type":"boolean","nullable":true,"default":false},"acwtime":{"type":"integer","format":"int32","nullable":true},"reason":{"type":"string","nullable":true},"agentringnoanswer":{"type":"boolean","nullable":true,"default":false},"agentringnoanswerAt":{"type":"string","format":"date-time","nullable":true},"agentdump":{"type":"boolean","nullable":true,"default":false},"agentdumpAt":{"type":"string","format":"date-time","nullable":true},"lastevent":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"channelstate":{"type":"integer","format":"int32","nullable":true},"channelstatedesc":{"type":"string","nullable":true},"connectedlinenum":{"type":"string","nullable":true},"connectedlinename":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"exten":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"destchannel":{"type":"string","nullable":true},"destchannelstate":{"type":"integer","format":"int32","nullable":true},"destchannelstatedesc":{"type":"string","nullable":true},"destcalleridnum":{"type":"string","nullable":true},"destcalleridname":{"type":"string","nullable":true},"destconnectedlinenum":{"type":"string","nullable":true},"destconnectedlinename":{"type":"string","nullable":true},"destlanguage":{"type":"string","nullable":true},"destaccountcode":{"type":"string","nullable":true},"destcontext":{"type":"string","nullable":true},"destexten":{"type":"string","nullable":true},"destpriority":{"type":"string","nullable":true},"destuniqueid":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true},"inReplyTo":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true},"cc":{"type":"string","nullable":true},"attachment":{"type":"string","nullable":true},"html":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"status":{"type":"string","enum":["SENT","SENDING","RECEIVED","FAILED"],"nullable":true},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appdata":{"type":"string","nullable":true},"projectId":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","agentcomplete","agentacw","agentringnoanswer","agentdump","createdAt","updatedAt"]},"AnalyticCustomReport":{"title":"AnalyticCustomReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"parent":{"type":"string","nullable":true},"table":{"type":"string","nullable":true},"conditions":{"type":"string","nullable":true},"joins":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time","nullable":true}},"required":["id","name","createdAt","updatedAt"]},"AnalyticDefaultReport":{"title":"AnalyticDefaultReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"parent":{"type":"string","nullable":true},"table":{"type":"string","nullable":true},"conditions":{"type":"string","nullable":true},"joins":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"AnalyticExtractedReport":{"title":"AnalyticExtractedReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"basename":{"type":"string"},"output":{"type":"string","enum":["csv","pdf","xlsx"],"default":"csv"},"savename":{"type":"string"},"startDate":{"type":"string","format":"date-time","nullable":true},"endDate":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true,"default":"Loading"},"type":{"type":"string","enum":["manual","scheduled"],"default":"manual"},"reportId":{"type":"integer","format":"int32","nullable":true},"reportType":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","basename","output","savename","status","type","createdAt","updatedAt"]},"AnalyticMetric":{"title":"AnalyticMetric","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"table":{"type":"string","nullable":true},"metric":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"AnalyticFieldReport":{"title":"AnalyticFieldReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"field":{"type":"string","nullable":true},"alias":{"type":"string","nullable":true},"function":{"type":"string","nullable":true},"format":{"type":"string","nullable":true},"groupBy":{"type":"boolean","nullable":true,"default":false},"orderBy":{"type":"string","nullable":true},"custom":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"CustomReportId":{"type":"integer","format":"int32","nullable":true},"DefaultReportId":{"type":"integer","format":"int32","nullable":true},"MetricId":{"type":"integer","format":"int32","nullable":true}},"required":["id","groupBy","custom","createdAt","updatedAt"]},"AnalyticTreeReport":{"title":"AnalyticTreeReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"tree":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tree","createdAt","updatedAt"]},"SalesforceAccount":{"title":"SalesforceAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true},"clientSecret":{"type":"string","nullable":true},"securityToken":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"type":{"type":"string","enum":["integrationTab","newTab"],"nullable":true,"default":"integrationTab"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","createdAt","updatedAt"]},"SalesforceConfiguration":{"title":"SalesforceConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"ticketType":{"type":"string","enum":["Task","Case"],"nullable":true,"default":"Task"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"nullable":true,"default":"contact_lead"},"moduleCreate":{"type":"string","enum":["nothing","contact","lead"],"nullable":true,"default":"lead"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","ticketType","moduleSearch","moduleCreate","createdAt","updatedAt"]},"SalesforceField":{"title":"SalesforceField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","createdAt","updatedAt"]},"SugarcrmAccount":{"title":"SugarcrmAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"SugarcrmConfiguration":{"title":"SugarcrmConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"SugarcrmField":{"title":"SugarcrmField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"DeskAccount":{"title":"DeskAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"authType":{"type":"string","enum":["basic"],"nullable":true,"default":"basic"},"password":{"type":"string","nullable":true},"consumerKey":{"type":"string","nullable":true},"consumerSecret":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"tokenSecret":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"type":{"type":"string","enum":["integrationTab","newTab"],"nullable":true,"default":"integrationTab"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","authType","type","createdAt","updatedAt"]},"DeskConfiguration":{"title":"DeskConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"DeskField":{"title":"DeskField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"ZohoAccount":{"title":"ZohoAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"host":{"type":"string","nullable":true},"zone":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true},"clientSecret":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"refreshToken":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"ZohoConfiguration":{"title":"ZohoConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"moduleCreate":{"type":"string","enum":["lead","contact","nothing"],"nullable":true,"default":"lead"},"moduleSearch":{"type":"string","enum":["contact_lead","contact","lead"],"nullable":true,"default":"contact_lead"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","moduleCreate","moduleSearch","createdAt","updatedAt"]},"ZohoField":{"title":"ZohoField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"ZendeskAccount":{"title":"ZendeskAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"authType":{"type":"string","enum":["password","token"],"nullable":true,"default":"password"},"serverUrl":{"type":"string","nullable":true},"type":{"type":"string","enum":["integrationTab","newTab"],"nullable":true,"default":"integrationTab"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","authType","type","createdAt","updatedAt"]},"ZendeskConfiguration":{"title":"ZendeskConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"ZendeskField":{"title":"ZendeskField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"FreshdeskAccount":{"title":"FreshdeskAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"apiKey":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"FreshdeskConfiguration":{"title":"FreshdeskConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"FreshdeskField":{"title":"FreshdeskField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"VtigerAccount":{"title":"VtigerAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"username":{"type":"string"},"moduleName":{"type":"string","default":"HelpDesk"},"remoteUri":{"type":"string"},"serverUrl":{"type":"string","nullable":true},"accessKey":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","username","moduleName","remoteUri","accessKey","createdAt","updatedAt"]},"VtigerConfiguration":{"title":"VtigerConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"VtigerField":{"title":"VtigerField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"ServicenowAccount":{"title":"ServicenowAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"ServicenowConfiguration":{"title":"ServicenowConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"ServicenowField":{"title":"ServicenowField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"Dynamics365Account":{"title":"Dynamics365Account","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"tenantId":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true},"clientSecret":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"Dynamics365Configuration":{"title":"Dynamics365Configuration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"ticketType":{"type":"string","enum":["incident","phonecall"],"nullable":true,"default":"incident"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","ticketType","createdAt","updatedAt"]},"Dynamics365Field":{"title":"Dynamics365Field","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"FreshsalesAccount":{"title":"FreshsalesAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"apiKey":{"type":"string","nullable":true},"remoteUri":{"type":"string","nullable":true},"serverUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"FreshsalesConfiguration":{"title":"FreshsalesConfiguration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"AccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"FreshsalesField":{"title":"FreshsalesField","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["string","variable","customVariable","keyValue"],"nullable":true,"default":"string"},"content":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"keyType":{"type":"string","enum":["string","variable","customVariable"],"nullable":true},"keyContent":{"type":"string","nullable":true},"idField":{"type":"string","nullable":true},"nameField":{"type":"string","nullable":true},"customField":{"type":"boolean","nullable":true,"default":true},"variableName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SubjectId":{"type":"integer","format":"int32","nullable":true},"DescriptionId":{"type":"integer","format":"int32","nullable":true},"FieldId":{"type":"integer","format":"int32","nullable":true},"VariableId":{"type":"integer","format":"int32","nullable":true}},"required":["id","type","customField","createdAt","updatedAt"]},"Network":{"title":"Network","type":"object","properties":{"id":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["localnet","externip","stun","turn"],"nullable":true},"value":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"ChatQueueReport":{"title":"ChatQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"ChatInteractionId":{"type":"integer","format":"int32","nullable":true},"ChatMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ChatQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"ChatInternalMessage":{"title":"ChatInternalMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"ChatInternalMessageId":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatGroupId":{"type":"integer","format":"int32","nullable":true},"FromId":{"type":"integer","format":"int32","nullable":true},"ToId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","createdAt","updatedAt"]},"JscriptyAnswerReport":{"title":"JscriptyAnswerReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"question":{"type":"string","nullable":true},"answer":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"projectname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"questionId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SessionId":{"type":"integer","format":"int32","nullable":true},"ProjectId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"JscriptyQuestionReport":{"title":"JscriptyQuestionReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"question":{"type":"string","nullable":true},"answer":{"type":"string","nullable":true},"membername":{"type":"string","nullable":true},"projectname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"questionId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SessionId":{"type":"integer","format":"int32","nullable":true},"ProjectId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"JscriptySessionReport":{"title":"JscriptySessionReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"starttime":{"type":"string","format":"date-time","nullable":true},"endtime":{"type":"string","format":"date-time","nullable":true},"membername":{"type":"string","nullable":true},"projectname":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"calleridnum":{"type":"string","nullable":true},"completed":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"VoiceQueueId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"ProjectId":{"type":"integer","format":"int32","nullable":true}},"required":["id","completed","createdAt","updatedAt"]},"SmsQueueReport":{"title":"SmsQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SmsAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"SmsInteractionId":{"type":"integer","format":"int32","nullable":true},"SmsMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"SmsQueueId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"SquareReport":{"title":"SquareReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"network":{"type":"string","nullable":true},"network_script":{"type":"string","nullable":true},"request":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"uniqueid":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"callingpres":{"type":"string","nullable":true},"callingani2":{"type":"string","nullable":true},"callington":{"type":"string","nullable":true},"callingtns":{"type":"string","nullable":true},"dnid":{"type":"string","nullable":true},"rdnis":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"extension":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"enhanced":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"threadid":{"type":"string","nullable":true},"project_name":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"bot":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","bot","createdAt","updatedAt"]},"SquareDetailsReport":{"title":"SquareDetailsReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string","nullable":true},"node":{"type":"string","nullable":true},"application":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"project_name":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"JscriptyProject":{"title":"JscriptyProject","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"formData":{"type":"string","nullable":true},"enableUncompleteSave":{"type":"boolean","nullable":true,"default":true},"sendUnpauseOnSubmit":{"type":"boolean","nullable":true,"default":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","enableUncompleteSave","sendUnpauseOnSubmit","createdAt","updatedAt"]},"Setting":{"title":"Setting","type":"object","properties":{"id":{"type":"integer","format":"int32"},"min_internal":{"type":"integer","format":"int32","nullable":true,"default":1000},"min_mailbox":{"type":"integer","format":"int32","nullable":true,"default":1000},"agi_port":{"type":"integer","format":"int32","nullable":true,"default":4573},"soundPath":{"type":"string","nullable":true,"default":"/var/opt/motion2/server/files/sounds/converted"},"logo":{"type":"string","nullable":true},"defaultLogo":{"type":"boolean","nullable":true,"default":true},"loginLogo":{"type":"string","nullable":true},"defaultLoginLogo":{"type":"boolean","nullable":true,"default":true},"headerWhiteLabel":{"type":"string","nullable":true},"defaultHeaderWhiteLabel":{"type":"boolean","nullable":true,"default":true},"securePassword":{"type":"boolean","nullable":true,"default":true},"firstSetup":{"type":"boolean","nullable":true,"default":true},"stunaddr":{"type":"string","nullable":true},"turnaddr":{"type":"string","nullable":true},"turnusername":{"type":"string","nullable":true},"turnpassword":{"type":"string","nullable":true},"pageTitle":{"type":"string","nullable":true},"defaultPageTitle":{"type":"boolean","nullable":true,"default":true},"callRecordingEncryption":{"type":"boolean","nullable":true,"default":false},"passwordExpiresDays":{"type":"integer","format":"int32","nullable":true,"default":90},"phoneBarAutoUpdater":{"type":"boolean","nullable":true,"default":true},"phoneBarAutoUpdaterUrl":{"type":"string","nullable":true,"default":"https://www.xcally.com/bar/phonebar/autoupdater.xml"},"enableEmailPreview":{"type":"boolean","nullable":true,"default":false},"split":{"type":"boolean","nullable":true,"default":true},"splitSizeCsv":{"type":"integer","format":"int32","nullable":true,"default":5000},"splitSizePdf":{"type":"integer","format":"int32","nullable":true,"default":5000},"splitSizeXlsx":{"type":"integer","format":"int32","nullable":true,"default":5000},"messagesAlignment":{"type":"string","nullable":true,"default":"alternate"},"chatTimeout":{"type":"integer","format":"int32","nullable":true,"default":30},"phoneBarRememberMeEnabled":{"type":"boolean","nullable":true,"default":true},"preferred":{"type":"string","nullable":true},"defaultPreferred":{"type":"boolean","nullable":true,"default":true},"rtlSupport":{"type":"boolean","nullable":true,"default":false},"defaultScreenRecordingPath":{"type":"string","nullable":true},"allowedLoginAttempts":{"type":"integer","format":"int32","nullable":true,"default":5},"blockDuration":{"type":"integer","format":"int32","nullable":true,"default":10},"favicon":{"type":"string","nullable":true},"defaultFavicon":{"type":"boolean","nullable":true,"default":true},"loginMailFrequency":{"type":"integer","format":"int32","nullable":true,"default":10},"transcribe":{"type":"boolean","nullable":true,"default":false},"automaticTranscribe":{"type":"boolean","nullable":true,"default":false},"transcribeAccountId":{"type":"integer","format":"int32","nullable":true},"transcribeRegion":{"type":"string","nullable":true},"sentiment":{"type":"boolean","nullable":true,"default":false},"automaticSentiment":{"type":"boolean","nullable":true,"default":false},"sentimentAccountId":{"type":"integer","format":"int32","nullable":true},"sentimentRegion":{"type":"string","nullable":true},"language":{"type":"string","nullable":true},"bucket":{"type":"string","nullable":true},"googleSsoEnabled":{"type":"boolean","nullable":true,"default":false},"enforcePasswordHistory":{"type":"boolean","nullable":true,"default":true},"passwordHistoryLimit":{"type":"integer","format":"int32","nullable":true,"default":3},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","min_internal","min_mailbox","agi_port","soundPath","defaultLogo","defaultLoginLogo","defaultHeaderWhiteLabel","securePassword","firstSetup","defaultPageTitle","callRecordingEncryption","passwordExpiresDays","phoneBarAutoUpdater","phoneBarAutoUpdaterUrl","enableEmailPreview","split","splitSizeCsv","splitSizePdf","splitSizeXlsx","messagesAlignment","chatTimeout","phoneBarRememberMeEnabled","defaultPreferred","rtlSupport","allowedLoginAttempts","blockDuration","defaultFavicon","loginMailFrequency","transcribe","automaticTranscribe","sentiment","automaticSentiment","googleSsoEnabled","enforcePasswordHistory","passwordHistoryLimit","createdAt","updatedAt"]},"SquareOdbc":{"title":"SquareOdbc","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"dsn":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"SquareProject":{"title":"SquareProject","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"preproduction":{"type":"string","format":"byte","nullable":true},"production":{"type":"string","format":"byte","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"SquareRecording":{"title":"SquareRecording","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"calleridname":{"type":"string","nullable":true},"context":{"type":"string","nullable":true},"extension":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"accountcode":{"type":"string","nullable":true},"dnid":{"type":"string","nullable":true},"projectName":{"type":"string","nullable":true},"saveName":{"type":"string","nullable":true},"filename":{"type":"string","nullable":true},"savePath":{"type":"string","nullable":true},"format":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"SquareMessage":{"title":"SquareMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string","nullable":true},"body":{"type":"string"},"direction":{"type":"string","enum":["in","out"],"default":"out"},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","body","direction","createdAt","updatedAt"]},"Team":{"title":"Team","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"License":{"title":"License","type":"object","properties":{"id":{"type":"integer","format":"int32"},"license":{"type":"string","nullable":true},"data1":{"type":"string","nullable":true},"data2":{"type":"string","nullable":true},"chatLicenseExceeded":{"type":"integer","format":"int32","nullable":true,"default":0},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","chatLicenseExceeded","createdAt","updatedAt"]},"Campaign":{"title":"Campaign","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["ivr"],"default":"ivr"},"description":{"type":"string","nullable":true},"active":{"type":"boolean","nullable":true,"default":0},"limitCalls":{"type":"integer","format":"int32","nullable":true,"default":30},"dialOriginateCallerIdName":{"type":"string","nullable":true},"dialOriginateCallerIdNumber":{"type":"string","nullable":true},"dialOriginateTimeout":{"type":"integer","format":"int32","nullable":true,"default":30},"dialCongestionMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialCongestionRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialBusyMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialBusyRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialNoAnswerMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialNoAnswerRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialGlobalMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":4},"dialTimezone":{"type":"string","nullable":true,"default":null},"dialGlobalInterval":{"type":"string","nullable":true,"default":"07:00-22:00,*,*,*"},"dialCheckDuplicateType":{"type":"string","enum":["always","never","onlyIfOpen"],"nullable":true,"default":"always"},"dialAMDActive":{"type":"boolean","nullable":true,"default":0},"dialAMDInitialSilence":{"type":"integer","format":"int32","nullable":true,"default":2500},"dialAMDGreeting":{"type":"integer","format":"int32","nullable":true,"default":1500},"dialAMDAfterGreetingSilence":{"type":"integer","format":"int32","nullable":true,"default":800},"dialAMDTotalAnalysisTime":{"type":"integer","format":"int32","nullable":true,"default":5000},"dialAMDMinWordLength":{"type":"integer","format":"int32","nullable":true,"default":100},"dialAMDBetweenWordsSilence":{"type":"integer","format":"int32","nullable":true,"default":50},"dialAMDMaximumNumberOfWords":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAMDSilenceThreshold":{"type":"integer","format":"int32","nullable":true,"default":256},"dialAMDMaximumWordLength":{"type":"integer","format":"int32","nullable":true,"default":5000},"dialOrderByScheduledAt":{"type":"string","enum":["DESC","ASC"],"nullable":true,"default":"DESC"},"dialPrefix":{"type":"string","nullable":true,"default":null},"dialRandomLastDigitCallerIdNumber":{"type":"integer","format":"int32","nullable":true,"default":0},"dialCutDigit":{"type":"integer","format":"int32","nullable":true,"default":0},"dialNoSuchNumberMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialNoSuchNumberRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialDropMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialDropRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialAbandonedMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAbandonedRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialMachineMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialMachineRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"dialAgentRejectMaxRetry":{"type":"integer","format":"int32","nullable":true,"default":3},"dialAgentRejectRetryFrequency":{"type":"integer","format":"int32","nullable":true,"default":150},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"TrunkId":{"type":"integer","format":"int32","nullable":true},"TrunkBackupId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"SquareProjectId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","type","active","limitCalls","dialOriginateTimeout","dialCongestionMaxRetry","dialCongestionRetryFrequency","dialBusyMaxRetry","dialBusyRetryFrequency","dialNoAnswerMaxRetry","dialNoAnswerRetryFrequency","dialGlobalMaxRetry","dialTimezone","dialGlobalInterval","dialCheckDuplicateType","dialAMDActive","dialAMDInitialSilence","dialAMDGreeting","dialAMDAfterGreetingSilence","dialAMDTotalAnalysisTime","dialAMDMinWordLength","dialAMDBetweenWordsSilence","dialAMDMaximumNumberOfWords","dialAMDSilenceThreshold","dialAMDMaximumWordLength","dialOrderByScheduledAt","dialPrefix","dialRandomLastDigitCallerIdNumber","dialCutDigit","dialNoSuchNumberMaxRetry","dialNoSuchNumberRetryFrequency","dialDropMaxRetry","dialDropRetryFrequency","dialAbandonedMaxRetry","dialAbandonedRetryFrequency","dialMachineMaxRetry","dialMachineRetryFrequency","dialAgentRejectMaxRetry","dialAgentRejectRetryFrequency","createdAt","updatedAt"]},"Migration":{"title":"Migration","type":"object","properties":{"id":{"type":"integer","format":"int32"},"version":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"Attachment":{"title":"Attachment","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"basename":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailMessageId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"Plugin":{"title":"Plugin","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["html","script"],"nullable":true},"description":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"active":{"type":"boolean","nullable":true,"default":0},"sidebar":{"type":"string","enum":["adminOnly","agentOnly","always","never"],"nullable":true,"default":"always"},"icon":{"type":"string","nullable":true},"adminUrl":{"type":"string","nullable":true},"agentUrl":{"type":"string","nullable":true},"scriptName":{"type":"string","nullable":true},"scriptPath":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","active","sidebar","createdAt","updatedAt"]},"MailTransferReport":{"title":"MailTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"MailMessageId":{"type":"integer","format":"int32","nullable":true},"MailInteractionId":{"type":"integer","format":"int32","nullable":true},"FromMailAccountId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToMailQueueId":{"type":"integer","format":"int32","nullable":true},"ToMailAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"ChatTransferReport":{"title":"ChatTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ChatMessageId":{"type":"integer","format":"int32","nullable":true},"ChatInteractionId":{"type":"integer","format":"int32","nullable":true},"FromChatWebsiteId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToChatQueueId":{"type":"integer","format":"int32","nullable":true},"ToChatWebsiteId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"FaxTransferReport":{"title":"FaxTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"FaxMessageId":{"type":"integer","format":"int32","nullable":true},"FaxInteractionId":{"type":"integer","format":"int32","nullable":true},"FromFaxAccountId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToFaxQueueId":{"type":"integer","format":"int32","nullable":true},"ToFaxAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"OpenchannelTransferReport":{"title":"OpenchannelTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"OpenchannelMessageId":{"type":"integer","format":"int32","nullable":true},"OpenchannelInteractionId":{"type":"integer","format":"int32","nullable":true},"FromOpenchannelAccountId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToOpenchannelQueueId":{"type":"integer","format":"int32","nullable":true},"ToOpenchannelAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"SmsTransferReport":{"title":"SmsTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"],"default":"queue"},"transferredAt":{"type":"string","format":"date-time","default":{}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SmsMessageId":{"type":"integer","format":"int32","nullable":true},"SmsInteractionId":{"type":"integer","format":"int32","nullable":true},"FromSmsAccountId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true},"ToSmsQueueId":{"type":"integer","format":"int32","nullable":true},"ToSmsAccountId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","transferredAt","createdAt","updatedAt"]},"CmList":{"title":"CmList","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"dialPrefix":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"VoicePrefix":{"title":"VoicePrefix","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"prefix":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"description":{"type":"string","nullable":true},"callerIdAll":{"type":"string","nullable":true},"VoiceExtensionId":{"type":"integer","format":"int32","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"]},"UserProfile":{"title":"UserProfile","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"crudPermissions":{"type":"string","default":"r"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","crudPermissions","createdAt","updatedAt"]},"UserProfileSection":{"title":"UserProfileSection","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"category":{"type":"string"},"sectionId":{"type":"integer","format":"int32"},"enabled":{"type":"boolean","nullable":true,"default":null},"autoAssociation":{"type":"boolean","nullable":true,"default":null},"crudPermissions":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userProfileId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","category","sectionId","enabled","autoAssociation","createdAt","updatedAt"]},"UserProfileResource":{"title":"UserProfileResource","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"resourceId":{"type":"integer","format":"int32"},"type":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"sectionId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","resourceId","type","createdAt","updatedAt"]},"Notification":{"title":"Notification","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string","nullable":true},"senderName":{"type":"string","nullable":true},"recipientsId":{"type":"string","nullable":true},"recipientsDescription":{"type":"string","nullable":true},"beep":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"SenderId":{"type":"integer","format":"int32","nullable":true}},"required":["id","createdAt","updatedAt"]},"WhatsappAccount":{"title":"WhatsappAccount","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"key":{"type":"string"},"remote":{"type":"string"},"token":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"type":{"type":"string","enum":["twilio"],"nullable":true},"accountSid":{"type":"string","nullable":true},"authToken":{"type":"string","nullable":true},"notificationTemplate":{"type":"string","nullable":true},"notificationSound":{"type":"boolean","nullable":true,"default":false},"notificationShake":{"type":"boolean","nullable":true,"default":false},"waitForTheAssignedAgent":{"type":"integer","format":"int32","nullable":true,"default":10},"queueTransfer":{"type":"boolean","nullable":true,"default":false},"queueTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"agentTransfer":{"type":"boolean","nullable":true,"default":false},"agentTransferTimeout":{"type":"integer","format":"int32","nullable":true,"default":300},"mandatoryDispositionPauseId":{"type":"integer","format":"int32","nullable":true},"mandatoryDisposition":{"type":"boolean","nullable":true,"default":false},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"ListId":{"type":"integer","format":"int32","nullable":true}},"required":["id","name","key","remote","token","notificationTemplate","notificationSound","notificationShake","waitForTheAssignedAgent","queueTransfer","queueTransferTimeout","agentTransfer","agentTransferTimeout","mandatoryDisposition","createdAt","updatedAt"]},"WhatsappApplication":{"title":"WhatsappApplication","type":"object","properties":{"id":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"app":{"type":"string","default":"noop"},"appdata":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"interval":{"type":"string","nullable":true,"default":"*,*,*,*"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"WhatsappQueueId":{"type":"integer","format":"int32","nullable":true},"IntervalId":{"type":"integer","format":"int32","nullable":true},"TagId":{"type":"integer","format":"int32","nullable":true}},"required":["id","priority","app","interval","createdAt","updatedAt"]},"WhatsappInteraction":{"title":"WhatsappInteraction","type":"object","properties":{"id":{"type":"integer","format":"int32"},"closed":{"type":"boolean","nullable":true,"default":false},"closedAt":{"type":"string","format":"date-time","nullable":true},"disposition":{"type":"string","nullable":true},"secondDisposition":{"type":"string","nullable":true},"thirdDisposition":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"read1stAt":{"type":"string","format":"date-time","nullable":true},"firstMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"lastMsgAt":{"type":"string","format":"date-time","nullable":true},"lastMsgDirection":{"type":"string","enum":["in","out"],"default":"in"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"UserId":{"type":"integer","format":"int32","nullable":true},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","closed","firstMsgDirection","lastMsgDirection","createdAt","updatedAt"]},"WhatsappMessage":{"title":"WhatsappMessage","type":"object","properties":{"id":{"type":"integer","format":"int32"},"body":{"type":"string"},"read":{"type":"boolean","nullable":true,"default":false},"direction":{"type":"string","enum":["in","out"],"default":"out"},"messageId":{"type":"string","maxLength":190,"nullable":true},"phone":{"type":"string","nullable":true},"readAt":{"type":"string","format":"date-time","nullable":true},"secret":{"type":"boolean","nullable":true,"default":false},"providerName":{"type":"string","nullable":true},"providerResponse":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"WhatsappInteractionId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true}},"required":["id","body","read","direction","secret","createdAt","updatedAt"]},"WhatsappQueueReport":{"title":"WhatsappQueueReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"from":{"type":"string","nullable":true},"joinAt":{"type":"string","format":"date-time","nullable":true},"leaveAt":{"type":"string","format":"date-time","nullable":true},"acceptAt":{"type":"string","format":"date-time","nullable":true},"exitAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"WhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"ListId":{"type":"integer","format":"int32","nullable":true},"ContactId":{"type":"integer","format":"int32","nullable":true},"WhatsappInteractionId":{"type":"integer","format":"int32","nullable":true},"WhatsappQueueId":{"type":"integer","format":"int32","nullable":true},"WhatsappMessageId":{"type":"integer","format":"int32","nullable":true},"UserId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","createdAt","updatedAt"]},"WhatsappTransferReport":{"title":"WhatsappTransferReport","type":"object","properties":{"id":{"type":"integer","format":"int32"},"uniqueid":{"type":"string"},"type":{"type":"string","enum":["account","agent","queue"]},"transferredAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"WhatsappMessageId":{"type":"integer","format":"int32","nullable":true},"WhatsappInteractionId":{"type":"integer","format":"int32","nullable":true},"FromWhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"ToWhatsappAccountId":{"type":"integer","format":"int32","nullable":true},"ToQueueId":{"type":"integer","format":"int32","nullable":true},"FromUserId":{"type":"integer","format":"int32","nullable":true},"ToUserId":{"type":"integer","format":"int32","nullable":true}},"required":["id","uniqueid","type","createdAt","updatedAt"]},"WhatsappQueue":{"title":"WhatsappQueue","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"timeout":{"type":"integer","format":"int32","nullable":true},"strategy":{"type":"string","enum":["rrmemory","beepall","roundrobin"],"nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"CloudProvider":{"title":"CloudProvider","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"service":{"type":"string","enum":["AmazonAWS","Google"]},"data1":{"type":"string","nullable":true},"data2":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","service","createdAt","updatedAt"]}}},"tags":[]}
git://repos.xcallymotion.com / motion-next.git / blobdiff