{ "x-generator": "NSwag v13.17.0.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v13.0.0.0))", "swagger": "2.0", "info": { "title": "GoFax", "description": "Restful API", "version": "2.0" }, "host": "restful-api.gofax.com.au", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v2.0/Account/Token": { "post": { "tags": [ "AccountV2" ], "operationId": "AccountV2_GetToken", "parameters": [ { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/AuthenticationRequestModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/TokenResult" } } } }, "put": { "tags": [ "AccountV2" ], "operationId": "AccountV2_PutToken", "parameters": [ { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/TokenRequestModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/TokenResult" } } } } }, "/v2.0/Account/CheckHaveAccess": { "put": { "tags": [ "AccountV2" ], "operationId": "AccountV2_CheckHaveAccess", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/TokenResult" } } } } }, "/v2.0/Account/CreditBalance": { "get": { "tags": [ "AccountV2" ], "operationId": "AccountV2_CreditBalance", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/DecimalResult" } } } } }, "/v2.0/Account/PreferredCSID": { "put": { "tags": [ "AccountV2" ], "operationId": "AccountV2_PutPreferredFaxNumber", "parameters": [ { "type": "string", "name": "receiveNumber", "in": "query", "required": true, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/DecimalResult" } } } } }, "/v2.0/Account/Details": { "put": { "tags": [ "AccountV2" ], "operationId": "AccountV2_PutDetails", "parameters": [ { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/ClientRequestModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ClientDetailResult" } } } }, "get": { "tags": [ "AccountV2" ], "operationId": "AccountV2_GetDetails", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ClientDetailResult" } } } } }, "/v1.0/Account/Token": { "get": { "tags": [ "AccountV1" ], "operationId": "AccountV1_GetTokenGET", "parameters": [ { "type": "string", "name": "username", "in": "query", "required": true, "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "required": true, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/TokenResult" } } } }, "put": { "tags": [ "AccountV1" ], "operationId": "AccountV1_PutToken", "parameters": [ { "type": "string", "name": "username", "in": "query", "required": true, "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "required": true, "x-nullable": true }, { "type": "string", "name": "expires", "in": "query", "format": "date-time", "x-nullable": true }, { "type": "string", "name": "computer", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/TokenResult" } } } } }, "/v1.1/Account/Token": { "post": { "tags": [ "AccountV1" ], "operationId": "AccountV1_GetTokenPOST", "parameters": [ { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/AuthenticationRequestModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/TokenResult" } } } }, "put": { "tags": [ "AccountV1" ], "operationId": "AccountV1_PutToken2", "parameters": [ { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/TokenRequestModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/TokenResult" } } } } }, "/v1.0/Account/CheckHaveAccess": { "put": { "tags": [ "AccountV1" ], "operationId": "AccountV1_CheckHaveAccess", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/TokenResult" } } } } }, "/v1.0/Account/CreditBalance": { "get": { "tags": [ "AccountV1" ], "operationId": "AccountV1_CreditBalance", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/DecimalResult" } } } } }, "/v1.0/Account/PreferredCSID": { "put": { "tags": [ "AccountV1" ], "operationId": "AccountV1_PutPreferredFaxNumber", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "string", "name": "receiveNumber", "in": "query", "required": true, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/DecimalResult" } } } } }, "/v1.0/Account/Details": { "put": { "tags": [ "AccountV1" ], "operationId": "AccountV1_PutDetails", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/ClientRequestModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ClientDetailResult" } } } }, "get": { "tags": [ "AccountV1" ], "operationId": "AccountV1_GetDetails", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ClientDetailResult" } } } } }, "/v2.0/ReceiveFaxes/Details/{number}": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_GetDetailsByLimit", "parameters": [ { "type": "integer", "name": "number", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } }, "deprecated": true } }, "/v2.0/ReceiveFaxes/Details": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_GetDetails", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } }, "deprecated": true } }, "/v2.0/ReceiveFaxes/Detail": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_GetDetail", "parameters": [ { "type": "integer", "name": "page", "in": "query", "format": "int32", "default": 1, "x-nullable": false }, { "type": "integer", "name": "pageSize", "in": "query", "format": "int32", "default": 200, "x-nullable": false }, { "type": "string", "name": "receivedDateUtcFrom", "in": "query", "format": "date-time", "x-nullable": true }, { "type": "string", "name": "receivedDateUtcTo", "in": "query", "format": "date-time", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxAttachmentDetailsResult" } } } } }, "/v2.0/ReceiveFaxes/ActiveFaxNumbers": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_GetActiveFaxNumbers", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/StringListResult" } } } } }, "/v2.0/ReceiveFaxes/ActiveFaxNumbersFormatted": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_GetActiveFaxNumbersFiltered", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/StringListResult" } } } } }, "/v2.0/ReceiveFaxes/UnretrievedFaxes": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_UnretrievedFaxes", "parameters": [ { "type": "integer", "name": "numberOfDays", "in": "query", "format": "int32", "x-nullable": true }, { "type": "string", "name": "dateFrom", "in": "query", "format": "date-time", "x-nullable": true }, { "type": "string", "name": "dateTo", "in": "query", "format": "date-time", "x-nullable": true }, { "type": "boolean", "name": "returnUTC", "in": "query", "default": false, "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } } }, "/v2.0/ReceiveFaxes/UnretrievedFaxesByLimitDays": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_UnretrievedFaxesByLimitDays", "parameters": [ { "type": "integer", "name": "numberOfDays", "in": "query", "required": true, "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "isUTC", "in": "query", "default": false, "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } } }, "/v2.0/ReceiveFaxes/UnretrievedFaxesByDateRange": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_UnretrievedFaxesByDateRange", "parameters": [ { "type": "string", "name": "dateFrom", "in": "query", "required": true, "format": "date-time", "x-nullable": false }, { "type": "string", "name": "dateTo", "in": "query", "required": true, "format": "date-time", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } } }, "/v2.0/ReceiveFaxes/UnretrievedFaxesByDateRange_UTC": { "get": { "tags": [ "ReceiveFaxesV2" ], "operationId": "ReceiveFaxesV2_UnretrievedFaxesByDateRangeUTC", "parameters": [ { "type": "string", "name": "dateFrom_UTC", "in": "query", "required": true, "format": "date-time", "x-nullable": false }, { "type": "string", "name": "dateTo_UTC", "in": "query", "required": true, "format": "date-time", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } } }, "/v2.0/ReceiveFax/{faxId}/Document": { "get": { "tags": [ "ReceiveFaxV2" ], "operationId": "ReceiveFaxV2_FaxDocument", "parameters": [ { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "type": "string", "name": "outputType", "in": "query", "default": "", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ByteArrayResult" } } } } }, "/v2.0/ReceiveFax/{faxId}/Retrieved": { "put": { "tags": [ "ReceiveFaxV2" ], "operationId": "ReceiveFaxV2_MarkRetrievedFax", "parameters": [ { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/BoolResult" } } } } }, "/v2.0/ReceiveFax/Settings": { "get": { "tags": [ "ReceiveFaxV2" ], "operationId": "ReceiveFaxV2_GetSettings", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ReceiveFaxSettingsResult" } } } }, "put": { "tags": [ "ReceiveFaxV2" ], "operationId": "ReceiveFaxV2_PutSettings", "parameters": [ { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/ReceiveFaxSettingsModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/BoolResult" } } } } }, "/v2.0/Convert": { "put": { "tags": [ "ConvertV2" ], "operationId": "ConvertV2_Index", "parameters": [ { "name": "conversion", "in": "body", "schema": { "$ref": "#/definitions/Conversion" }, "x-nullable": true } ], "responses": { "302": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/Nullable" } } } } }, "/v2.0/Convert/{conversionId}/Status": { "get": { "tags": [ "ConvertV2" ], "operationId": "ConvertV2_GetStatus", "parameters": [ { "type": "integer", "name": "conversionId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ConversionResult" } } } }, "put": { "tags": [ "ConvertV2" ], "operationId": "ConvertV2_PutStatus", "parameters": [ { "type": "integer", "name": "conversionId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ConversionResult" } } } } }, "/v2.0/SendFaxes": { "put": { "tags": [ "SendFaxesV2" ], "operationId": "SendFaxesV2_Send", "parameters": [ { "name": "faxes", "in": "body", "schema": { "type": "array", "items": { "$ref": "#/definitions/Fax" } }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/FaxResult" } } } } } }, "/v2.0/SendFaxes/Details/{number}": { "get": { "tags": [ "SendFaxesV2" ], "operationId": "SendFaxesV2_GetDetailsByLimit", "parameters": [ { "type": "integer", "name": "number", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxAttachmentDetailsResult" } } }, "deprecated": true } }, "/v2.0/SendFaxes/Details": { "get": { "tags": [ "SendFaxesV2" ], "operationId": "SendFaxesV2_GetDetails", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxAttachmentDetailsResult" } } }, "deprecated": true } }, "/v2.0/SendFaxes/Detail": { "get": { "tags": [ "SendFaxesV2" ], "operationId": "SendFaxesV2_GetDetail", "parameters": [ { "type": "integer", "name": "page", "in": "query", "format": "int32", "default": 1, "x-nullable": false }, { "type": "integer", "name": "pageSize", "in": "query", "format": "int32", "default": 200, "x-nullable": false }, { "type": "string", "name": "transmissionDateUTCFrom", "in": "query", "x-nullable": true }, { "type": "string", "name": "transmissionDateUTCTo", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxAttachmentDetailsResult" } } } } }, "/v2.0/SendFaxes/IDsForDate/{startDate}": { "get": { "tags": [ "SendFaxesV2" ], "operationId": "SendFaxesV2_IDsForDateSuppliedByStartDate", "parameters": [ { "type": "string", "name": "startDate", "in": "path", "required": true, "format": "date-time", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntListResult" } } } } }, "/v2.0/SendFaxes/IDsForDate": { "get": { "tags": [ "SendFaxesV2" ], "operationId": "SendFaxesV2_IDsForDateSupplied", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntListResult" } } } } }, "/v2.0/SendFax/{faxId}/Document": { "get": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_FaxDocument", "parameters": [ { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxAttachmentDetailsResult" } } } } }, "/v2.0/SendFax/{faxId}/Data": { "get": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_FaxDocumentData", "parameters": [ { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "type": "string", "name": "outputType", "in": "query", "default": "", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ByteArrayResult" } } } } }, "/v2.0/SendFax/{faxId}/ConvertedData": { "get": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_FaxDocumentConvertedData", "parameters": [ { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ByteArrayResult" } } } } }, "/v2.0/SendFax/{faxId}/Resend": { "post": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_Resend", "parameters": [ { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntResult" } } } } }, "/v2.0/SendFax/{faxId}/Status": { "get": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_Status", "parameters": [ { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/FaxStatusResult" } } } } }, "/v2.0/SendFax": { "put": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_Send", "parameters": [ { "name": "fax", "in": "body", "schema": { "$ref": "#/definitions/Fax" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/FaxResult" } } } } }, "/v2.0/SendFax/{faxId}/Cancel": { "put": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_Cancel", "parameters": [ { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/BoolResult" } } } } }, "/v2.0/SendFax/Settings": { "get": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_GetSettings", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxSettingsResult" } } } }, "put": { "tags": [ "SendFaxV2" ], "operationId": "SendFaxV2_PutSettings", "parameters": [ { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/SendFaxSettingsModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/BoolResult" } } } } }, "/v2.0/SMS": { "put": { "tags": [ "SMSV2" ], "operationId": "SMSV2_Send", "parameters": [ { "name": "sms", "in": "body", "schema": { "$ref": "#/definitions/SMS" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntResult" } } } } }, "/v2.0/SMS/{smsId}/Resend": { "post": { "tags": [ "SMSV2" ], "operationId": "SMSV2_Resend", "parameters": [ { "type": "integer", "name": "smsId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntResult" } } } } }, "/v2.0/SMS/Details/{number}": { "get": { "tags": [ "SMSV2" ], "operationId": "SMSV2_GetDetailsByLimit", "parameters": [ { "type": "integer", "name": "number", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSMessageDetailsResult" } } } } }, "/v2.0/SMS/Details": { "get": { "tags": [ "SMSV2" ], "operationId": "SMSV2_GetDetails", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSMessageDetailsResult" } } } } }, "/v2.0/SMS/{smsId}": { "get": { "tags": [ "SMSV2" ], "operationId": "SMSV2_GetMessageDetail", "parameters": [ { "type": "integer", "name": "smsId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSMessageDetailResult" } } } } }, "/v2.0/SMS/Replies": { "get": { "tags": [ "SMSV2" ], "operationId": "SMSV2_Replies", "parameters": [ { "type": "boolean", "name": "orderByLatest", "in": "query", "default": false, "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSRepliesResult" } } } } }, "/v2.0/SMS/Replies/{number}": { "get": { "tags": [ "SMSV2" ], "operationId": "SMSV2_RepliesByLimit", "parameters": [ { "type": "integer", "name": "number", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "orderByLatest", "in": "query", "default": false, "x-nullable": false }, { "type": "string", "name": "receivedUtc", "in": "query", "format": "date-time", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSRepliesResult" } } } } }, "/v2.0/SMS/Reply/{smsId}": { "get": { "tags": [ "SMSV2" ], "operationId": "SMSV2_ReplyByID", "parameters": [ { "type": "integer", "name": "smsId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSReplyResult" } } } } }, "/v2.0/SMS/VirtualNumberReply/{smsId}": { "get": { "tags": [ "SMSV2" ], "operationId": "SMSV2_VirtualNumberReplyByID", "parameters": [ { "type": "integer", "name": "smsId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSRepliesResult" } } } } }, "/v2.0/SMS/SenderIds": { "get": { "tags": [ "SMSV2" ], "operationId": "SMSV2_GetSenderIdsList", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SmsSenderIdResult" } } } } }, "/v2.0/System/QueueStatus": { "get": { "tags": [ "SystemV2" ], "operationId": "SystemV2_QueueStatus", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/QueueStatusResult" } } } } }, "/v2.0/System/LegalTypes": { "get": { "tags": [ "SystemV2" ], "operationId": "SystemV2_LegalTypes", "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/LegalTypesResult" } } } } }, "/v1.0/Convert": { "put": { "tags": [ "ConvertV1" ], "operationId": "ConvertV1_Index", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "name": "conversion", "in": "body", "schema": { "$ref": "#/definitions/Conversion" }, "x-nullable": true } ], "responses": { "302": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/Nullable" } } } } }, "/v1.0/Convert/{conversionId}/Status": { "get": { "tags": [ "ConvertV1" ], "operationId": "ConvertV1_GetStatus", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "conversionId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ConversionResult" } } } }, "put": { "tags": [ "ConvertV1" ], "operationId": "ConvertV1_PutStatus", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "conversionId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ConversionResult" } } } } }, "/v1.0/ReceiveFaxes/Details/{number}": { "get": { "tags": [ "ReceiveFaxesV1" ], "operationId": "ReceiveFaxesV1_GetDetailsByLimit", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "number", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } }, "/v1.0/ReceiveFaxes/Details": { "get": { "tags": [ "ReceiveFaxesV1" ], "operationId": "ReceiveFaxesV1_GetDetails", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } }, "/v1.0/ReceiveFaxes/ActiveFaxNumbers": { "get": { "tags": [ "ReceiveFaxesV1" ], "operationId": "ReceiveFaxesV1_GetActiveFaxNumbers", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/StringListResult" } } } } }, "/v1.0/ReceiveFaxes/ActiveFaxNumbersFormatted": { "get": { "tags": [ "ReceiveFaxesV1" ], "operationId": "ReceiveFaxesV1_GetActiveFaxNumbersFiltered", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/StringListResult" } } } } }, "/v1.0/ReceiveFaxes/UnretrievedFaxes": { "get": { "tags": [ "ReceiveFaxesV1" ], "operationId": "ReceiveFaxesV1_UnretrievedFaxes", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "numberOfDays", "in": "query", "format": "int32", "x-nullable": true }, { "type": "string", "name": "dateFrom", "in": "query", "format": "date-time", "x-nullable": true }, { "type": "string", "name": "dateTo", "in": "query", "format": "date-time", "x-nullable": true }, { "type": "boolean", "name": "returnUTC", "in": "query", "default": false, "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } } }, "/v1.0/ReceiveFaxes/UnretrievedFaxesByLimitDays": { "get": { "tags": [ "ReceiveFaxesV1" ], "operationId": "ReceiveFaxesV1_UnretrievedFaxesByLimitDays", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "numberOfDays", "in": "query", "required": true, "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "isUTC", "in": "query", "default": false, "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } } }, "/v1.0/ReceiveFaxes/UnretrievedFaxesByDateRange": { "get": { "tags": [ "ReceiveFaxesV1" ], "operationId": "ReceiveFaxesV1_UnretrievedFaxesByDateRange", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "string", "name": "dateFrom", "in": "query", "required": true, "format": "date-time", "x-nullable": false }, { "type": "string", "name": "dateTo", "in": "query", "required": true, "format": "date-time", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } } }, "/v1.0/ReceiveFaxes/UnretrievedFaxesByDateRange_UTC": { "get": { "tags": [ "ReceiveFaxesV1" ], "operationId": "ReceiveFaxesV1_UnretrievedFaxesByDateRangeUTC", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "string", "name": "dateFrom_UTC", "in": "query", "required": true, "format": "date-time", "x-nullable": false }, { "type": "string", "name": "dateTo_UTC", "in": "query", "required": true, "format": "date-time", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxDetailResult" } } } } } }, "/v1.0/ReceiveFax/{faxId}/Document": { "get": { "tags": [ "ReceiveFaxV1" ], "operationId": "ReceiveFaxV1_FaxDocument", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "type": "string", "name": "outputType", "in": "query", "default": "", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ByteArrayResult" } } } } }, "/v1.0/ReceiveFax/{faxId}/Retrieved": { "put": { "tags": [ "ReceiveFaxV1" ], "operationId": "ReceiveFaxV1_MarkRetrievedFax", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/BoolResult" } } } } }, "/v1.0/ReceiveFax/Settings": { "get": { "tags": [ "ReceiveFaxV1" ], "operationId": "ReceiveFaxV1_GetSettings", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ReceiveFaxSettingsResult" } } } }, "put": { "tags": [ "ReceiveFaxV1" ], "operationId": "ReceiveFaxV1_PutSettings", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/ReceiveFaxSettingsModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/BoolResult" } } } } }, "/v1.0/SendFaxes": { "put": { "tags": [ "SendFaxesV1" ], "operationId": "SendFaxesV1_Send", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "name": "faxes", "in": "body", "schema": { "type": "array", "items": { "$ref": "#/definitions/Fax" } }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/FaxResult" } } } } } }, "/v1.0/SendFaxes/Details/{number}": { "get": { "tags": [ "SendFaxesV1" ], "operationId": "SendFaxesV1_GetDetailsByLimit", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "number", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxAttachmentDetailsResult" } } }, "deprecated": true } }, "/v1.0/SendFaxes/Details": { "get": { "tags": [ "SendFaxesV1" ], "operationId": "SendFaxesV1_GetDetails", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxAttachmentDetailsResult" } } }, "deprecated": true } }, "/v1.0/SendFaxes/IDsForDate/{startDate}": { "get": { "tags": [ "SendFaxesV1" ], "operationId": "SendFaxesV1_IDsForDateSuppliedByStartDate", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "string", "name": "startDate", "in": "path", "required": true, "format": "date-time", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntListResult" } } } } }, "/v1.0/SendFaxes/IDsForDate": { "get": { "tags": [ "SendFaxesV1" ], "operationId": "SendFaxesV1_IDsForDateSupplied", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntListResult" } } } } }, "/v1.0/SendFax/{faxId}/Document": { "get": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_FaxDocument", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxAttachmentDetailsResult" } } } } }, "/v1.0/SendFax/{faxId}/Data": { "get": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_FaxDocumentData", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "type": "string", "name": "outputType", "in": "query", "default": "", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ByteArrayResult" } } } } }, "/v1.0/SendFax/{faxId}/ConvertedData": { "get": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_FaxDocumentConvertedData", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/ByteArrayResult" } } } } }, "/v1.0/SendFax/{faxId}/Resend": { "post": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_Resend", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntResult" } } } } }, "/v1.0/SendFax/{faxId}/Status": { "get": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_Status", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/FaxStatusResult" } } } } }, "/v1.0/SendFax": { "put": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_Send", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "name": "fax", "in": "body", "schema": { "$ref": "#/definitions/Fax" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/FaxResult" } } } } }, "/v1.0/SendFax/{faxId}/Cancel": { "put": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_Cancel", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "faxId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/BoolResult" } } } } }, "/v1.0/SendFax/Settings": { "get": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_GetSettings", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SendFaxSettingsResult" } } } }, "put": { "tags": [ "SendFaxV1" ], "operationId": "SendFaxV1_PutSettings", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "name": "model", "in": "body", "schema": { "$ref": "#/definitions/SendFaxSettingsModel" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/BoolResult" } } } } }, "/v1.0/SMS": { "put": { "tags": [ "SMSV1" ], "operationId": "SMSV1_Send", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "name": "sms", "in": "body", "schema": { "$ref": "#/definitions/SMS" }, "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntResult" } } } } }, "/v1.0/SMS/{smsId}/Resend": { "post": { "tags": [ "SMSV1" ], "operationId": "SMSV1_Resend", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "smsId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/IntResult" } } } } }, "/v1.0/SMS/Details/{number}": { "get": { "tags": [ "SMSV1" ], "operationId": "SMSV1_GetDetailsByLimit", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "number", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSMessageDetailsResult" } } } } }, "/v1.0/SMS/Details": { "get": { "tags": [ "SMSV1" ], "operationId": "SMSV1_GetDetails", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSMessageDetailsResult" } } } } }, "/v1.0/SMS/{smsId}": { "get": { "tags": [ "SMSV1" ], "operationId": "SMSV1_GetMessageDetail", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "smsId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSMessageDetailResult" } } } } }, "/v1.0/SMS/Replies": { "get": { "tags": [ "SMSV1" ], "operationId": "SMSV1_Replies", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "boolean", "name": "orderByLatest", "in": "query", "default": false, "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSRepliesResult" } } } } }, "/v1.0/SMS/Replies/{number}": { "get": { "tags": [ "SMSV1" ], "operationId": "SMSV1_RepliesByLimit", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "number", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "type": "boolean", "name": "orderByLatest", "in": "query", "default": false, "x-nullable": false }, { "type": "string", "name": "receivedUtc", "in": "query", "format": "date-time", "x-nullable": true } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSRepliesResult" } } } } }, "/v1.0/SMS/Reply/{smsId}": { "get": { "tags": [ "SMSV1" ], "operationId": "SMSV1_ReplyByID", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "smsId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSReplyResult" } } } } }, "/v1.0/SMS/VirtualNumberReply/{smsId}": { "get": { "tags": [ "SMSV1" ], "operationId": "SMSV1_VirtualNumberReplyByID", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false }, { "type": "integer", "name": "smsId", "in": "path", "required": true, "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SMSRepliesResult" } } } } }, "/v1.0/SMS/SenderIds": { "get": { "tags": [ "SMSV1" ], "operationId": "SMSV1_GetSenderIdsList", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/SmsSenderIdResult" } } } } }, "/v1.0/System/QueueStatus": { "get": { "tags": [ "SystemV1" ], "operationId": "SystemV1_QueueStatus", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/QueueStatusResult" } } } } }, "/v1.0/System/LegalTypes": { "get": { "tags": [ "SystemV1" ], "operationId": "SystemV1_LegalTypes", "parameters": [ { "type": "string", "name": "token", "in": "query", "required": true, "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": false, "description": "", "schema": { "$ref": "#/definitions/LegalTypesResult" } } } } } }, "definitions": { "TokenResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfGuid" }, { "type": "object" } ] }, "BaseResultOfGuid": { "type": "object", "x-abstract": true, "required": [ "Success", "Response" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "string", "format": "guid" } } }, "AuthenticationRequestModel": { "type": "object", "properties": { "Username": { "type": "string" }, "Password": { "type": "string" } } }, "TokenRequestModel": { "allOf": [ { "$ref": "#/definitions/AuthenticationRequestModel" }, { "type": "object", "properties": { "Expires": { "type": "string", "format": "date-time" }, "Computer": { "type": "string" } } } ] }, "DecimalResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfDecimal" }, { "type": "object" } ] }, "BaseResultOfDecimal": { "type": "object", "x-abstract": true, "required": [ "Success", "Response" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "number", "format": "decimal" } } }, "ClientDetailResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfClientDetailModel" }, { "type": "object" } ] }, "BaseResultOfClientDetailModel": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "$ref": "#/definitions/ClientDetailModel" } } }, "ClientDetailModel": { "type": "object", "required": [ "ID" ], "properties": { "ID": { "type": "integer", "format": "int32" }, "BusinessName": { "type": "string" }, "ABN": { "type": "string" }, "AccountHolderTitle": { "type": "string" }, "AccountHolderFirstName": { "type": "string" }, "AccountHolderLastName": { "type": "string" }, "Email": { "type": "string" }, "Telephone": { "type": "string" }, "Fax": { "type": "string" }, "Address": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Postcode": { "type": "string" }, "Country": { "type": "string" }, "MainContactFirstName": { "type": "string" }, "MainContactLastName": { "type": "string" }, "MainContactEmail": { "type": "string" }, "MainContactPhone": { "type": "string" }, "BillingContactFirstName": { "type": "string" }, "BillingContactLastName": { "type": "string" }, "BillingContactEmail": { "type": "string" }, "BillingConpactPhone": { "type": "string" }, "ReceivePushURL": { "type": "string" }, "ReceivePushUsername": { "type": "string" }, "ReceivePushPassword": { "type": "string" }, "IsSpfCheckEnabled": { "type": "boolean" }, "EmailFooter": { "type": "string" } } }, "ClientRequestModel": { "type": "object", "properties": { "BusinessName": { "type": "string" }, "ABN": { "type": "string" }, "AccountHolderTitle": { "type": "string" }, "AccountHolderFirstName": { "type": "string" }, "AccountHolderLastName": { "type": "string" }, "Email": { "type": "string" }, "Telephone": { "type": "string" }, "Fax": { "type": "string" }, "Address": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Postcode": { "type": "string" }, "Country": { "type": "string" }, "MainContactFirstName": { "type": "string" }, "MainContactLastName": { "type": "string" }, "MainContactEmail": { "type": "string" }, "MainContactPhone": { "type": "string" }, "BillingContactFirstName": { "type": "string" }, "BillingContactLastName": { "type": "string" }, "BillingContactEmail": { "type": "string" }, "BillingConpactPhone": { "type": "string" }, "ReceivePushURL": { "type": "string" }, "ReceivePushUsername": { "type": "string" }, "ReceivePushPassword": { "type": "string" }, "IsSpfCheckEnabled": { "type": "boolean" }, "EmailFooter": { "type": "string" } } }, "ClientReceivedFaxDetailResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfICollectionOfClientReceivedFaxViewModel" }, { "type": "object" } ] }, "BaseResultOfICollectionOfClientReceivedFaxViewModel": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "array", "items": { "$ref": "#/definitions/ClientReceivedFaxViewModel" } } } }, "ClientReceivedFaxViewModel": { "type": "object", "required": [ "ID", "ClientID", "Received", "ReceivedUtc" ], "properties": { "ID": { "type": "integer", "format": "int32" }, "Number": { "type": "string" }, "ClientID": { "type": "integer", "format": "int32" }, "Received": { "type": "string", "format": "date-time" }, "ReceivedUtc": { "type": "string", "format": "date-time" }, "Message": { "type": "string" }, "SenderFaxID": { "type": "string" }, "SenderISDNID": { "type": "string" }, "TransmissionTime": { "type": "integer", "format": "int32" }, "NumberOfPages": { "type": "integer", "format": "int32" }, "TransmissionSpeed": { "type": "integer", "format": "int32" }, "FileName": { "type": "string" }, "State": { "type": "boolean" }, "Type": { "type": "string" }, "GoFaxID": { "type": "integer", "format": "int32" }, "ChargeUnits": { "type": "number", "format": "decimal" }, "IsRead": { "type": "boolean" }, "TaskID": { "type": "string" }, "Spectrum": { "type": "boolean" }, "IsRetrieved": { "type": "boolean" } } }, "SendFaxAttachmentDetailsResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfICollectionOfSendFaxAttachmentDetailViewModel" }, { "type": "object" } ] }, "BaseResultOfICollectionOfSendFaxAttachmentDetailViewModel": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "array", "items": { "$ref": "#/definitions/SendFaxAttachmentDetailViewModel" } } } }, "SendFaxAttachmentDetailViewModel": { "type": "object", "required": [ "ID", "SendFaxTransmissionID", "Error", "ConversionComplete", "TransmissionDate", "TransmissionDateUtc" ], "properties": { "ID": { "type": "integer", "format": "int32" }, "SendFaxTransmissionID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "FileName": { "type": "string" }, "Error": { "type": "boolean" }, "ConversionComplete": { "type": "boolean" }, "ConversionStart": { "type": "string", "format": "date-time" }, "ConversionFinish": { "type": "string", "format": "date-time" }, "FromAddress": { "type": "string" }, "ToNumber": { "type": "string" }, "TransmissionDate": { "type": "string", "format": "date-time" }, "TransmissionDateUtc": { "type": "string", "format": "date-time" }, "Pages": { "type": "integer", "format": "int32" }, "TransmissionStart": { "type": "string", "format": "date-time" }, "TransmissionStartUtc": { "type": "string", "format": "date-time" }, "TransmissionComplete": { "type": "string", "format": "date-time" }, "TransmissionCompleteUtc": { "type": "string", "format": "date-time" }, "SendTo": { "type": "string" }, "SendHQ": { "type": "boolean" }, "Charge": { "type": "number", "format": "decimal" }, "RetryDate": { "type": "string", "format": "date-time" }, "CallbackURL": { "type": "string" }, "PushFaxUrl": { "type": "string" }, "FileSize": { "type": "integer", "format": "int32" }, "ClientReference": { "type": "string" }, "CSID": { "type": "string" } } }, "StringListResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfICollectionOfString" }, { "type": "object" } ] }, "BaseResultOfICollectionOfString": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "array", "items": { "type": "string" } } } }, "ByteArrayResult": { "type": "object", "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "string", "format": "byte" } } }, "BoolResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfBoolean" }, { "type": "object" } ] }, "BaseResultOfBoolean": { "type": "object", "x-abstract": true, "required": [ "Success", "Response" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "boolean" } } }, "ReceiveFaxSettingsResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfReceiveFaxSettingsModel" }, { "type": "object" } ] }, "BaseResultOfReceiveFaxSettingsModel": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "$ref": "#/definitions/ReceiveFaxSettingsModel" } } }, "ReceiveFaxSettingsModel": { "type": "object", "properties": { "Url": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" } } }, "Nullable": { "type": "object", "x-abstract": true }, "Conversion": { "type": "object", "required": [ "DestFileType", "IsBlurred" ], "properties": { "Filename": { "type": "string" }, "Data": { "type": "string", "format": "byte" }, "DestFileType": { "type": "integer", "format": "int32" }, "IsBlurred": { "type": "boolean" }, "MultiPageParentId": { "type": "integer", "format": "int32" }, "PageIndex": { "type": "integer", "format": "int32" } } }, "ConversionResult": { "allOf": [ { "$ref": "#/definitions/ByteArrayResult" }, { "type": "object", "required": [ "InProgress" ], "properties": { "InProgress": { "type": "boolean" } } } ] }, "FaxResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfInteger" }, { "type": "object", "properties": { "Documents": { "type": "array", "items": { "$ref": "#/definitions/FaxDocumentResult" } } } } ] }, "FaxDocumentResult": { "type": "object", "required": [ "Submitted" ], "properties": { "Filename": { "type": "string" }, "Message": { "type": "string" }, "Submitted": { "type": "boolean" } } }, "BaseResultOfInteger": { "type": "object", "x-abstract": true, "required": [ "Success", "Response" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "integer", "format": "int32" } } }, "Fax": { "type": "object", "properties": { "SendTo": { "type": "string" }, "SendFrom": { "type": "string" }, "ScheduledSendTime": { "type": "string", "format": "date-time" }, "IsHighQuality": { "type": "boolean" }, "ClientReference": { "type": "string" }, "Retries": { "type": "integer", "format": "int32" }, "Subject": { "type": "string" }, "Documents": { "type": "array", "items": { "$ref": "#/definitions/FaxDocument" } }, "Header": { "type": "string" }, "Csid": { "type": "string" }, "CallbackUrl": { "type": "string" }, "UsePermanentHeader": { "type": "boolean" } } }, "FaxDocument": { "type": "object", "properties": { "Filename": { "type": "string" }, "Data": { "type": "string", "format": "byte" } } }, "IntListResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfICollectionOfInteger" }, { "type": "object" } ] }, "BaseResultOfICollectionOfInteger": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "IntResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfInteger" }, { "type": "object" } ] }, "FaxStatusResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfString" }, { "type": "object", "required": [ "InProgress", "Error" ], "properties": { "InProgress": { "type": "boolean" }, "Error": { "type": "boolean" }, "ClientReference": { "type": "string" } } } ] }, "BaseResultOfString": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "string" } } }, "SendFaxSettingsResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfSendFaxSettingsModel" }, { "type": "object" } ] }, "BaseResultOfSendFaxSettingsModel": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "$ref": "#/definitions/SendFaxSettingsModel" } } }, "SendFaxSettingsModel": { "type": "object", "properties": { "Url": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" } } }, "SMS": { "type": "object", "properties": { "To": { "type": "array", "items": { "type": "string" } }, "From": { "type": "string" }, "ReplyTo": { "type": "string" }, "ClientReference": { "type": "string" }, "Body": { "type": "string" }, "SenderEmail": { "type": "string" }, "MmsImages": { "type": "array", "items": { "$ref": "#/definitions/MmsImage" } } } }, "MmsImage": { "type": "object", "properties": { "Filename": { "type": "string" }, "Data": { "type": "string", "format": "byte" } } }, "SMSMessageDetailsResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfICollectionOfSMSMessageDetailViewModel" }, { "type": "object" } ] }, "BaseResultOfICollectionOfSMSMessageDetailViewModel": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "array", "items": { "$ref": "#/definitions/SMSMessageDetailViewModel" } } } }, "SMSMessageDetailViewModel": { "type": "object", "required": [ "MessageID", "ClientID", "Issued", "IssuedUtc", "RecipientID", "Charge", "Error" ], "properties": { "MessageID": { "type": "integer", "format": "int32" }, "ClientID": { "type": "integer", "format": "int32" }, "Sender": { "type": "string" }, "Message": { "type": "string" }, "Issued": { "type": "string", "format": "date-time" }, "IssuedUtc": { "type": "string", "format": "date-time" }, "FromNumber": { "type": "string" }, "RecipientID": { "type": "integer", "format": "int32" }, "ToNumber": { "type": "string" }, "Status": { "type": "string" }, "Charge": { "type": "number", "format": "decimal" }, "Error": { "type": "boolean" }, "Sent": { "type": "string", "format": "date-time" }, "SentUtc": { "type": "string", "format": "date-time" }, "Complete": { "type": "string", "format": "date-time" }, "CompleteUtc": { "type": "string", "format": "date-time" }, "TransmissionID": { "type": "string" }, "SenderEmail": { "type": "string" }, "Queued": { "type": "string", "format": "date-time" }, "BusinessName": { "type": "string" } } }, "SMSMessageDetailResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfSMSMessageDetailViewModel" }, { "type": "object" } ] }, "BaseResultOfSMSMessageDetailViewModel": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "$ref": "#/definitions/SMSMessageDetailViewModel" } } }, "SMSRepliesResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfICollectionOfSMSReply" }, { "type": "object" } ] }, "BaseResultOfICollectionOfSMSReply": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "array", "items": { "$ref": "#/definitions/SMSReply" } } } }, "SMSReply": { "type": "object", "required": [ "ID", "RecipientID", "Charge", "Received" ], "properties": { "ID": { "type": "integer", "format": "int32" }, "Message": { "type": "string" }, "RecipientID": { "type": "integer", "format": "int32" }, "Charge": { "type": "number", "format": "decimal" }, "Received": { "type": "string", "format": "date-time" }, "RecipientNumber": { "type": "string" }, "IssuedUtc": { "type": "string", "format": "date-time" }, "SentUtc": { "type": "string", "format": "date-time" }, "CompleteUtc": { "type": "string", "format": "date-time" } } }, "SMSReplyResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfSMSReply" }, { "type": "object" } ] }, "BaseResultOfSMSReply": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "$ref": "#/definitions/SMSReply" } } }, "SmsSenderIdResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfICollectionOfSmsSenderIdViewModel" }, { "type": "object" } ] }, "BaseResultOfICollectionOfSmsSenderIdViewModel": { "type": "object", "x-abstract": true, "required": [ "Success" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "type": "array", "items": { "$ref": "#/definitions/SmsSenderIdViewModel" } } } }, "SmsSenderIdViewModel": { "type": "object", "required": [ "IsDefault" ], "properties": { "SenderId": { "type": "string" }, "IsDefault": { "type": "boolean" }, "DisplayText": { "type": "string" } } }, "QueueStatusResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfQueueStatus" }, { "type": "object" } ] }, "BaseResultOfQueueStatus": { "type": "object", "x-abstract": true, "required": [ "Success", "Response" ], "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string" }, "ValidationErrors": { "type": "array", "items": { "type": "string" } }, "Response": { "$ref": "#/definitions/QueueStatus" } } }, "QueueStatus": { "type": "integer", "description": "", "x-enumNames": [ "Green", "Amber", "Red" ], "enum": [ 0, 1, 2 ] }, "LegalTypesResult": { "allOf": [ { "$ref": "#/definitions/BaseResultOfICollectionOfString" }, { "type": "object" } ] } }, "securityDefinitions": { "token": { "type": "apiKey", "description": "token", "name": "Token Key Authentication", "in": "header" } } }