{"items":[{"type":"link","label":"Fax Configuration API","link":"/fax/fax-config-api","routeSlug":"/fax/fax-config-api","content":{"contentType":"overview","meta":{"name":"Fax Configuration API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"fax-config-api.json","url":"/_bundle/fax/fax-config-api.json?download"},{"kind":"download","label":"fax-config-api.yaml","url":"/_bundle/fax/fax-config-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fax Configuration API (2.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fax configuration API allows you to administer:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mail to Fax"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fax to Email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fax to FTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fax to Webservice"},"children":[]}]}]}]}]}],"sectionId":"/fax/fax-config-api"}],"sectionId":"/fax/fax-config-api"}]}]}},{"type":"group","label":"Inbound Fax","link":"/fax/fax-config-api/inbound-fax","routeSlug":"/fax/fax-config-api/inbound-fax","items":[{"label":"Retrieve inbound number configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax/getnumbers","routeSlug":"/fax/fax-config-api/inbound-fax/getnumbers","metadata":{"seo":{"title":"Retrieve inbound number configurations","description":"Retrieve inbound number configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNumbers","name":"Retrieve inbound number configurations","isWebhook":false,"pointer":"/paths/~1inbound~1numbers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve inbound number configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve inbound number configurations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assigned","in":"query","schemaId":"schema_79","description":"Retrieve only numbers that are assigned to a profile"},{"name":"prefix","in":"query","schemaId":"schema_80","description":"Retrieve only numbers that begin with the specified prefix","example":"+4989"},{"name":"active","in":"query","schemaId":"schema_79","description":"Retrieve only numbers that are active"},{"name":"cost-center","in":"query","schemaId":"schema_80","description":"Retrieve only numbers where the cost-center matches the specified value","example":"ABC123"},{"name":"inherit","in":"query","schemaId":"schema_81","description":"Toggle whether to show settings inherited from the profile"}],"pointer":"/paths/~1inbound~1numbers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inbound/numbers","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[],"query":[{"name":"assigned","in":"query","schemaId":"schema_79"},{"name":"prefix","in":"query","example":"+4989","schemaId":"schema_80"},{"name":"active","in":"query","schemaId":"schema_79"},{"name":"cost-center","in":"query","example":"ABC123","schemaId":"schema_80"},{"name":"inherit","in":"query","schemaId":"schema_81"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/inbound/numbers","href":"inbound-fax/getnumbers","openApiOperationId":"getNumbers","summary":"Retrieve inbound number configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of numbers and their settings ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82","exampleIds":["paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbers","paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbersWithInherit"]}},"schemaId":"schema_82","exampleIds":["paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbers","paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbersWithInherit"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1inbound~1numbers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_82","exampleIds":["paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbers","paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbersWithInherit"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82","exampleIds":["paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbers","paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbersWithInherit"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-fax/getnumbers"}],"panels":[]}]},"httpPath":"/inbound/numbers"},{"label":"Retrieve a single inbound fax number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax/getnumber","routeSlug":"/fax/fax-config-api/inbound-fax/getnumber","metadata":{"seo":{"title":"Retrieve a single inbound fax number","description":"Retrieve the configuration for the single specified inbound fax number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNumber","name":"Retrieve a single inbound fax number","isWebhook":false,"pointer":"/paths/~1inbound~1numbers~1{number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a single inbound fax number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the configuration for the single specified inbound fax number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_80","description":"The inbound fax number","required":true,"example":"+443069990000"}],"pointer":"/paths/~1inbound~1numbers~1{number}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"inherit","in":"query","schemaId":"schema_81","description":"Toggle whether to show inherited fields"}],"pointer":"/paths/~1inbound~1numbers~1{number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inbound/numbers/{number}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"example":"+443069990000","schemaId":"schema_80"}],"query":[{"name":"inherit","in":"query","required":false,"schemaId":"schema_81"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/inbound/numbers/{number}","href":"inbound-fax/getnumber","openApiOperationId":"getNumber","summary":"Retrieve a single inbound fax number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Inbound fax number configuration for the specififed number.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumber","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumberInherit","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToFtpNumberInherit","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToWsNumberInherit"]}},"schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumber","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumberInherit","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToFtpNumberInherit","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToWsNumberInherit"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Number does not exsist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1inbound~1numbers~1{number}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumber","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumberInherit","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToFtpNumberInherit","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToWsNumberInherit"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumber","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumberInherit","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToFtpNumberInherit","paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToWsNumberInherit"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-fax/getnumber"}],"panels":[]}]},"httpPath":"/inbound/numbers/{number}"},{"label":"Update a single inbound fax number","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax/updatenumber","routeSlug":"/fax/fax-config-api/inbound-fax/updatenumber","metadata":{"seo":{"title":"Update a single inbound fax number","description":"Update a single inbound fax number. Any omitted fields are automatically defaulted to null, where null is equivalent to Default ie the value will be inherited from the assigned profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNumber","name":"Update a single inbound fax number","isWebhook":false,"pointer":"/paths/~1inbound~1numbers~1{number}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a single inbound fax number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a single inbound fax number. Any omitted fields are automatically defaulted to null, where null is equivalent to Default ie the value will be inherited from the assigned profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_80","description":"The inbound fax number","required":true,"example":"+498900000000"}],"pointer":"/paths/~1inbound~1numbers~1{number}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateMinimum","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToFtpUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToWsUpdateAll"]}},"schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateMinimum","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToFtpUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToWsUpdateAll"],"pointer":"/paths/~1inbound~1numbers~1{number}/put/requestBody","description":"A list of recipient email addresses, for now"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inbound/numbers/{number}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"example":"+498900000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateMinimum","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToFtpUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToWsUpdateAll"]}},"responseCodes":["204","401","403","404"],"pointer":"/inbound/numbers/{number}","href":"inbound-fax/updatenumber","openApiOperationId":"updateNumber","summary":"Update a single inbound fax number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateMinimum","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToFtpUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToWsUpdateAll"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateMinimum","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToFtpUpdateAll","paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToWsUpdateAll"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Number does not exsist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1inbound~1numbers~1{number}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1numbers~1{number}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-fax/updatenumber"}],"panels":[]}]},"httpPath":"/inbound/numbers/{number}"}],"content":{"contentType":"group","meta":{"name":"Inbound Fax"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inbound Fax","showPageActions":true},{"nodeType":"markdoc","content":"View and configure inbound fax numbers"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inbound/numbers","summary":"Retrieve inbound number configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbound-fax/getnumbers","deprecated":false},{"title":"/inbound/numbers/{number}","summary":"Retrieve a single inbound fax number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbound-fax/getnumber","deprecated":false},{"title":"/inbound/numbers/{number}","summary":"Update a single inbound fax number","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inbound-fax/updatenumber","deprecated":false}]}]}]}]}},{"type":"group","label":"Inbound Fax Profiles","link":"/fax/fax-config-api/inbound-fax-profiles","routeSlug":"/fax/fax-config-api/inbound-fax-profiles","items":[{"label":"Retrieve inbound profile configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax-profiles/getinboundprofiles","routeSlug":"/fax/fax-config-api/inbound-fax-profiles/getinboundprofiles","metadata":{"seo":{"title":"Retrieve inbound profile configurations","description":"Retrieve inbound fax profile configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInboundProfiles","name":"Retrieve inbound profile configurations","isWebhook":false,"pointer":"/paths/~1inbound~1profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve inbound profile configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve inbound fax profile configurations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"inherit","in":"query","schemaId":"schema_81","description":"Toggle whether to show inherited fields"},{"name":"serviceType","in":"query","schemaId":"schema_84"},{"name":"name","in":"query","schemaId":"schema_80","example":"Fax2Mail USA"}],"pointer":"/paths/~1inbound~1profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inbound/profiles","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[],"query":[{"name":"inherit","in":"query","schemaId":"schema_81"},{"name":"serviceType","in":"query","schemaId":"components/schemas/InboundProfileServiceType"},{"name":"name","in":"query","example":"Fax2Mail USA","schemaId":"schema_80"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/inbound/profiles","href":"inbound-fax-profiles/getinboundprofiles","openApiOperationId":"getInboundProfiles","summary":"Retrieve inbound profile configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of inbound fax profiles","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1inbound~1profiles/get/responses/200/content/application~1json/examples/InboundFaxProfiles"]}},"schemaId":"schema_85","exampleIds":["paths/~1inbound~1profiles/get/responses/200/content/application~1json/examples/InboundFaxProfiles"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1inbound~1profiles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_85","exampleIds":["paths/~1inbound~1profiles/get/responses/200/content/application~1json/examples/InboundFaxProfiles"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1inbound~1profiles/get/responses/200/content/application~1json/examples/InboundFaxProfiles"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-fax-profiles/getinboundprofiles"}],"panels":[]}]},"httpPath":"/inbound/profiles"},{"label":"Retrieve a single inbound fax profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax-profiles/getinboundprofile","routeSlug":"/fax/fax-config-api/inbound-fax-profiles/getinboundprofile","metadata":{"seo":{"title":"Retrieve a single inbound fax profile","description":"Retrieve a specific inbound fax profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInboundProfile","name":"Retrieve a single inbound fax profile","isWebhook":false,"pointer":"/paths/~1inbound~1profiles~1{profile}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a single inbound fax profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific inbound fax profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profile","in":"path","schemaId":"schema_80","description":"The inbound fax profile name","required":true,"example":"Fax2Mail USA"}],"pointer":"/paths/~1inbound~1profiles~1{profile}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"inherit","in":"query","schemaId":"schema_81","description":"Toggle whether to show inherited fields"}],"pointer":"/paths/~1inbound~1profiles~1{profile}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inbound/profiles/{profile}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"profile","in":"path","required":true,"example":"Fax2Mail USA","schemaId":"schema_80"}],"query":[{"name":"inherit","in":"query","schemaId":"schema_81"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/inbound/profiles/{profile}","href":"inbound-fax-profiles/getinboundprofile","openApiOperationId":"getInboundProfile","summary":"Retrieve a single inbound fax profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voilà"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2FTPProfile"]}},"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2FTPProfile"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Inbound fax profile does not exsist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1inbound~1profiles~1{profile}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2FTPProfile"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2FTPProfile"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-fax-profiles/getinboundprofile"}],"panels":[]}]},"httpPath":"/inbound/profiles/{profile}"},{"label":"Create an inbound fax profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax-profiles/upsertinboundprofile","routeSlug":"/fax/fax-config-api/inbound-fax-profiles/upsertinboundprofile","metadata":{"seo":{"title":"Create an inbound fax profile","description":"Create an inbound fax profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertInboundProfile","name":"Create an inbound fax profile","isWebhook":false,"pointer":"/paths/~1inbound~1profiles~1{profile}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an inbound fax profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an inbound fax profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profile","in":"path","schemaId":"schema_80","required":true,"example":"FaxToEmail-USA"}],"pointer":"/paths/~1inbound~1profiles~1{profile}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InboundFaxProfileCreate","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2FTPProfile"]}},"schemaId":"components/schemas/InboundFaxProfileCreate","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2FTPProfile"],"pointer":"/paths/~1inbound~1profiles~1{profile}/put/requestBody","description":"A complete profile representation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inbound/profiles/{profile}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"profile","in":"path","required":true,"example":"FaxToEmail-USA","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InboundFaxProfileCreate","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2FTPProfile"]}},"responseCodes":["200","201","401","403"],"pointer":"/inbound/profiles/{profile}","href":"inbound-fax-profiles/upsertinboundprofile","openApiOperationId":"upsertInboundProfile","summary":"Create an inbound fax profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"schemaId":"components/schemas/InboundFaxProfileCreate","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2FTPProfile"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InboundFaxProfileCreate","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2FTPProfile"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Inbound fax profile updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2FTPProfile"]}},"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2FTPProfile"]},{"code":"201","description":"New inbound fax profile created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2FTPProfile"]}},"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2FTPProfile"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1inbound~1profiles~1{profile}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2FTPProfile"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2FTPProfile"]}}},{"code":"201","schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2FTPProfile"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InboundFaxProfile","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/FaxToEmailProfile","paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2WSProfile","paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2FTPProfile"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-fax-profiles/upsertinboundprofile"}],"panels":[]}]},"httpPath":"/inbound/profiles/{profile}"},{"label":"Delete an inbound fax profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/inbound-fax-profiles/deleteinboundprofile","routeSlug":"/fax/fax-config-api/inbound-fax-profiles/deleteinboundprofile","metadata":{"seo":{"title":"Delete an inbound fax profile","description":"Delete an inbound fax profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInboundProfile","name":"Delete an inbound fax profile","isWebhook":false,"pointer":"/paths/~1inbound~1profiles~1{profile}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an inbound fax profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an inbound fax profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profile","in":"path","schemaId":"schema_80","description":"The profile name","required":true,"example":"FaxToEmail-USA"}],"pointer":"/paths/~1inbound~1profiles~1{profile}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/inbound/profiles/{profile}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"profile","in":"path","required":true,"example":"FaxToEmail-USA","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404","409"],"pointer":"/inbound/profiles/{profile}","href":"inbound-fax-profiles/deleteinboundprofile","openApiOperationId":"deleteInboundProfile","summary":"Delete an inbound fax profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Inbound fax profile was deleted"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Inbound fax profile does not exsist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"#FIXME"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1inbound~1profiles~1{profile}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1inbound~1profiles~1{profile}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-fax-profiles/deleteinboundprofile"}],"panels":[]}]},"httpPath":"/inbound/profiles/{profile}"}],"content":{"contentType":"group","meta":{"name":"Inbound Fax Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inbound Fax Profiles","showPageActions":true},{"nodeType":"markdoc","content":"View and configure inbound fax profiles"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inbound/profiles","summary":"Retrieve inbound profile configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbound-fax-profiles/getinboundprofiles","deprecated":false},{"title":"/inbound/profiles/{profile}","summary":"Retrieve a single inbound fax profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbound-fax-profiles/getinboundprofile","deprecated":false},{"title":"/inbound/profiles/{profile}","summary":"Create an inbound fax profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inbound-fax-profiles/upsertinboundprofile","deprecated":false},{"title":"/inbound/profiles/{profile}","summary":"Delete an inbound fax profile","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inbound-fax-profiles/deleteinboundprofile","deprecated":false}]}]}]}]}},{"type":"group","label":"Mail to Fax","link":"/fax/fax-config-api/mail-to-fax","routeSlug":"/fax/fax-config-api/mail-to-fax","items":[{"label":"Retrieve a Mail2Fax user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/getuser","routeSlug":"/fax/fax-config-api/mail-to-fax/getuser","metadata":{"seo":{"title":"Retrieve a Mail2Fax user","description":"Retrieve a Mail2Fax user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Retrieve a Mail2Fax user","isWebhook":false,"pointer":"/paths/~1outbound~1users~1{user}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Mail2Fax user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a Mail2Fax user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user","in":"path","schemaId":"schema_80","description":"The users email address","required":true,"example":"john.smith@retarus.com"}],"pointer":"/paths/~1outbound~1users~1{user}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/outbound/users/{user}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"user","in":"path","required":true,"example":"john.smith@retarus.com","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/outbound/users/{user}","href":"mail-to-fax/getuser","openApiOperationId":"getUser","summary":"Retrieve a Mail2Fax user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The configuration for the requested Mail2Fax user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUserAllOptions"]}},"schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUserAllOptions"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Mail2Fax user does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1users~1{user}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUserAllOptions"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUserAllOptions"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax/getuser"}],"panels":[]}]},"httpPath":"/outbound/users/{user}"},{"label":"Upsert a Mail2Fax user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/upsertuser","routeSlug":"/fax/fax-config-api/mail-to-fax/upsertuser","metadata":{"seo":{"title":"Upsert a Mail2Fax user","description":"Create a new or update an existing Mail2Fax user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertUser","name":"Upsert a Mail2Fax user","isWebhook":false,"pointer":"/paths/~1outbound~1users~1{user}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a Mail2Fax user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new or update an existing Mail2Fax user"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user","in":"path","schemaId":"schema_80","description":"The users email address","required":true,"example":"john.smith@retarus.com"}],"pointer":"/paths/~1outbound~1users~1{user}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUserAllOptions"]}},"schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUserAllOptions"],"pointer":"/paths/~1outbound~1users~1{user}/put/requestBody","description":"A complete MailToFaxUser representation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/outbound/users/{user}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"user","in":"path","required":true,"example":"john.smith@retarus.com","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUserAllOptions"]}},"responseCodes":["200","201","401","403","404","409"],"pointer":"/outbound/users/{user}","href":"mail-to-fax/upsertuser","openApiOperationId":"upsertUser","summary":"Upsert a Mail2Fax user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUserAllOptions"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MailToFaxUser","exampleIds":["paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUser","paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUserAllOptions"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mail2Fax user updated"},{"code":"201","description":"Mail2Fax user created"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Mail2Fax user does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/404/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"#FIXME"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1users~1{user}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"201"},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/put/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax/upsertuser"}],"panels":[]}]},"httpPath":"/outbound/users/{user}"},{"label":"Delete a Mail2Fax user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/deleteuser","routeSlug":"/fax/fax-config-api/mail-to-fax/deleteuser","metadata":{"seo":{"title":"Delete a Mail2Fax user","description":"Delete a Mail2Fax user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Delete a Mail2Fax user","isWebhook":false,"pointer":"/paths/~1outbound~1users~1{user}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Mail2Fax user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a Mail2Fax user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user","in":"path","schemaId":"schema_80","description":"The Mail2Fax user's email address","required":true,"example":"john.smith@retarus.com"}],"pointer":"/paths/~1outbound~1users~1{user}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/outbound/users/{user}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"user","in":"path","required":true,"example":"john.smith@retarus.com","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/outbound/users/{user}","href":"mail-to-fax/deleteuser","openApiOperationId":"deleteUser","summary":"Delete a Mail2Fax user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mail2Fax user deleted"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Mail2Fax user does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1users~1{user}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax/deleteuser"}],"panels":[]}]},"httpPath":"/outbound/users/{user}"},{"label":"Patch a Mail2Fax user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/patchuser","routeSlug":"/fax/fax-config-api/mail-to-fax/patchuser","metadata":{"seo":{"title":"Patch a Mail2Fax user","description":"Patch (update) a Mail2Fax user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchUser","name":"Patch a Mail2Fax user","isWebhook":false,"pointer":"/paths/~1outbound~1users~1{user}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a Mail2Fax user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch (update) a Mail2Fax user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user","in":"path","schemaId":"schema_80","description":"The users email address","required":true,"example":"john.smith@retarus.com"}],"pointer":"/paths/~1outbound~1users~1{user}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/InboundFaxProfilePatch","exampleIds":["paths/~1outbound~1users~1{user}/patch/requestBody/content/application~1json-patch+json/examples/Mail2FaxUserPatch"]}},"schemaId":"components/schemas/InboundFaxProfilePatch","exampleIds":["paths/~1outbound~1users~1{user}/patch/requestBody/content/application~1json-patch+json/examples/Mail2FaxUserPatch"],"pointer":"/paths/~1outbound~1users~1{user}/patch/requestBody","description":"A json patch object according to RFC 6902"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/outbound/users/{user}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"user","in":"path","required":true,"example":"john.smith@retarus.com","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/InboundFaxProfilePatch","exampleIds":["paths/~1outbound~1users~1{user}/patch/requestBody/content/application~1json-patch+json/examples/Mail2FaxUserPatch"]}},"responseCodes":["200","401","403","404","409"],"pointer":"/outbound/users/{user}","href":"mail-to-fax/patchuser","openApiOperationId":"patchUser","summary":"Patch a Mail2Fax user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"schemaId":"components/schemas/InboundFaxProfilePatch","exampleIds":["paths/~1outbound~1users~1{user}/patch/requestBody/content/application~1json-patch+json/examples/Mail2FaxUserPatch"],"mediaTypes":["application/json-patch+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/InboundFaxProfilePatch","exampleIds":["paths/~1outbound~1users~1{user}/patch/requestBody/content/application~1json-patch+json/examples/Mail2FaxUserPatch"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mail2Fax user updated"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Mail2Fax user does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/404/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"#FIXME"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1users~1{user}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users~1{user}/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax/patchuser"}],"panels":[]}]},"httpPath":"/outbound/users/{user}"},{"label":"Retrieve Mail2Fax users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax/getusers","routeSlug":"/fax/fax-config-api/mail-to-fax/getusers","metadata":{"seo":{"title":"Retrieve Mail2Fax users","description":"Retrieve Mail2Fax users"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUsers","name":"Retrieve Mail2Fax users","isWebhook":false,"pointer":"/paths/~1outbound~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Mail2Fax users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve Mail2Fax users"},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"profile","in":"query","schemaId":"schema_80","description":"Retrieve only users that are assigned to the specified profile","example":"default"},{"name":"client","in":"query","schemaId":"schema_80","description":"Retrieve only users that are assigned to the specified client","example":"default"},{"name":"search","in":"query","schemaId":"schema_80","description":"Retrieve only users whose email address, profile or client matches the specified search string","example":"john.smith@retarus.com"},{"name":"fuzzy","in":"query","schemaId":"schema_80","description":"Switch between exact- and contains-match","example":false},{"name":"limit","in":"query","schemaId":"schema_86","description":"Number of users to return in the response"},{"name":"offset","in":"query","schemaId":"schema_87","description":"Retrieve users starting with the offset"},{"name":"template","in":"query","schemaId":"schema_80","description":"Retrieve users with the specified coverpage template","example":"coverpage_us_sales.rtf"}],"pointer":"/paths/~1outbound~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/outbound/users","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[],"query":[{"name":"profile","in":"query","example":"default","schemaId":"schema_80"},{"name":"client","in":"query","example":"default","schemaId":"schema_80"},{"name":"search","in":"query","example":"john.smith@retarus.com","schemaId":"schema_80"},{"name":"fuzzy","in":"query","example":false,"schemaId":"schema_80"},{"name":"limit","in":"query","schemaId":"schema_86"},{"name":"offset","in":"query","schemaId":"schema_87"},{"name":"template","in":"query","example":"coverpage_us_sales.rtf","schemaId":"schema_80"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/outbound/users","href":"mail-to-fax/getusers","openApiOperationId":"getUsers","summary":"Retrieve Mail2Fax users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"#FIXME Add a description"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88","exampleIds":["paths/~1outbound~1users/get/responses/200/content/application~1json/examples/Mail2FaxUsers"]}},"schemaId":"schema_88","exampleIds":["paths/~1outbound~1users/get/responses/200/content/application~1json/examples/Mail2FaxUsers"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_88","exampleIds":["paths/~1outbound~1users/get/responses/200/content/application~1json/examples/Mail2FaxUsers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88","exampleIds":["paths/~1outbound~1users/get/responses/200/content/application~1json/examples/Mail2FaxUsers"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1users/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax/getusers"}],"panels":[]}]},"httpPath":"/outbound/users"}],"content":{"contentType":"group","meta":{"name":"Mail to Fax"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mail to Fax","showPageActions":true},{"nodeType":"markdoc","content":"View and configure email to fax users"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/outbound/users/{user}","summary":"Retrieve a Mail2Fax user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mail-to-fax/getuser","deprecated":false},{"title":"/outbound/users/{user}","summary":"Upsert a Mail2Fax user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mail-to-fax/upsertuser","deprecated":false},{"title":"/outbound/users/{user}","summary":"Delete a Mail2Fax user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/mail-to-fax/deleteuser","deprecated":false},{"title":"/outbound/users/{user}","summary":"Patch a Mail2Fax user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/mail-to-fax/patchuser","deprecated":false},{"title":"/outbound/users","summary":"Retrieve Mail2Fax users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mail-to-fax/getusers","deprecated":false}]}]}]}]}},{"type":"group","label":"Mail to Fax Profiles","link":"/fax/fax-config-api/mail-to-fax-profiles","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles","items":[{"label":"Retrieve Mail2Fax profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/getmail2faxprofiles","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/getmail2faxprofiles","metadata":{"seo":{"title":"Retrieve Mail2Fax profiles","description":"Retrieve Mail2Fax profiles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMail2FaxProfiles","name":"Retrieve Mail2Fax profiles","isWebhook":false,"pointer":"/paths/~1outbound~1profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Mail2Fax profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve Mail2Fax profiles."},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_86","description":"Limit the amount of profiles returned"},{"name":"offset","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Skip the specified amount of profiles #FIXME"},"children":[]}]}]}]}],"pointer":"/paths/~1outbound~1profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/outbound/profiles","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_86"},{"name":"offset","in":"query","schemaId":"schema_87"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/outbound/profiles","href":"mail-to-fax-profiles/getmail2faxprofiles","openApiOperationId":"getMail2FaxProfiles","summary":"Retrieve Mail2Fax profiles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Mail2Fax profiles matching the search criteria","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_89","exampleIds":["paths/~1outbound~1profiles/get/responses/200/content/application~1json/examples/Mail2FaxProfiles"]}},"schemaId":"schema_89","exampleIds":["paths/~1outbound~1profiles/get/responses/200/content/application~1json/examples/Mail2FaxProfiles"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1profiles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_89","exampleIds":["paths/~1outbound~1profiles/get/responses/200/content/application~1json/examples/Mail2FaxProfiles"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_89","exampleIds":["paths/~1outbound~1profiles/get/responses/200/content/application~1json/examples/Mail2FaxProfiles"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax-profiles/getmail2faxprofiles"}],"panels":[]}]},"httpPath":"/outbound/profiles"},{"label":"Retrieve a Mail2Fax profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/getmail2faxprofile","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/getmail2faxprofile","metadata":{"seo":{"title":"Retrieve a Mail2Fax profile","description":"Retrieve a specifc Mail2Fax profile"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMail2FaxProfile","name":"Retrieve a Mail2Fax profile","isWebhook":false,"pointer":"/paths/~1outbound~1profiles~1{profile}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Mail2Fax profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specifc Mail2Fax profile"},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profile","in":"path","schemaId":"schema_80","description":"The profile name","required":true,"example":"default"}],"pointer":"/paths/~1outbound~1profiles~1{profile}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/outbound/profiles/{profile}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"profile","in":"path","required":true,"example":"default","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/outbound/profiles/{profile}","href":"mail-to-fax-profiles/getmail2faxprofile","openApiOperationId":"getMail2FaxProfile","summary":"Retrieve a Mail2Fax profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested Mail2Fax profile","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfile","paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfileAllOptions"]}},"schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfile","paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfileAllOptions"]},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Inbound fax profile does not exsist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1profiles~1{profile}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfile","paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfileAllOptions"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfile","paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfileAllOptions"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax-profiles/getmail2faxprofile"}],"panels":[]}]},"httpPath":"/outbound/profiles/{profile}"},{"label":"Insert or update a Mail2Fax profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/upsertmail2faxprofile","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/upsertmail2faxprofile","metadata":{"seo":{"title":"Insert or update a Mail2Fax profile","description":"Create a new or update an existing Mail2Fax profile"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertMail2FaxProfile","name":"Insert or update a Mail2Fax profile","isWebhook":false,"pointer":"/paths/~1outbound~1profiles~1{profile}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert or update a Mail2Fax profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new or update an existing Mail2Fax profile"},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profile","in":"path","schemaId":"schema_80","description":"The profile name","required":true,"example":"default"}],"pointer":"/paths/~1outbound~1profiles~1{profile}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileCreate","paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileAllOptionsCreate"]}},"schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileCreate","paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileAllOptionsCreate"],"pointer":"/paths/~1outbound~1profiles~1{profile}/put/requestBody","description":"A complete Mail2Fax profile representation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/outbound/profiles/{profile}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"profile","in":"path","required":true,"example":"default","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileCreate","paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileAllOptionsCreate"]}},"responseCodes":["200","201","401","403","404"],"pointer":"/outbound/profiles/{profile}","href":"mail-to-fax-profiles/upsertmail2faxprofile","openApiOperationId":"upsertMail2FaxProfile","summary":"Insert or update a Mail2Fax profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileCreate","paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileAllOptionsCreate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileCreate","paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileAllOptionsCreate"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mail2Fax profile updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile"}},"schemaId":"components/schemas/Mail2FaxProfile"},{"code":"201","description":"Mail2Fax profile created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile"}},"schemaId":"components/schemas/Mail2FaxProfile"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Inbound fax profile does not exsist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1profiles~1{profile}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Mail2FaxProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile"}}},{"code":"201","schemaId":"components/schemas/Mail2FaxProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax-profiles/upsertmail2faxprofile"}],"panels":[]}]},"httpPath":"/outbound/profiles/{profile}"},{"label":"Delete a Mail2Fax profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/deletemail2faxprofile","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/deletemail2faxprofile","metadata":{"seo":{"title":"Delete a Mail2Fax profile","description":"Delete the specified Mail2Fax profile"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMail2FaxProfile","name":"Delete a Mail2Fax profile","isWebhook":false,"pointer":"/paths/~1outbound~1profiles~1{profile}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Mail2Fax profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the specified Mail2Fax profile"},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profile","in":"path","schemaId":"schema_80","description":"The profile name","required":true,"example":"retarus-usa-sales"}],"pointer":"/paths/~1outbound~1profiles~1{profile}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/outbound/profiles/{profile}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"profile","in":"path","required":true,"example":"retarus-usa-sales","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/outbound/profiles/{profile}","href":"mail-to-fax-profiles/deletemail2faxprofile","openApiOperationId":"deleteMail2FaxProfile","summary":"Delete a Mail2Fax profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mail2Fax profile deleted"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Inbound fax profile does not exsist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1profiles~1{profile}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax-profiles/deletemail2faxprofile"}],"panels":[]}]},"httpPath":"/outbound/profiles/{profile}"},{"label":"Patch a single outbound fax profile","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/mail-to-fax-profiles/patchmail2faxprofile","routeSlug":"/fax/fax-config-api/mail-to-fax-profiles/patchmail2faxprofile","metadata":{"seo":{"title":"Patch a single outbound fax profile","description":"Patch a single outbound fax profile. #FIXME this description"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchMail2FaxProfile","name":"Patch a single outbound fax profile","isWebhook":false,"pointer":"/paths/~1outbound~1profiles~1{profile}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a single outbound fax profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Patch a single outbound fax profile. #FIXME this description"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profile","in":"path","schemaId":"schema_80","description":"The profile name","required":true,"example":"default"}],"pointer":"/paths/~1outbound~1profiles~1{profile}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InboundFaxProfilePatch"}},"schemaId":"components/schemas/InboundFaxProfilePatch","pointer":"/paths/~1outbound~1profiles~1{profile}/patch/requestBody","description":"A json patch object according to RFC 6902"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/outbound/profiles/{profile}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"profile","in":"path","required":true,"example":"default","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InboundFaxProfilePatch"}},"responseCodes":["200","201","401","403","404"],"pointer":"/outbound/profiles/{profile}","href":"mail-to-fax-profiles/patchmail2faxprofile","openApiOperationId":"patchMail2FaxProfile","summary":"Patch a single outbound fax profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"schemaId":"components/schemas/InboundFaxProfilePatch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InboundFaxProfilePatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voilà"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile"}},"schemaId":"components/schemas/Mail2FaxProfile"},{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voilà"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MailToFaxUser"}},"schemaId":"components/schemas/MailToFaxUser"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Inbound fax profile does not exsist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1outbound~1profiles~1{profile}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Mail2FaxProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Mail2FaxProfile"}}},{"code":"201","schemaId":"components/schemas/MailToFaxUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MailToFaxUser"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1outbound~1profiles~1{profile}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail-to-fax-profiles/patchmail2faxprofile"}],"panels":[]}]},"httpPath":"/outbound/profiles/{profile}"}],"content":{"contentType":"group","meta":{"name":"Mail to Fax Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mail to Fax Profiles","showPageActions":true},{"nodeType":"markdoc","content":"View and configure email to fax profiles"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/outbound/profiles","summary":"Retrieve Mail2Fax profiles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mail-to-fax-profiles/getmail2faxprofiles","deprecated":false},{"title":"/outbound/profiles/{profile}","summary":"Retrieve a Mail2Fax profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mail-to-fax-profiles/getmail2faxprofile","deprecated":false},{"title":"/outbound/profiles/{profile}","summary":"Insert or update a Mail2Fax profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mail-to-fax-profiles/upsertmail2faxprofile","deprecated":false},{"title":"/outbound/profiles/{profile}","summary":"Delete a Mail2Fax profile","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/mail-to-fax-profiles/deletemail2faxprofile","deprecated":false},{"title":"/outbound/profiles/{profile}","summary":"Patch a single outbound fax profile","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/mail-to-fax-profiles/patchmail2faxprofile","deprecated":false}]}]}]}]}},{"type":"group","label":"Joint Outbound and Inbound","link":"/fax/fax-config-api/joint-outbound-and-inbound","routeSlug":"/fax/fax-config-api/joint-outbound-and-inbound","items":[{"label":"Retrieve joint fax accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax-config-api/joint-outbound-and-inbound/getaccounts","routeSlug":"/fax/fax-config-api/joint-outbound-and-inbound/getaccounts","metadata":{"seo":{"title":"Retrieve joint fax accounts","description":"Retrieve joint fax accounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccounts","name":"Retrieve joint fax accounts","isWebhook":false,"pointer":"/paths/~1joint~1accounts~1{correlation-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve joint fax accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve joint fax accounts"},{"nodeType":"security","requirements":[{"schemes":[{"name":"http-basic-auth","scopes":[],"type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"correlation-id","in":"path","schemaId":"schema_90","description":"Retrieve inbound numbers and outbound users correlated by the specified id","required":true,"example":"aecd8419-6bf4-4e17-9380-b3236297ecfa"}],"pointer":"/paths/~1joint~1accounts~1{correlation-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/joint/accounts/{correlation-id}","servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"parameters":{"path":[{"name":"correlation-id","in":"path","required":true,"example":"aecd8419-6bf4-4e17-9380-b3236297ecfa","schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"http-basic-auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/joint/accounts/{correlation-id}","href":"joint-outbound-and-inbound/getaccounts","openApiOperationId":"getAccounts","summary":"Retrieve joint fax accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax-config-api","description":"Mock server","isMockServer":true},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voilà"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_91"}},"schemaId":"schema_91"},{"code":"401","description":"Valid credentials must be provided","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1joint~1accounts~1{correlation-id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1joint~1accounts~1{correlation-id}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Access to the ressource is not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1joint~1accounts~1{correlation-id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1joint~1accounts~1{correlation-id}/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1joint~1accounts~1{correlation-id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_91","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_91"}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1joint~1accounts~1{correlation-id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1joint~1accounts~1{correlation-id}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1joint~1accounts~1{correlation-id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1joint~1accounts~1{correlation-id}/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/joint-outbound-and-inbound/getaccounts"}],"panels":[]}]},"httpPath":"/joint/accounts/{correlation-id}"}],"content":{"contentType":"group","meta":{"name":"Joint Outbound and Inbound"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Joint Outbound and Inbound","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve joined Mail to Fax user and Fax to Mail number"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/joint/accounts/{correlation-id}","summary":"Retrieve joint fax accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/joint-outbound-and-inbound/getaccounts","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CoverSheetSettings":{"id":"components/schemas/CoverSheetSettings","kind":"json-schema","title":"CoverSheetSettings","data":{"type":"object","properties":{"fileName":{"type":"string"},"dateFormat":{"type":"string"},"timeFormat":{"type":"string"}}}},"components/schemas/DialingSettings":{"id":"components/schemas/DialingSettings","kind":"json-schema","title":"DialingSettings","data":{"type":"object","properties":{"countryCode":{"type":"string"},"areaCode":{"type":"string"}}}},"components/schemas/FaxSettings":{"id":"components/schemas/FaxSettings","kind":"json-schema","title":"FaxSettings","data":{"type":"object","properties":{"csid":{"type":"string"},"costCenter":{"type":"string"},"header":{"type":"string"},"blacklist":{"type":"boolean"},"paperSize":{"type":"string"},"resolution":{"type":"string"},"preferredMimeType":{"type":"string"},"attachmentsOnly":{"type":"boolean"},"suppressBlankPages":{"type":"boolean"}}}},"components/schemas/InboundProfileServiceType":{"id":"components/schemas/InboundProfileServiceType","kind":"json-schema","title":"InboundProfileServiceType","data":{"type":"string","enum":["Fax2Mail","Fax2WS","Fax2FTP"]}},"components/schemas/GeneralUserSettings":{"id":"components/schemas/GeneralUserSettings","kind":"json-schema","title":"GeneralUserSettings","data":{"type":"object","properties":{"client":{"type":"string"},"profile":{"type":"string"},"active":{"type":"boolean"},"timezone":{"type":"string"}}}},"components/schemas/MailToFaxUser":{"id":"components/schemas/MailToFaxUser","kind":"json-schema","title":"MailToFaxUser","data":{"type":"object","properties":{"email":{"type":"string"},"general":{"$ref":"#/components/schemas/GeneralUserSettings"},"fax":{"$ref":"#/components/schemas/FaxSettings"},"dialing":{"$ref":"#/components/schemas/DialingSettings"},"reportEmail":{"$ref":"#/components/schemas/ReportEmailSettings"},"coverSheet":{"$ref":"#/components/schemas/CoverSheetSettings"},"personalization":{"type":"object","additionalProperties":{"type":"string"}}}}},"components/schemas/ReportEmailSettings":{"id":"components/schemas/ReportEmailSettings","kind":"json-schema","title":"ReportEmailSettings","data":{"type":"object","properties":{"language":{"type":"string"},"reportFormat":{"type":"string"},"sender":{"type":"string"},"recipients":{"type":"string"},"recipientsIfError":{"type":"string"},"recipientsCc":{"type":"string"},"attachTiff":{"type":"boolean"},"attachTiffOnlyIfError":{"type":"boolean"},"attachPdf":{"type":"boolean"},"sortByStatus":{"type":"string"},"reportRecipients":{"type":"string"},"errorReportRecipients":{"type":"string"},"copyStatusReports":{"type":"string"}}}},"components/schemas/InboundFaxNumber":{"id":"components/schemas/InboundFaxNumber","kind":"json-schema","title":"InboundFaxNumber","data":{"type":"object","properties":{"number":{"type":"string","readOnly":true},"displayNumber":{"description":"The display number is used in the meta provided to the user or application, and in reporting. If it is null, the actual number will be used.","type":"string"},"comments":{"type":"string"},"faxId":{"description":"CSID","type":"string"},"costCenter":{"type":"string"},"active":{"description":"If the number should be active or not. If it is not active, when the number is called the repsonse will be wrong number.","type":"boolean"},"profile":{"description":"The assigned profile display name.","type":"string","readOnly":true}}}},"components/schemas/InboundFaxToEmailNumber":{"id":"components/schemas/InboundFaxToEmailNumber","kind":"json-schema","title":"InboundFaxToEmailNumber","data":{"allOf":[{"$ref":"#/components/schemas/InboundFaxNumber"},{"type":"object","properties":{"email":{"type":"object","properties":{"recipients":{"type":"array","items":{"type":"string"}},"language":{"$ref":"#/components/schemas/InboundFaxLanguage"},"documentFormat":{"$ref":"#/components/schemas/InboundFaxDocumentFormat"}}}}}]}},"components/schemas/InboundFaxToFtpNumber":{"id":"components/schemas/InboundFaxToFtpNumber","kind":"json-schema","title":"InboundFaxToFtpNumber","data":{"allOf":[{"$ref":"#/components/schemas/InboundFaxNumber"},{"type":"object","properties":{"ftp":{"type":"object","properties":{"directory":{"type":"string","writeOnly":true},"language":{"$ref":"#/components/schemas/InboundFaxLanguage"},"documentFormat":{"$ref":"#/components/schemas/InboundFaxDocumentFormat"}}}}}]}},"components/schemas/InboundFaxToWsNumber":{"id":"components/schemas/InboundFaxToWsNumber","kind":"json-schema","title":"InboundFaxToWsNumber","data":{"allOf":[{"$ref":"#/components/schemas/InboundFaxNumber"},{"type":"object","properties":{"webservice":{"type":"object","properties":{"language":{"$ref":"#/components/schemas/InboundFaxLanguage"},"documentFormat":{"$ref":"#/components/schemas/InboundFaxDocumentFormat"}}}}}]}},"components/schemas/InboundFaxLanguage":{"id":"components/schemas/InboundFaxLanguage","kind":"json-schema","title":"InboundFaxLanguage","data":{"type":"string","enum":["de","en","fr","es","pt"]}},"components/schemas/InboundFaxDocumentFormat":{"id":"components/schemas/InboundFaxDocumentFormat","kind":"json-schema","title":"InboundFaxDocumentFormat","data":{"type":"string","enum":["TIF","PDF","PDF_A"]}},"components/schemas/ProfileAssignment":{"id":"components/schemas/ProfileAssignment","kind":"json-schema","title":"ProfileAssignment","data":{"type":"object","properties":{"profile.display_name":{"type":"string","writeOnly":true},"number.customer_namespace_no":{"type":"string","writeOnly":true},"profile":{"type":"string"},"number":{"type":"string"}}}},"components/schemas/ProfileAssignmentUpdate":{"id":"components/schemas/ProfileAssignmentUpdate","kind":"json-schema","title":"ProfileAssignmentUpdate","data":{"type":"object","properties":{"profile":{"type":"string"}}}},"components/schemas/InboundFaxProfile":{"id":"components/schemas/InboundFaxProfile","kind":"json-schema","title":"InboundFaxProfile","data":{"type":"object","properties":{"name":{"type":"string"},"serviceType":{"$ref":"#/components/schemas/InboundProfileServiceType"}}}},"components/schemas/InboundFaxProfileCreate":{"id":"components/schemas/InboundFaxProfileCreate","kind":"json-schema","title":"InboundFaxProfileCreate","data":{"type":"object","properties":{"serviceType":{"$ref":"#/components/schemas/InboundProfileServiceType"}}}},"components/schemas/InboundFaxProfilePatch":{"id":"components/schemas/InboundFaxProfilePatch","kind":"json-schema","title":"InboundFaxProfilePatch","data":{"type":"array","items":{"$ref":"#/components/schemas/PatchDocument"}}},"components/schemas/Mail2FaxProfilePatch":{"id":"components/schemas/Mail2FaxProfilePatch","kind":"json-schema","title":"Mail2FaxProfilePatch","data":{"type":"array","items":{"$ref":"#/components/schemas/PatchDocument"}}},"components/schemas/Mail2FaxUserPatch":{"id":"components/schemas/Mail2FaxUserPatch","kind":"json-schema","title":"Mail2FaxUserPatch","data":{"type":"array","items":{"$ref":"#/components/schemas/PatchDocument"}}},"components/schemas/PatchDocument":{"id":"components/schemas/PatchDocument","kind":"json-schema","title":"PatchDocument","data":{"description":"A JSONPatch document as defined by RFC 6902","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"]},"path":{"type":"string","description":"A JSON-Pointer"},"value":{"type":"object","description":"The value to be used within the operations."},"from":{"type":"string","description":"A string containing a JSON Pointer value."}}}},"components/schemas/RingMasterDao":{"id":"components/schemas/RingMasterDao","kind":"json-schema","title":"RingMasterDao","data":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","properties":{"name":{"type":"string"},"customerNumber":{"type":"string"},"roles":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"ringmasterDao":{"$ref":"#/components/schemas/RingMasterDao"}}}},"components/schemas/GeneralProfileSettings":{"id":"components/schemas/GeneralProfileSettings","kind":"json-schema","title":"GeneralProfileSettings","data":{"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"timezone":{"type":"string"}}}},"components/schemas/Mail2FaxProfile":{"id":"components/schemas/Mail2FaxProfile","kind":"json-schema","title":"Mail2FaxProfile","data":{"type":"object","properties":{"name":{"type":"string"},"general":{"$ref":"#/components/schemas/GeneralProfileSettings"},"fax":{"$ref":"#/components/schemas/FaxSettings"},"dialing":{"$ref":"#/components/schemas/DialingSettings"},"reportEmail":{"$ref":"#/components/schemas/ReportEmailSettings"},"coverSheet":{"$ref":"#/components/schemas/CoverSheetSettings"},"personalization":{"type":"object","additionalProperties":{"type":"string"}}}}},"components/schemas/JsonNode":{"id":"components/schemas/JsonNode","kind":"json-schema","title":"JsonNode","data":{"type":"object","properties":{"valueNode":{"type":"boolean"},"containerNode":{"type":"boolean"},"missingNode":{"type":"boolean"},"object":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"pojo":{"type":"boolean"},"number":{"type":"boolean"},"integralNumber":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"float":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean"},"boolean":{"type":"boolean"},"binary":{"type":"boolean"},"array":{"type":"boolean"},"empty":{"type":"boolean"},"null":{"type":"boolean"}}}},"components/schemas/JointAccounts":{"id":"components/schemas/JointAccounts","kind":"json-schema","title":"JointAccounts","data":{"type":"object","properties":{"correlationId":{"type":"string"},"inbound":{"type":"array","items":{"$ref":"#/components/schemas/InboundFaxNumber"}},"outbound":{"type":"array","items":{"$ref":"#/components/schemas/MailToFaxUser"}}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"string"}}}},"schema_79":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"string"},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InboundFaxNumber"},{"$ref":"#/components/schemas/InboundFaxToEmailNumber"},{"$ref":"#/components/schemas/InboundFaxToFtpNumber"},{"$ref":"#/components/schemas/InboundFaxToWsNumber"}]}},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/InboundFaxNumber"},{"$ref":"#/components/schemas/InboundFaxToEmailNumber"},{"$ref":"#/components/schemas/InboundFaxToFtpNumber"},{"$ref":"#/components/schemas/InboundFaxToWsNumber"}]},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InboundProfileServiceType"},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/InboundFaxProfile"}},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":100},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/MailToFaxUser"}},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Mail2FaxProfile"}},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"string","default":"aecd8419-6bf4-4e17-9380-b3236297ecfa"},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/JointAccounts"}},"id":"schema_91"}},"exampleStore":{"components/examples/InboundFaxNumbersWithInherit":{"id":"components/examples/InboundFaxNumbersWithInherit","value":[{"number":"+498955281201","displayNumber":"+4980012345678","faxId":"retarus","active":true,"profile":"Fax2FTP Orders","ftp":{"language":"de","documentFormat":"TIFF","directory":"other"}},{"number":"+498955281919","faxId":"retarus","active":true,"profile":"Fax2FTP Orders","ftp":{"language":"de","documentFormat":"TIFF","directory":"orders"}},{"number":"+33187166310","faxId":"retarus","active":true,"profile":"Fax2WS Lab Reports","webservice":{"language":"fr","documentFormat":"PDF"}},{"number":"+12012051606","faxId":"retarus","active":true,"profile":"Fax2Mail USA","email":{"language":"en","documentFormat":"PDF","recipients":["sales-helpdesk@retarus.com","crm@retarus.com"]}},{"number":"+12012051606","comments":"Sales fax number USA - New York Office","faxId":"retarus","costCenter":"USA - Sales","active":true,"profile":"Fax2Mail USA","email":{"language":"en","documentFormat":"PDF","recipients":["sales-helpdesk@retarus.com","crm@retarus.com"]}},{"number":"+498955281919"}],"summary":"List of all numbers with inherit enabled"},"components/examples/InboundFaxNumbers":{"id":"components/examples/InboundFaxNumbers","value":[{"number":"+498955281201","displayNumber":"+4980012345678","profile":"Fax2FTP Orders","ftp":{"directory":"other"}},{"number":"+498955281919","profile":"Fax2FTP Orders","ftp":{}},{"number":"+33187166310","profile":"Fax2WS Lab Reports","webservice":{}},{"number":"+12012051606","profile":"Fax2Mail USA","email":{"recipients":["sales-helpdesk@retarus.com","crm@retarus.com"]}},{"number":"+12012051606","comments":"Sales fax number USA - New York Office","costCenter":"USA - Sales","profile":"Fax2Mail USA","email":{"recipients":["sales-helpdesk@retarus.com","crm@retarus.com"]}},{"number":"+498955281919"}],"summary":"List of all numbers"},"components/examples/FaxToEmailNumberInherit":{"id":"components/examples/FaxToEmailNumberInherit","value":{"costCenter":"Consulting","number":"0049/89/208076-5001","displayNumber":"+499876543210","comments":"initial Comment","faxId":"initial CSID","active":true,"profile":"FaxToEmail","email":{"language":"de","documentFormat":"PDF","recipients":["recipient@null.dev.retloc"]}},"summary":"Fax to Email number configuration with inherit"},"components/examples/FaxToFtpNumberInherit":{"id":"components/examples/FaxToFtpNumberInherit","value":{"costCenter":"Consulting","number":"0049/89/208076-5001","displayNumber":"+499876543210","comments":"initial Comment","faxId":"initial CSID","active":true,"profile":"FaxToSFTP","ftp":{"language":"de","documentFormat":"TIF","directory":["fax2ftp"]}},"summary":"Fax to FTP number configuration with inherit"},"components/examples/FaxToWsNumberInherit":{"id":"components/examples/FaxToWsNumberInherit","value":{"costCenter":"Consulting","number":"0049/89/208076-5001","displayNumber":"+499876543210","comments":"initial Comment","faxId":"initial CSID","active":true,"profile":"FaxToWS","webservice":{"language":"de","documentFormat":"TIF"}},"summary":"Fax to webservice number configuration with inherit"},"components/examples/FaxToEmailNumber":{"id":"components/examples/FaxToEmailNumber","value":{"number":"0049/89/208076-5001","profile":"FaxToEmail","email":{"recipients":["recipient@null.dev.retloc"]}},"summary":"Fax to Email number configuration without inherit"},"components/examples/FaxToEmailNumberUpdate":{"id":"components/examples/FaxToEmailNumberUpdate","value":{"email":{"recipients":["john.smith@acme.com"]}},"summary":"Set just the recipient for a Fax to Email number","description":"Set the email recipient for Fax to Email number, defaulting all other settings to the values from the profile - ie inherit the remaing settings."},"components/examples/FaxToEmailNumberUpdateAll":{"id":"components/examples/FaxToEmailNumberUpdateAll","value":{"costCenter":"Sales","displayNumber":"+498900000000","comments":"Inbound fax number for John Smith - set on 01.01.2021","faxId":"498900000000","active":true,"email":{"language":"en","documentFormat":"PDF","recipients":["ann.smith@acme.com","john.smith@acme.com"]}},"summary":"Set everything for Fax to Email number"},"components/examples/FaxToFtpNumberUpdateAll":{"id":"components/examples/FaxToFtpNumberUpdateAll","value":{"costCenter":"Sales","displayNumber":"+498900000000","comments":"Inbound fax number for John Smith - set on 01.01.2021","faxId":"498900000000","active":true,"ftp":{"language":"en","documentFormat":"PDF","directory":"sales"}},"summary":"Set everything for a Fax to FTP number"},"components/examples/FaxToWsNumberUpdateAll":{"id":"components/examples/FaxToWsNumberUpdateAll","value":{"costCenter":"Sales","displayNumber":"+498900000000","comments":"Inbound fax number for John Smith - set on 01.01.2021","faxId":"498900000000","active":true,"webservice":{"language":"en","documentFormat":"PDF"}},"summary":"Set everything for a Fax to Webservice number."},"components/examples/InboundFaxProfiles":{"id":"components/examples/InboundFaxProfiles","value":[{"name":"Fax2FTP Orders","serviceType":"Fax2FTP"},{"name":"Fax2WS Lab Reports","serviceType":"Fax2WS"},{"name":"Fax2Mail USA","serviceType":"Fax2Mail"}],"summary":"Inbound fax profiles"},"components/examples/FaxToEmailProfile":{"id":"components/examples/FaxToEmailProfile","value":{"name":"FaxToEmail-USA","serviceType":"Fax2Mail"},"summary":"Fax to Email Profile"},"components/examples/Fax2WSProfile":{"id":"components/examples/Fax2WSProfile","value":{"name":"Fax2WS-Orders","serviceType":"Fax2WS"},"summary":"Fax to Applications - Webservice Push - Profile"},"components/examples/Fax2FTPProfile":{"id":"components/examples/Fax2FTPProfile","value":{"name":"Fax2FTP-Orders","serviceType":"Fax2FTP"},"summary":"Fax to Applications - FTP - Profile"},"components/examples/FaxToEmailProfileCreate":{"id":"components/examples/FaxToEmailProfileCreate","value":{"serviceType":"Fax2Mail"},"summary":"Fax to Email Profile"},"components/examples/Fax2WSProfileCreate":{"id":"components/examples/Fax2WSProfileCreate","value":{"serviceType":"Fax2WS"},"summary":"Fax to Applications - Webservice Push - Profile"},"components/examples/Fax2FTPProfileCreate":{"id":"components/examples/Fax2FTPProfileCreate","value":{"serviceType":"Fax2FTP"},"summary":"Fax to Applications - FTP - Profile"},"components/examples/Mail2FaxUser":{"id":"components/examples/Mail2FaxUser","value":{"email":"john.smith@retarus.com","personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default"},"fax":{"costCenter":"Sales-USA"}},"summary":"Basic Mail2Fax user","description":"A typical Mail2Fax user with only a user specific cost center and a few personalization values"},"components/examples/Mail2FaxUserAllOptions":{"id":"components/examples/Mail2FaxUserAllOptions","value":{"email":"john.smith@retarus.com","dialing":{"countryCode":"+1","areaCode\"":"215"},"reportEmail":{"language":"es","sender":"faxservice-admin@retarus.com","recipients":"fax-delivered@retarus.com","recipientsIfError":"fax-not-delivered@retarus.com","recipientsCc":"archive-fax@retarus.com","attachTiff":true,"attachTiffOnlyIfError":true,"attachPdf":true,"sortByStatus":"errors-first"},"coverSheet":{"fileName":"retarus-partner-sales-cover.rtf","dateFormat":"dd.MM.yyyy","timeFormat":"HH:mm:ss"},"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true,"timezone":"US/Eastern"},"fax":{"csid\"":"Retarus - Partner Sales","costCenter":"Partner-Sales-USA","header":"%0f %d.%m.%Y %H:%M:%S Retarus Partner Sales from %e for %C %r%P/%T","blacklist":false,"paperSize":"letter","resolution":"high","preferredMimeType":"text/plain","attachmentsOnly":true,"suppressBlankPages":true}},"summary":"Mail2Fax user with all options","description":"A Mail2Fax user with all options set within the user"},"components/examples/Mail2FaxUsers":{"id":"components/examples/Mail2FaxUsers","value":[{"email":"john.smith@retarus.com","personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true},"fax":{"costCenter":"Sales-USA"}},{"email":"max.mustermann@retarus.de","personalization":{"department":"Vertrieb","title":"Vertriebsmitarbeiter"},"general":{"client":"default","profile":"default","active":true},"fax":{"costCenter":"Sales-DEU"}}],"summary":"List of Mail2Fax users\""},"components/examples/Mail2FaxUserCreate":{"id":"components/examples/Mail2FaxUserCreate","value":{"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true},"fax":{"costCenter":"Sales-USA"}},"summary":"Basic Mail2Fax user","description":"A typical Mail2Fax user with only a user specific cost center and a few personalization values"},"components/examples/Mail2FaxUserAllOptionsCreate":{"id":"components/examples/Mail2FaxUserAllOptionsCreate","value":{"dialing":{"countryCode":1,"areaCode\"":215},"reportEmail":{"language":"es","sender":"faxservice-admin@retarus.com","recipients":"fax-delivered@retarus.com","recipientsIfError":"fax-not-delivered@retarus.com","recipientsCc":"archive-fax@retarus.com","attachTiff":true,"attachTiffOnlyIfError":true,"attachPdf":true,"sortByStatus":"errors-first"},"coverSheet":{"fileName":"retarus-usa-sales-cover.rtf","dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true,"timezone":"US/Eastern"},"fax":{"csid":"Retarus - Sales","costCenter":"Partner-Sales-USA","header":"%0f %d.%m.%Y %H:%M:%S Retarus Partner Sales from %e for %C %r%P/%T","blacklist":false,"paperSize":"letter","resolution":"high","preferredMimeType":"text/plain","attachmentsOnly":true,"suppressBlankPages":true}},"summary":"Mail2Fax user with all options","description":"A Mail2Fax user with all options set within the user"},"components/examples/Mail2FaxUserPatch":{"id":"components/examples/Mail2FaxUserPatch","value":{"path":"/fax","value":{"costCenter":"Retarus-Sales-USA"},"op":"add"},"summary":"Change the cost center","description":"Change the cost center of the Mail2Fax user"},"components/examples/Mail2FaxProfiles":{"id":"components/examples/Mail2FaxProfiles","value":[{"name":"Retarus-USA-Sales","dialing":{"countryCode":1,"areaCode":201},"reportEmail":{"language":"en"},"coverSheet":{"dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"company":"retarus (North America) Inc."},"general":{"timezone":"US/Eastern"},"fax":{"csid":"Retarus USA","costCenter":"Retarus-USA-Sales","paperSize":"letter"}},{"name":"Retarus-DE-Sales","dialing":{"countryCode":49,"areaCode":89},"reportEmail":{"language":"de"},"coverSheet":{"dateFormat":"dd.MM.yyyy","timeFormat":"HH:mm:ss"},"personalization":{"company":"retarus GmbH."},"general":{"timezone":"Europe/Berlin"},"fax":{"csid":"Retarus GmbH.","costCenter":"Retarus-DE-Sales","paperSize":"A4"}}],"summary":"List of Mail2Fax profiles"},"components/examples/Mail2FaxProfile":{"id":"components/examples/Mail2FaxProfile","value":{"name":"Retarus-USA-Sales","dialing":{"countryCode":1,"areaCode":201},"reportEmail":{"language":"en"},"coverSheet":{"dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"company":"retarus (North America) Inc."},"general":{"timezone":"US/Eastern"},"fax":{"csid":"Retarus USA","costCenter":"Retarus-USA-Sales","paperSize":"letter"}},"summary":"Basic Mail2Fax profile"},"components/examples/Mail2FaxProfileAllOptions":{"id":"components/examples/Mail2FaxProfileAllOptions","value":{"name":"Retarus-USA-Sales","dialing":{"countryCode":1,"areaCode\"":215},"reportEmail":{"language":"es","sender":"faxservice-admin@retarus.com","recipients":"fax-delivered@retarus.com","recipientsIfError":"fax-not-delivered@retarus.com","recipientsCc":"archive-fax@retarus.com","attachTiff":true,"attachTiffOnlyIfError":true,"attachPdf":true,"sortByStatus":"errors-first"},"coverSheet":{"fileName":"retarus-usa-sales-cover.rtf","dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true,"timezone":"US/Eastern"},"fax":{"csid":"Retarus - Sales","costCenter":"Partner-Sales-USA","header":"%0f %d.%m.%Y %H:%M:%S Retarus Partner Sales from %e for %C %r%P/%T","blacklist":false,"paperSize":"letter","resolution":"high","preferredMimeType":"text/plain","attachmentsOnly":true,"suppressBlankPages":true}},"summary":"Mail2Fax profile with all options"},"components/examples/Mail2FaxProfileCreate":{"id":"components/examples/Mail2FaxProfileCreate","value":{"dialing":{"countryCode":1,"areaCode":201},"reportEmail":{"language":"en"},"coverSheet":{"dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"company":"retarus (North America) Inc."},"general":{"timezone":"US/Eastern"},"fax":{"csid":"Retarus USA","costCenter":"Retarus-USA-Sales","paperSize":"letter"}},"summary":"Basic Mail2Fax profile"},"components/examples/Mail2FaxProfileAllOptionsCreate":{"id":"components/examples/Mail2FaxProfileAllOptionsCreate","value":{"dialing":{"countryCode":1,"areaCode\"":215},"reportEmail":{"language":"es","sender":"faxservice-admin@retarus.com","recipients":"fax-delivered@retarus.com","recipientsIfError":"fax-not-delivered@retarus.com","recipientsCc":"archive-fax@retarus.com","attachTiff":true,"attachTiffOnlyIfError":true,"attachPdf":true,"sortByStatus":"errors-first"},"coverSheet":{"fileName":"retarus-usa-sales-cover.rtf","dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true,"timezone":"US/Eastern"},"fax":{"csid":"Retarus - Sales","costCenter":"Partner-Sales-USA","header":"%0f %d.%m.%Y %H:%M:%S Retarus Partner Sales from %e for %C %r%P/%T","blacklist":false,"paperSize":"letter","resolution":"high","preferredMimeType":"text/plain","attachmentsOnly":true,"suppressBlankPages":true}},"summary":"Mail2Fax profile with all options"},"paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbers":{"value":[{"number":"+498955281201","displayNumber":"+4980012345678","profile":"Fax2FTP Orders","ftp":{"directory":"other"}},{"number":"+498955281919","profile":"Fax2FTP Orders","ftp":{}},{"number":"+33187166310","profile":"Fax2WS Lab Reports","webservice":{}},{"number":"+12012051606","profile":"Fax2Mail USA","email":{"recipients":["sales-helpdesk@retarus.com","crm@retarus.com"]}},{"number":"+12012051606","comments":"Sales fax number USA - New York Office","costCenter":"USA - Sales","profile":"Fax2Mail USA","email":{"recipients":["sales-helpdesk@retarus.com","crm@retarus.com"]}},{"number":"+498955281919"}],"key":"InboundFaxNumbers","summary":"List of all numbers","id":"paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbers"},"paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbersWithInherit":{"value":[{"number":"+498955281201","displayNumber":"+4980012345678","faxId":"retarus","active":true,"profile":"Fax2FTP Orders","ftp":{"language":"de","documentFormat":"TIFF","directory":"other"}},{"number":"+498955281919","faxId":"retarus","active":true,"profile":"Fax2FTP Orders","ftp":{"language":"de","documentFormat":"TIFF","directory":"orders"}},{"number":"+33187166310","faxId":"retarus","active":true,"profile":"Fax2WS Lab Reports","webservice":{"language":"fr","documentFormat":"PDF"}},{"number":"+12012051606","faxId":"retarus","active":true,"profile":"Fax2Mail USA","email":{"language":"en","documentFormat":"PDF","recipients":["sales-helpdesk@retarus.com","crm@retarus.com"]}},{"number":"+12012051606","comments":"Sales fax number USA - New York Office","faxId":"retarus","costCenter":"USA - Sales","active":true,"profile":"Fax2Mail USA","email":{"language":"en","documentFormat":"PDF","recipients":["sales-helpdesk@retarus.com","crm@retarus.com"]}},{"number":"+498955281919"}],"key":"InboundFaxNumbersWithInherit","summary":"List of all numbers with inherit enabled","id":"paths/~1inbound~1numbers/get/responses/200/content/application~1json/examples/InboundFaxNumbersWithInherit"},"paths/~1inbound~1numbers/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1inbound~1numbers/get/responses/401/content/application~1json/example"},"paths/~1inbound~1numbers/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1inbound~1numbers/get/responses/403/content/application~1json/example"},"paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumber":{"value":{"number":"0049/89/208076-5001","profile":"FaxToEmail","email":{"recipients":["recipient@null.dev.retloc"]}},"key":"FaxToEmailNumber","summary":"Fax to Email number configuration without inherit","id":"paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumber"},"paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumberInherit":{"value":{"costCenter":"Consulting","number":"0049/89/208076-5001","displayNumber":"+499876543210","comments":"initial Comment","faxId":"initial CSID","active":true,"profile":"FaxToEmail","email":{"language":"de","documentFormat":"PDF","recipients":["recipient@null.dev.retloc"]}},"key":"FaxToEmailNumberInherit","summary":"Fax to Email number configuration with inherit","id":"paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToEmailNumberInherit"},"paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToFtpNumberInherit":{"value":{"costCenter":"Consulting","number":"0049/89/208076-5001","displayNumber":"+499876543210","comments":"initial Comment","faxId":"initial CSID","active":true,"profile":"FaxToSFTP","ftp":{"language":"de","documentFormat":"TIF","directory":["fax2ftp"]}},"key":"FaxToFtpNumberInherit","summary":"Fax to FTP number configuration with inherit","id":"paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToFtpNumberInherit"},"paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToWsNumberInherit":{"value":{"costCenter":"Consulting","number":"0049/89/208076-5001","displayNumber":"+499876543210","comments":"initial Comment","faxId":"initial CSID","active":true,"profile":"FaxToWS","webservice":{"language":"de","documentFormat":"TIF"}},"key":"FaxToWsNumberInherit","summary":"Fax to webservice number configuration with inherit","id":"paths/~1inbound~1numbers~1{number}/get/responses/200/content/application~1json/examples/FaxToWsNumberInherit"},"paths/~1inbound~1numbers~1{number}/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1inbound~1numbers~1{number}/get/responses/401/content/application~1json/example"},"paths/~1inbound~1numbers~1{number}/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1inbound~1numbers~1{number}/get/responses/403/content/application~1json/example"},"paths/~1inbound~1numbers~1{number}/get/responses/404/content/application~1json/example":{"value":{"code":404,"message":"Unknown number"},"id":"paths/~1inbound~1numbers~1{number}/get/responses/404/content/application~1json/example"},"paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateMinimum":{"value":{"email":{"recipients":["john.smith@acme.com"]}},"key":"faxToEmailUpdateMinimum","summary":"Set just the recipient for a Fax to Email number","description":"Set the email recipient for Fax to Email number, defaulting all other settings to the values from the profile - ie inherit the remaing settings.","id":"paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateMinimum"},"paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateAll":{"value":{"costCenter":"Sales","displayNumber":"+498900000000","comments":"Inbound fax number for John Smith - set on 01.01.2021","faxId":"498900000000","active":true,"email":{"language":"en","documentFormat":"PDF","recipients":["ann.smith@acme.com","john.smith@acme.com"]}},"key":"faxToEmailUpdateAll","summary":"Set everything for Fax to Email number","id":"paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToEmailUpdateAll"},"paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToFtpUpdateAll":{"value":{"costCenter":"Sales","displayNumber":"+498900000000","comments":"Inbound fax number for John Smith - set on 01.01.2021","faxId":"498900000000","active":true,"ftp":{"language":"en","documentFormat":"PDF","directory":"sales"}},"key":"faxToFtpUpdateAll","summary":"Set everything for a Fax to FTP number","id":"paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToFtpUpdateAll"},"paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToWsUpdateAll":{"value":{"costCenter":"Sales","displayNumber":"+498900000000","comments":"Inbound fax number for John Smith - set on 01.01.2021","faxId":"498900000000","active":true,"webservice":{"language":"en","documentFormat":"PDF"}},"key":"faxToWsUpdateAll","summary":"Set everything for a Fax to Webservice number.","id":"paths/~1inbound~1numbers~1{number}/put/requestBody/content/application~1json/examples/faxToWsUpdateAll"},"paths/~1inbound~1numbers~1{number}/put/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1inbound~1numbers~1{number}/put/responses/401/content/application~1json/example"},"paths/~1inbound~1numbers~1{number}/put/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1inbound~1numbers~1{number}/put/responses/403/content/application~1json/example"},"paths/~1inbound~1numbers~1{number}/put/responses/404/content/application~1json/example":{"value":{"code":404,"message":"Unknown number"},"id":"paths/~1inbound~1numbers~1{number}/put/responses/404/content/application~1json/example"},"paths/~1inbound~1profiles/get/responses/200/content/application~1json/examples/InboundFaxProfiles":{"value":[{"name":"Fax2FTP Orders","serviceType":"Fax2FTP"},{"name":"Fax2WS Lab Reports","serviceType":"Fax2WS"},{"name":"Fax2Mail USA","serviceType":"Fax2Mail"}],"key":"InboundFaxProfiles","summary":"Inbound fax profiles","id":"paths/~1inbound~1profiles/get/responses/200/content/application~1json/examples/InboundFaxProfiles"},"paths/~1inbound~1profiles/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1inbound~1profiles/get/responses/401/content/application~1json/example"},"paths/~1inbound~1profiles/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1inbound~1profiles/get/responses/403/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/FaxToEmailProfile":{"value":{"name":"FaxToEmail-USA","serviceType":"Fax2Mail"},"key":"FaxToEmailProfile","summary":"Fax to Email Profile","id":"paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/FaxToEmailProfile"},"paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2WSProfile":{"value":{"name":"Fax2WS-Orders","serviceType":"Fax2WS"},"key":"Fax2WSProfile","summary":"Fax to Applications - Webservice Push - Profile","id":"paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2WSProfile"},"paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2FTPProfile":{"value":{"name":"Fax2FTP-Orders","serviceType":"Fax2FTP"},"key":"Fax2FTPProfile","summary":"Fax to Applications - FTP - Profile","id":"paths/~1inbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Fax2FTPProfile"},"paths/~1inbound~1profiles~1{profile}/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1inbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1inbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/get/responses/404/content/application~1json/example":{"value":{"code":404,"message":"Unknown profile"},"id":"paths/~1inbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/FaxToEmailProfile":{"value":{"serviceType":"Fax2Mail"},"key":"FaxToEmailProfile","summary":"Fax to Email Profile","id":"paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/FaxToEmailProfile"},"paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2WSProfile":{"value":{"serviceType":"Fax2WS"},"key":"Fax2WSProfile","summary":"Fax to Applications - Webservice Push - Profile","id":"paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2WSProfile"},"paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2FTPProfile":{"value":{"serviceType":"Fax2FTP"},"key":"Fax2FTPProfile","summary":"Fax to Applications - FTP - Profile","id":"paths/~1inbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Fax2FTPProfile"},"paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/FaxToEmailProfile":{"value":{"name":"FaxToEmail-USA","serviceType":"Fax2Mail"},"key":"FaxToEmailProfile","summary":"Fax to Email Profile","id":"paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/FaxToEmailProfile"},"paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2WSProfile":{"value":{"name":"Fax2WS-Orders","serviceType":"Fax2WS"},"key":"Fax2WSProfile","summary":"Fax to Applications - Webservice Push - Profile","id":"paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2WSProfile"},"paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2FTPProfile":{"value":{"name":"Fax2FTP-Orders","serviceType":"Fax2FTP"},"key":"Fax2FTPProfile","summary":"Fax to Applications - FTP - Profile","id":"paths/~1inbound~1profiles~1{profile}/put/responses/200/content/application~1json/examples/Fax2FTPProfile"},"paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/FaxToEmailProfile":{"value":{"name":"FaxToEmail-USA","serviceType":"Fax2Mail"},"key":"FaxToEmailProfile","summary":"Fax to Email Profile","id":"paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/FaxToEmailProfile"},"paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2WSProfile":{"value":{"name":"Fax2WS-Orders","serviceType":"Fax2WS"},"key":"Fax2WSProfile","summary":"Fax to Applications - Webservice Push - Profile","id":"paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2WSProfile"},"paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2FTPProfile":{"value":{"name":"Fax2FTP-Orders","serviceType":"Fax2FTP"},"key":"Fax2FTPProfile","summary":"Fax to Applications - FTP - Profile","id":"paths/~1inbound~1profiles~1{profile}/put/responses/201/content/application~1json/examples/Fax2FTPProfile"},"paths/~1inbound~1profiles~1{profile}/put/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1inbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/put/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1inbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1inbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1inbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example":{"value":{"code":404,"message":"Unknown profile"},"id":"paths/~1inbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"},"paths/~1inbound~1profiles~1{profile}/delete/responses/409/content/application~1json/example":{"value":{"code":409,"message":null},"id":"paths/~1inbound~1profiles~1{profile}/delete/responses/409/content/application~1json/example"},"paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUser":{"value":{"email":"john.smith@retarus.com","personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default"},"fax":{"costCenter":"Sales-USA"}},"key":"Mail2FaxUser","summary":"Basic Mail2Fax user","description":"A typical Mail2Fax user with only a user specific cost center and a few personalization values","id":"paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUser"},"paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUserAllOptions":{"value":{"email":"john.smith@retarus.com","dialing":{"countryCode":"+1","areaCode\"":"215"},"reportEmail":{"language":"es","sender":"faxservice-admin@retarus.com","recipients":"fax-delivered@retarus.com","recipientsIfError":"fax-not-delivered@retarus.com","recipientsCc":"archive-fax@retarus.com","attachTiff":true,"attachTiffOnlyIfError":true,"attachPdf":true,"sortByStatus":"errors-first"},"coverSheet":{"fileName":"retarus-partner-sales-cover.rtf","dateFormat":"dd.MM.yyyy","timeFormat":"HH:mm:ss"},"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true,"timezone":"US/Eastern"},"fax":{"csid\"":"Retarus - Partner Sales","costCenter":"Partner-Sales-USA","header":"%0f %d.%m.%Y %H:%M:%S Retarus Partner Sales from %e for %C %r%P/%T","blacklist":false,"paperSize":"letter","resolution":"high","preferredMimeType":"text/plain","attachmentsOnly":true,"suppressBlankPages":true}},"key":"Mail2FaxUserAllOptions","summary":"Mail2Fax user with all options","description":"A Mail2Fax user with all options set within the user","id":"paths/~1outbound~1users~1{user}/get/responses/200/content/application~1json/examples/Mail2FaxUserAllOptions"},"paths/~1outbound~1users~1{user}/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1users~1{user}/get/responses/401/content/application~1json/example"},"paths/~1outbound~1users~1{user}/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1users~1{user}/get/responses/403/content/application~1json/example"},"paths/~1outbound~1users~1{user}/get/responses/404/content/application~1json/example":{"value":{"code":404,"message":"User does not exist","details":"john.smith@retarus.com"},"id":"paths/~1outbound~1users~1{user}/get/responses/404/content/application~1json/example"},"paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUser":{"value":{"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true},"fax":{"costCenter":"Sales-USA"}},"key":"Mail2FaxUser","summary":"Basic Mail2Fax user","description":"A typical Mail2Fax user with only a user specific cost center and a few personalization values","id":"paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUser"},"paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUserAllOptions":{"value":{"dialing":{"countryCode":1,"areaCode\"":215},"reportEmail":{"language":"es","sender":"faxservice-admin@retarus.com","recipients":"fax-delivered@retarus.com","recipientsIfError":"fax-not-delivered@retarus.com","recipientsCc":"archive-fax@retarus.com","attachTiff":true,"attachTiffOnlyIfError":true,"attachPdf":true,"sortByStatus":"errors-first"},"coverSheet":{"fileName":"retarus-usa-sales-cover.rtf","dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true,"timezone":"US/Eastern"},"fax":{"csid":"Retarus - Sales","costCenter":"Partner-Sales-USA","header":"%0f %d.%m.%Y %H:%M:%S Retarus Partner Sales from %e for %C %r%P/%T","blacklist":false,"paperSize":"letter","resolution":"high","preferredMimeType":"text/plain","attachmentsOnly":true,"suppressBlankPages":true}},"key":"Mail2FaxUserAllOptions","summary":"Mail2Fax user with all options","description":"A Mail2Fax user with all options set within the user","id":"paths/~1outbound~1users~1{user}/put/requestBody/content/application~1json/examples/Mail2FaxUserAllOptions"},"paths/~1outbound~1users~1{user}/put/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1users~1{user}/put/responses/401/content/application~1json/example"},"paths/~1outbound~1users~1{user}/put/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1users~1{user}/put/responses/403/content/application~1json/example"},"paths/~1outbound~1users~1{user}/put/responses/404/content/application~1json/example":{"value":{"code":404,"message":"User does not exist","details":"john.smith@retarus.com"},"id":"paths/~1outbound~1users~1{user}/put/responses/404/content/application~1json/example"},"paths/~1outbound~1users~1{user}/put/responses/409/content/application~1json/example":{"value":{"code":409,"message":null},"id":"paths/~1outbound~1users~1{user}/put/responses/409/content/application~1json/example"},"paths/~1outbound~1users~1{user}/delete/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1users~1{user}/delete/responses/401/content/application~1json/example"},"paths/~1outbound~1users~1{user}/delete/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1users~1{user}/delete/responses/403/content/application~1json/example"},"paths/~1outbound~1users~1{user}/delete/responses/404/content/application~1json/example":{"value":{"code":404,"message":"User does not exist","details":"john.smith@retarus.com"},"id":"paths/~1outbound~1users~1{user}/delete/responses/404/content/application~1json/example"},"paths/~1outbound~1users~1{user}/patch/requestBody/content/application~1json-patch+json/examples/Mail2FaxUserPatch":{"value":{"path":"/fax","value":{"costCenter":"Retarus-Sales-USA"},"op":"add"},"key":"Mail2FaxUserPatch","summary":"Change the cost center","description":"Change the cost center of the Mail2Fax user","id":"paths/~1outbound~1users~1{user}/patch/requestBody/content/application~1json-patch+json/examples/Mail2FaxUserPatch"},"paths/~1outbound~1users~1{user}/patch/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1users~1{user}/patch/responses/401/content/application~1json/example"},"paths/~1outbound~1users~1{user}/patch/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1users~1{user}/patch/responses/403/content/application~1json/example"},"paths/~1outbound~1users~1{user}/patch/responses/404/content/application~1json/example":{"value":{"code":404,"message":"User does not exist","details":"john.smith@retarus.com"},"id":"paths/~1outbound~1users~1{user}/patch/responses/404/content/application~1json/example"},"paths/~1outbound~1users~1{user}/patch/responses/409/content/application~1json/example":{"value":{"code":409,"message":null},"id":"paths/~1outbound~1users~1{user}/patch/responses/409/content/application~1json/example"},"paths/~1outbound~1users/get/responses/200/content/application~1json/examples/Mail2FaxUsers":{"value":[{"email":"john.smith@retarus.com","personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true},"fax":{"costCenter":"Sales-USA"}},{"email":"max.mustermann@retarus.de","personalization":{"department":"Vertrieb","title":"Vertriebsmitarbeiter"},"general":{"client":"default","profile":"default","active":true},"fax":{"costCenter":"Sales-DEU"}}],"key":"Mail2FaxUsers","summary":"List of Mail2Fax users\"","id":"paths/~1outbound~1users/get/responses/200/content/application~1json/examples/Mail2FaxUsers"},"paths/~1outbound~1users/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1users/get/responses/401/content/application~1json/example"},"paths/~1outbound~1users/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1users/get/responses/403/content/application~1json/example"},"paths/~1outbound~1profiles/get/responses/200/content/application~1json/examples/Mail2FaxProfiles":{"value":[{"name":"Retarus-USA-Sales","dialing":{"countryCode":1,"areaCode":201},"reportEmail":{"language":"en"},"coverSheet":{"dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"company":"retarus (North America) Inc."},"general":{"timezone":"US/Eastern"},"fax":{"csid":"Retarus USA","costCenter":"Retarus-USA-Sales","paperSize":"letter"}},{"name":"Retarus-DE-Sales","dialing":{"countryCode":49,"areaCode":89},"reportEmail":{"language":"de"},"coverSheet":{"dateFormat":"dd.MM.yyyy","timeFormat":"HH:mm:ss"},"personalization":{"company":"retarus GmbH."},"general":{"timezone":"Europe/Berlin"},"fax":{"csid":"Retarus GmbH.","costCenter":"Retarus-DE-Sales","paperSize":"A4"}}],"key":"Mail2FaxProfiles","summary":"List of Mail2Fax profiles","id":"paths/~1outbound~1profiles/get/responses/200/content/application~1json/examples/Mail2FaxProfiles"},"paths/~1outbound~1profiles/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1profiles/get/responses/401/content/application~1json/example"},"paths/~1outbound~1profiles/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1profiles/get/responses/403/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfile":{"value":{"name":"Retarus-USA-Sales","dialing":{"countryCode":1,"areaCode":201},"reportEmail":{"language":"en"},"coverSheet":{"dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"company":"retarus (North America) Inc."},"general":{"timezone":"US/Eastern"},"fax":{"csid":"Retarus USA","costCenter":"Retarus-USA-Sales","paperSize":"letter"}},"key":"Mail2FaxProfile","summary":"Basic Mail2Fax profile","id":"paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfile"},"paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfileAllOptions":{"value":{"name":"Retarus-USA-Sales","dialing":{"countryCode":1,"areaCode\"":215},"reportEmail":{"language":"es","sender":"faxservice-admin@retarus.com","recipients":"fax-delivered@retarus.com","recipientsIfError":"fax-not-delivered@retarus.com","recipientsCc":"archive-fax@retarus.com","attachTiff":true,"attachTiffOnlyIfError":true,"attachPdf":true,"sortByStatus":"errors-first"},"coverSheet":{"fileName":"retarus-usa-sales-cover.rtf","dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true,"timezone":"US/Eastern"},"fax":{"csid":"Retarus - Sales","costCenter":"Partner-Sales-USA","header":"%0f %d.%m.%Y %H:%M:%S Retarus Partner Sales from %e for %C %r%P/%T","blacklist":false,"paperSize":"letter","resolution":"high","preferredMimeType":"text/plain","attachmentsOnly":true,"suppressBlankPages":true}},"key":"Mail2FaxProfileAllOptions","summary":"Mail2Fax profile with all options","id":"paths/~1outbound~1profiles~1{profile}/get/responses/200/content/application~1json/examples/Mail2FaxProfileAllOptions"},"paths/~1outbound~1profiles~1{profile}/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1profiles~1{profile}/get/responses/401/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1profiles~1{profile}/get/responses/403/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/get/responses/404/content/application~1json/example":{"value":{"code":404,"message":"Unknown profile"},"id":"paths/~1outbound~1profiles~1{profile}/get/responses/404/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileCreate":{"value":{"serviceType":"Fax2Mail"},"key":"Mail2FaxProfileCreate","summary":"Fax to Email Profile","id":"paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileCreate"},"paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileAllOptionsCreate":{"value":{"dialing":{"countryCode":1,"areaCode\"":215},"reportEmail":{"language":"es","sender":"faxservice-admin@retarus.com","recipients":"fax-delivered@retarus.com","recipientsIfError":"fax-not-delivered@retarus.com","recipientsCc":"archive-fax@retarus.com","attachTiff":true,"attachTiffOnlyIfError":true,"attachPdf":true,"sortByStatus":"errors-first"},"coverSheet":{"fileName":"retarus-usa-sales-cover.rtf","dateFormat":"MM/dd/yyyy","timeFormat":"h:mm a"},"personalization":{"department":"Sales","title":"Sales Representative"},"general":{"client":"default","profile":"default","active":true,"timezone":"US/Eastern"},"fax":{"csid":"Retarus - Sales","costCenter":"Partner-Sales-USA","header":"%0f %d.%m.%Y %H:%M:%S Retarus Partner Sales from %e for %C %r%P/%T","blacklist":false,"paperSize":"letter","resolution":"high","preferredMimeType":"text/plain","attachmentsOnly":true,"suppressBlankPages":true}},"key":"Mail2FaxProfileAllOptionsCreate","summary":"Mail2Fax profile with all options","id":"paths/~1outbound~1profiles~1{profile}/put/requestBody/content/application~1json/examples/Mail2FaxProfileAllOptionsCreate"},"paths/~1outbound~1profiles~1{profile}/put/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1profiles~1{profile}/put/responses/401/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/put/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1profiles~1{profile}/put/responses/403/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/put/responses/404/content/application~1json/example":{"value":{"code":404,"message":"Unknown profile"},"id":"paths/~1outbound~1profiles~1{profile}/put/responses/404/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1profiles~1{profile}/delete/responses/401/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1profiles~1{profile}/delete/responses/403/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example":{"value":{"code":404,"message":"Unknown profile"},"id":"paths/~1outbound~1profiles~1{profile}/delete/responses/404/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/patch/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1outbound~1profiles~1{profile}/patch/responses/401/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/patch/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1outbound~1profiles~1{profile}/patch/responses/403/content/application~1json/example"},"paths/~1outbound~1profiles~1{profile}/patch/responses/404/content/application~1json/example":{"value":{"code":404,"message":"Unknown profile"},"id":"paths/~1outbound~1profiles~1{profile}/patch/responses/404/content/application~1json/example"},"paths/~1joint~1accounts~1{correlation-id}/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"Credentials are required to access this resource."},"id":"paths/~1joint~1accounts~1{correlation-id}/get/responses/401/content/application~1json/example"},"paths/~1joint~1accounts~1{correlation-id}/get/responses/403/content/application~1json/example":{"value":{"code":403,"message":"Forbidden"},"id":"paths/~1joint~1accounts~1{correlation-id}/get/responses/403/content/application~1json/example"}},"securitySchemeStore":{"http-basic-auth":{"id":"http-basic-auth","type":"http","scheme":"basic","description":"HTTP Basic Auth against EAS User Database"}},"servers":[{"url":"/_mock/fax/fax-config-api","isMockServer":true,"description":"Mock server"},{"url":"https://fax-config.de2.retarus.com/v2","description":"Production"}]},"options":{"layout":"stacked","hideSidebar":true,"mockServer":{"url":"/_mock/fax/fax-config-api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/fax/fax-config-api.json?download"},{"url":"/_bundle/fax/fax-config-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Fax Configuration API","description":"The fax configuration API allows you to administer:\n  * Mail to Fax \n  * Fax to Email\n  * Fax to FTP\n  * Fax to Webservice\n"}},"baseSlug":"/fax/fax-config-api","routesMapping":{}}