{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"freefax.BalanceInformations":{"type":"object","description":"Return credit balance informations structure","properties":{"faxs":{"type":"integer","description":"The number of equivalement remaining french faxs"},"points":{"type":"integer","description":"Total balance available in points"}}},"freefax.FreefaxProperties":{"type":"object","description":"Freefax properties","properties":{"faxMaxCall":{"allOf":[{"$ref":"#/components/schemas/telephony.FaxSendingTries"}],"description":"Number of max tentative of fax sending"},"faxQuality":{"allOf":[{"$ref":"#/components/schemas/telephony.FaxQualityEnum"}],"description":"Quality of fax sending"},"faxTagLine":{"type":"string","description":"Customised freefax header"},"fromEmail":{"type":"string","description":"FROM email header"},"fromName":{"type":"string","description":"Name of the sender of the email"},"number":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Freefax number in international format","readOnly":true},"redirectionEmail":{"type":"array","description":"Email address to redirect fax response.","items":{"type":"string"}}}},"freefax.FreefaxPropertiesWithIAM":{"type":"object","description":"Freefax properties","properties":{"faxMaxCall":{"allOf":[{"$ref":"#/components/schemas/telephony.FaxSendingTriesEnum"}],"description":"Number of tries when sending a fax"},"faxQuality":{"allOf":[{"$ref":"#/components/schemas/telephony.FaxQualityEnum"}],"description":"Available quality for fax documents"},"faxTagLine":{"type":"string","description":"Customised freefax header"},"fromEmail":{"type":"string","description":"FROM email header"},"fromName":{"type":"string","description":"Name of the sender of the email"},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"number":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Phone number","readOnly":true},"redirectionEmail":{"type":"array","description":"Email address to redirect fax response.","items":{"type":"string"}}}},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"nichandle.GenderEnum":{"type":"string","description":"All genders a person can choose","enum":["female","male"]},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"service.RenewType":{"type":"object","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","description":"The service is automatically renewed"},"deleteAtExpiration":{"type":"boolean","description":"The service will be deleted at expiration"},"forced":{"type":"boolean","description":"The service forced to be renewed"},"manualPayment":{"type":"boolean","description":"The service needs to be manually renewed and paid","nullable":true},"period":{"type":"integer","description":"period of renew in month","nullable":true}}},"service.RenewalTypeEnum":{"type":"string","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","automaticV2024","manual","oneShot","option"]},"service.StateEnum":{"type":"string","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"]},"services.Service":{"type":"object","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","description":"Indicates that the service can be set up to be deleted at expiration","readOnly":true},"contactAdmin":{"type":"string","readOnly":true},"contactBilling":{"type":"string","readOnly":true},"contactTech":{"type":"string","readOnly":true},"creation":{"type":"string","format":"date","readOnly":true},"domain":{"type":"string","readOnly":true},"engagedUpTo":{"type":"string","nullable":true,"format":"date","readOnly":true},"expiration":{"type":"string","format":"date","readOnly":true},"possibleRenewPeriod":{"type":"array","description":"All the possible renew period of your service in month","nullable":true,"items":{"type":"integer"},"readOnly":true},"renew":{"allOf":[{"$ref":"#/components/schemas/service.RenewType"}],"description":"Way of handling the renew","nullable":true},"renewalType":{"allOf":[{"$ref":"#/components/schemas/service.RenewalTypeEnum"}],"readOnly":true},"serviceId":{"type":"integer","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/service.StateEnum"}],"readOnly":true}}},"telephony.DirectoryHeadingPJ":{"type":"object","description":"Directory Informations","properties":{"apeCode":{"type":"string","readOnly":true},"apeDescription":{"type":"string","readOnly":true},"directoryServiceCode":{"type":"integer","readOnly":true},"directoryServiceDescription":{"type":"string","readOnly":true},"notification":{"type":"string","readOnly":true}}},"telephony.DirectoryInfo":{"type":"object","description":"Directory Informations","properties":{"address":{"type":"string"},"addressExtra":{"type":"string"},"ape":{"type":"string"},"areaCode":{"type":"integer","readOnly":true},"birthDate":{"type":"string","nullable":true,"format":"date"},"cedex":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"directoryServiceCode":{"type":"string"},"displayFirstName":{"type":"boolean"},"displayMarketingDirectory":{"type":"boolean"},"displayOnlyCity":{"type":"boolean"},"displaySearchReverse":{"type":"boolean"},"displayUniversalDirectory":{"type":"boolean"},"email":{"type":"string"},"firstName":{"type":"string"},"gender":{"allOf":[{"$ref":"#/components/schemas/nichandle.GenderEnum"}],"nullable":true},"inseeCode":{"type":"integer","readOnly":true},"legalForm":{"type":"string"},"lineDescription":{"type":"string"},"modificationDate":{"type":"string","readOnly":true},"modificationType":{"type":"string","readOnly":true},"name":{"type":"string"},"number":{"type":"string","readOnly":true},"occupation":{"type":"string"},"postBox":{"type":"string"},"postCode":{"type":"string"},"siret":{"type":"string"},"socialNomination":{"type":"string"},"socialNominationExtra":{"type":"string"},"status":{"type":"string","readOnly":true},"urbanDistrict":{"type":"string"},"wayName":{"type":"string"},"wayNumber":{"type":"string"},"wayNumberExtra":{"type":"string"},"wayType":{"type":"string"}}},"telephony.DirectoryWayType":{"type":"object","description":"Directory way type","properties":{"abbreviatedName":{"type":"string","readOnly":true},"wayName":{"type":"string","readOnly":true}}},"telephony.EntrepriseNumber":{"type":"object","description":"Enterprise number","properties":{"entrepriseNumber":{"type":"string","description":"Entreprise number to fetch information from"}},"required":["entrepriseNumber"]},"telephony.EntrepriseNumberInformations":{"type":"object","description":"Task informations about an entreprise","properties":{"address":{"type":"string","description":"Address of the entreprise","nullable":true},"ape":{"type":"string","description":"Entreprise's category code for directory services","nullable":true},"brand":{"type":"string","description":"Brand of the entreprise","nullable":true},"entrepriseNumber":{"type":"string","description":"Entreprise number"},"isValid":{"type":"boolean","description":"Is this a valid entreprise number?"},"name":{"type":"string","description":"Name of the entreprise"},"siren":{"type":"string","description":"Short version of the entreprise number (FR only)","nullable":true}}},"telephony.EntrepriseNumberInformationsTask":{"type":"object","description":"Task about getting entreprise informations","properties":{"informations":{"allOf":[{"$ref":"#/components/schemas/telephony.EntrepriseNumberInformations"}],"description":"Informations about the enterprise"},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}],"description":"Task status"}}},"telephony.FaxQualityEnum":{"type":"string","description":"Available quality for fax documents","enum":["best","high","normal"]},"telephony.FaxSendingTries":{"type":"integer","description":"Number of tries when sending a fax","enum":[1,2,3,4,5,6,7,8,9]},"telephony.FaxSendingTriesEnum":{"type":"integer","description":"Number of tries when sending a fax","enum":[1,2,3,4,5,6,7,8,9]},"telephony.ServiceVoicemailAudioFormatEnum":{"type":"string","description":"Voicemail audio format","enum":["aiff","au","flac","mp3","ogg","wav"]},"telephony.ServiceVoicemailMailOptionEnum":{"type":"string","description":"Voicemail configuration","enum":["attachment","attachment+transcript","simple","transcript"]},"telephony.ServiceVoicemailNotifications":{"type":"object","description":"Voicemail configuration","properties":{"email":{"type":"string"},"type":{"$ref":"#/components/schemas/telephony.ServiceVoicemailMailOptionEnum"}}},"telephony.TaskStatusEnum":{"type":"string","description":"Task status","enum":["doing","done","error","pause","todo"]},"telephony.VoicefaxRoutingEnum":{"type":"string","description":"All existing type of routing for a voicemail","enum":["fax","voicemail"]},"telephony.VoicemailGreetingEnum":{"type":"string","description":"Greeting type","enum":["default","full","short"]},"telephony.VoicemailNumbers":{"type":"object","description":"Internal and external numbers for voicemail service","properties":{"external":{"type":"string","description":"The external voicemail number"},"internal":{"type":"string","description":"The internal voicemail number"}}},"telephony.VoicemailProperties":{"type":"object","description":"Voicemail Properties","properties":{"annouceMessage":{"type":"string","description":"Name of the voicemail panel announce file","readOnly":true},"audioFormat":{"allOf":[{"$ref":"#/components/schemas/telephony.ServiceVoicemailAudioFormatEnum"}],"description":"Format of the voicemail audio file attached to emails"},"doNotRecord":{"type":"boolean","description":"Don't allow callers to leave voicemails"},"forcePassword":{"type":"boolean","description":"Force password request to access the voicemail panel"},"fromEmail":{"type":"string","description":"Email address from which emails will be sent"},"fromName":{"type":"string","description":"Name from which emails will be sent"},"fullGreetingSoundId":{"type":"integer","description":"Sound ID of the long greeeting","nullable":true},"greetingType":{"allOf":[{"$ref":"#/components/schemas/telephony.VoicemailGreetingEnum"}],"description":"Type of the greeting to play"},"isNewVersion":{"type":"boolean","description":"Current voicemail version","readOnly":true},"keepMessage":{"type":"boolean","description":"Don't delete voicemails after they've been sent by email"},"redirectionEmails":{"type":"array","description":"Email addresses to notify when a new voicemail is left","items":{"$ref":"#/components/schemas/telephony.ServiceVoicemailNotifications"}},"shortGreetingSoundId":{"type":"integer","description":"Sound ID of the short greeting played before an automated message","nullable":true},"temporaryGreetingActivated":{"type":"boolean","description":"Play the temporary greeting instead of the regular one"},"temporaryGreetingSoundId":{"type":"integer","description":"Sound ID of the temporary greeeting","nullable":true},"unreadMessages":{"type":"integer","description":"Quantity of unread voicemails","readOnly":true}}},"telephony.voicemail.ChangePassword":{"type":"object","description":"Change voicemail password","properties":{"password":{"type":"string","description":"The password","format":"password"}},"required":["password"]},"telephony.voicemail.ChangeRouting":{"type":"object","description":"Change voicemail routing","properties":{"routing":{"allOf":[{"$ref":"#/components/schemas/telephony.VoicefaxRoutingEnum"}],"description":"All existing type of routing for a voicemail"}},"required":["routing"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/freefax":{"get":{"summary":"List Freefax line accounts","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/phoneNumber"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:get","required":true}],"x-expanded-response":"FreefaxFreefaxPropertiesWithIAM"}},"/freefax/credits":{"get":{"summary":"Get the credit balance and the remaining pages available for all our freefax","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/freefax.BalanceInformations"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/credits\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/credits\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:freefax/credits/get","required":true}]}},"/freefax/{serviceName}":{"get":{"summary":"Get Freefax information","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/freefax.FreefaxPropertiesWithIAM"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:get","required":true}]},"put":{"summary":"Edit the Freefax properties","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/freefax.FreefaxProperties"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: freefax.FreefaxProperties\nresult = client.put(\"/freefax/{serviceName}\",\n\tfaxMaxCall = None, # Number of max tentative of fax sending (type: telephony.FaxSendingTries)\n\tfaxQuality = None, # Quality of fax sending (type: telephony.FaxQualityEnum)\n\tfaxTagLine = None, # Customised freefax header (type: string)\n\tfromEmail = None, # FROM email header (type: string)\n\tfromName = None, # Name of the sender of the email (type: string)\n\tredirectionEmail = None, # Email address to redirect fax response. (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: freefax.FreefaxProperties\n$result = $ovh->put(\"/freefax/{serviceName}\", array(\n\tfaxMaxCall => null, // Number of max tentative of fax sending (type: telephony.FaxSendingTries)\n\tfaxQuality => null, // Quality of fax sending (type: telephony.FaxQualityEnum)\n\tfaxTagLine => null, // Customised freefax header (type: string)\n\tfromEmail => null, // FROM email header (type: string)\n\tfromName => null, // Name of the sender of the email (type: string)\n\tredirectionEmail => null, // Email address to redirect fax response. (type: array)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:put","required":true}]}},"/freefax/{serviceName}/changePassword":{"post":{"summary":"Generates a new password for your fax account","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string","format":"password"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/freefax/{serviceName}/changePassword\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/freefax/{serviceName}/changePassword\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:changePassword","required":true}]}},"/freefax/{serviceName}/directory":{"get":{"summary":"Get Freefax directory information","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.DirectoryInfo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}/directory\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}/directory\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:directory/get","required":true}]},"put":{"summary":"Edit Freefax directory information","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.DirectoryInfo"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: telephony.DirectoryInfo\nresult = client.put(\"/freefax/{serviceName}/directory\",\n\taddress = None, #  (type: string)\n\taddressExtra = None, #  (type: string)\n\tape = None, #  (type: string)\n\tbirthDate = None, #  (type: string, nullable)\n\tcedex = None, #  (type: string)\n\tcity = None, #  (type: string)\n\tcountry = None, #  (type: string)\n\tdirectoryServiceCode = None, #  (type: string)\n\tdisplayFirstName = None, #  (type: boolean)\n\tdisplayMarketingDirectory = None, #  (type: boolean)\n\tdisplayOnlyCity = None, #  (type: boolean)\n\tdisplaySearchReverse = None, #  (type: boolean)\n\tdisplayUniversalDirectory = None, #  (type: boolean)\n\temail = None, #  (type: string)\n\tfirstName = None, #  (type: string)\n\tgender = None, #  (type: nichandle.GenderEnum, nullable)\n\tlegalForm = None, #  (type: string)\n\tlineDescription = None, #  (type: string)\n\tname = None, #  (type: string)\n\toccupation = None, #  (type: string)\n\tpostBox = None, #  (type: string)\n\tpostCode = None, #  (type: string)\n\tsiret = None, #  (type: string)\n\tsocialNomination = None, #  (type: string)\n\tsocialNominationExtra = None, #  (type: string)\n\turbanDistrict = None, #  (type: string)\n\twayName = None, #  (type: string)\n\twayNumber = None, #  (type: string)\n\twayNumberExtra = None, #  (type: string)\n\twayType = None, #  (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.DirectoryInfo\n$result = $ovh->put(\"/freefax/{serviceName}/directory\", array(\n\taddress => null, //  (type: string)\n\taddressExtra => null, //  (type: string)\n\tape => null, //  (type: string)\n\tbirthDate => null, //  (type: string, nullable)\n\tcedex => null, //  (type: string)\n\tcity => null, //  (type: string)\n\tcountry => null, //  (type: string)\n\tdirectoryServiceCode => null, //  (type: string)\n\tdisplayFirstName => null, //  (type: boolean)\n\tdisplayMarketingDirectory => null, //  (type: boolean)\n\tdisplayOnlyCity => null, //  (type: boolean)\n\tdisplaySearchReverse => null, //  (type: boolean)\n\tdisplayUniversalDirectory => null, //  (type: boolean)\n\temail => null, //  (type: string)\n\tfirstName => null, //  (type: string)\n\tgender => null, //  (type: nichandle.GenderEnum, nullable)\n\tlegalForm => null, //  (type: string)\n\tlineDescription => null, //  (type: string)\n\tname => null, //  (type: string)\n\toccupation => null, //  (type: string)\n\tpostBox => null, //  (type: string)\n\tpostCode => null, //  (type: string)\n\tsiret => null, //  (type: string)\n\tsocialNomination => null, //  (type: string)\n\tsocialNominationExtra => null, //  (type: string)\n\turbanDistrict => null, //  (type: string)\n\twayName => null, //  (type: string)\n\twayNumber => null, //  (type: string)\n\twayNumberExtra => null, //  (type: string)\n\twayType => null, //  (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:directory/edit","required":true}]}},"/freefax/{serviceName}/directory/fetchEntrepriseInformations":{"post":{"summary":"Get enterprise information by providing enterprise number","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.EntrepriseNumber"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.EntrepriseNumberInformationsTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: telephony.EntrepriseNumber\nresult = client.post(\"/freefax/{serviceName}/directory/fetchEntrepriseInformations\",\n\tentrepriseNumber = None, # Entreprise number to fetch information from (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.EntrepriseNumber\n$result = $ovh->post(\"/freefax/{serviceName}/directory/fetchEntrepriseInformations\", array(\n\tentrepriseNumber => null, // Entreprise number to fetch information from (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:directory/fetchEntrepriseInformations","required":true}]}},"/freefax/{serviceName}/directory/getDirectoryServiceCode":{"get":{"summary":"Get directory service code from an APE code (principal activity of the firm code)","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"apeCode","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/telephony.DirectoryHeadingPJ"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}/directory/getDirectoryServiceCode\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}/directory/getDirectoryServiceCode\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:directory/getDirectoryServiceCode","required":true}]}},"/freefax/{serviceName}/directory/getWayTypes":{"get":{"summary":"Get all the way types available","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/telephony.DirectoryWayType"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}/directory/getWayTypes\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}/directory/getWayTypes\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:directory/getWayTypes","required":true}]}},"/freefax/{serviceName}/mainService":{"get":{"summary":"Get main service attached to the Freefax","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}/mainService\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}/mainService\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:mainService/get","required":true}]}},"/freefax/{serviceName}/serviceInfos":{"get":{"summary":"Get service information","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}/serviceInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:serviceInfos/get","required":true}]},"put":{"summary":"Update service information","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: services.Service\nresult = client.put(\"/freefax/{serviceName}/serviceInfos\",\n\trenew = None, # Way of handling the renew (type: service.RenewType, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: services.Service\n$result = $ovh->put(\"/freefax/{serviceName}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:serviceInfos/edit","required":true}]}},"/freefax/{serviceName}/voicemail":{"get":{"summary":"Get the Freefax voicemail information","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.VoicemailProperties"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}/voicemail\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}/voicemail\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:voicemail/get","required":true}]},"put":{"summary":"Edit the Freefax voicemail","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.VoicemailProperties"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: telephony.VoicemailProperties\nresult = client.put(\"/freefax/{serviceName}/voicemail\",\n\taudioFormat = None, # Format of the voicemail audio file attached to emails (type: telephony.ServiceVoicemailAudioFormatEnum)\n\tdoNotRecord = None, # Don't allow callers to leave voicemails (type: boolean)\n\tforcePassword = None, # Force password request to access the voicemail panel (type: boolean)\n\tfromEmail = None, # Email address from which emails will be sent (type: string)\n\tfromName = None, # Name from which emails will be sent (type: string)\n\tfullGreetingSoundId = None, # Sound ID of the long greeeting (type: integer, nullable)\n\tgreetingType = None, # Type of the greeting to play (type: telephony.VoicemailGreetingEnum)\n\tkeepMessage = None, # Don't delete voicemails after they've been sent by email (type: boolean)\n\tredirectionEmails = None, # Email addresses to notify when a new voicemail is left (type: array)\n\tshortGreetingSoundId = None, # Sound ID of the short greeting played before an automated message (type: integer, nullable)\n\ttemporaryGreetingActivated = None, # Play the temporary greeting instead of the regular one (type: boolean)\n\ttemporaryGreetingSoundId = None, # Sound ID of the temporary greeeting (type: integer, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.VoicemailProperties\n$result = $ovh->put(\"/freefax/{serviceName}/voicemail\", array(\n\taudioFormat => null, // Format of the voicemail audio file attached to emails (type: telephony.ServiceVoicemailAudioFormatEnum)\n\tdoNotRecord => null, // Don't allow callers to leave voicemails (type: boolean)\n\tforcePassword => null, // Force password request to access the voicemail panel (type: boolean)\n\tfromEmail => null, // Email address from which emails will be sent (type: string)\n\tfromName => null, // Name from which emails will be sent (type: string)\n\tfullGreetingSoundId => null, // Sound ID of the long greeeting (type: integer, nullable)\n\tgreetingType => null, // Type of the greeting to play (type: telephony.VoicemailGreetingEnum)\n\tkeepMessage => null, // Don't delete voicemails after they've been sent by email (type: boolean)\n\tredirectionEmails => null, // Email addresses to notify when a new voicemail is left (type: array)\n\tshortGreetingSoundId => null, // Sound ID of the short greeting played before an automated message (type: integer, nullable)\n\ttemporaryGreetingActivated => null, // Play the temporary greeting instead of the regular one (type: boolean)\n\ttemporaryGreetingSoundId => null, // Sound ID of the temporary greeeting (type: integer, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:voicemail/edit","required":true}]}},"/freefax/{serviceName}/voicemail/changePassword":{"post":{"summary":"Change the voicemail password. It must be 4 digit","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.voicemail.ChangePassword"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: telephony.voicemail.ChangePassword\nresult = client.post(\"/freefax/{serviceName}/voicemail/changePassword\",\n\tpassword = None, # The password (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.voicemail.ChangePassword\n$result = $ovh->post(\"/freefax/{serviceName}/voicemail/changePassword\", array(\n\tpassword => null, // The password (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:voicemail/changePassword","required":true}]}},"/freefax/{serviceName}/voicemail/changeRouting":{"post":{"summary":"Disable/Enable voicemail. Available only if the line has fax capabilities","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.voicemail.ChangeRouting"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: telephony.voicemail.ChangeRouting\nresult = client.post(\"/freefax/{serviceName}/voicemail/changeRouting\",\n\trouting = None, # All existing type of routing for a voicemail (type: telephony.VoicefaxRoutingEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.voicemail.ChangeRouting\n$result = $ovh->post(\"/freefax/{serviceName}/voicemail/changeRouting\", array(\n\trouting => null, // All existing type of routing for a voicemail (type: telephony.VoicefaxRoutingEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:voicemail/changeRouting","required":true}]}},"/freefax/{serviceName}/voicemail/routing":{"get":{"summary":"Get the status of the voicemail. Available only if the line has fax capabilities","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.VoicefaxRoutingEnum"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}/voicemail/routing\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}/voicemail/routing\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:voicemail/routing/get","required":true}]}},"/freefax/{serviceName}/voicemail/voicemailNumbers":{"get":{"summary":"Get number for internal and external voicemail","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"$ref":"#/components/schemas/phoneNumber"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.VoicemailNumbers"}}}}},"x-developer-hub-navigation":[["Web Cloud","Fax"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/freefax/{serviceName}/voicemail/voicemailNumbers\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/freefax/{serviceName}/voicemail/voicemailNumbers\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"freefax:apiovh:voicemail/voicemailNumbers/get","required":true}]}}}}