npm - n8n-nodes-infomaniak-api - Versions diffs - 0.1.0 - Mend

n8n-nodes-infomaniak-api 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (106) hide show

package/dist/api/infomaniak_api_mail.json ADDED Viewed

@@ -0,0 +1 @@

+ {"openapi":"3.1.0","info":{"title":"API Reference - Developer tools","termsOfService":"https:\/\/www.infomaniak.com\/en\/legal\/general-terms-and-conditions","contact":{"name":"Infomaniak Support","url":"https:\/\/developer.infomaniak.com\/","email":"support@infomaniak.com"},"license":{"name":"MIT License","url":"https:\/\/developer.infomaniak.com\/license"},"version":"1.0.0"},"servers":[{"url":"https:\/\/api.infomaniak.com"}],"paths":{"\/1\/mail_hostings\/{mail_hosting_id}\/bimi":{"post":{"tags":["Service Mail > Bimi"],"summary":"Create\/Update Bimi","description":"Create or update (if you already have one) the bimi associated to the mail service","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"link_logo":{"title":"link_logo","type":"string","format":"binary"},"link_vmc":{"title":"link_vmc","type":"string","format":"binary"},"logo":{"title":"logo","type":"string","format":"binary"},"vmc":{"title":"vmc","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_CreatedorUpdatedBimi","schema":[]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/signatures\/templates":{"get":{"tags":["Service Mail > Signatures templates"],"summary":"List all Templates","description":"List all signatures templates for the given Mail Hosting product","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["name","status"]}},{"$ref":"#\/components\/parameters\/Order","schema":[]},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[name]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_SignatureTemplate","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Service Mail > Signatures templates"],"summary":"Create a template","description":"Create a new signatures templates for the given Mail Hosting product","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["content","name"],"type":"object","properties":{"attributes":{"title":"attributes","type":"object","properties":{"accountName":{"title":"accountName","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"accountRectangleLogoUrl":{"title":"accountRectangleLogoUrl","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"accountSquareLogoUrl":{"title":"accountSquareLogoUrl","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"address":{"title":"address","type":"object","properties":{"keys":{"title":"keys","type":"object","properties":{"additionalAddress":{"title":"additionalAddress","type":"string"},"address":{"title":"address","type":"string"},"city":{"title":"city","type":"string"},"country":{"title":"country","type":"string"},"zipCode":{"title":"zipCode","type":"string"}}},"markers":{"title":"markers","type":"object","properties":{"additionalAddress":{"title":"additionalAddress","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"address":{"title":"address","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"city":{"title":"city","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"country":{"title":"country","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"zipCode":{"title":"zipCode","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"department":{"title":"department","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"firstName":{"title":"firstName","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"job":{"title":"job","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"lastName":{"title":"lastName","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"mail":{"title":"mail","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"name":{"title":"name","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}},"description":"Name of the resource `{name}`"},"phones":{"title":"phones","type":"object","properties":{"keys":{"title":"keys","type":"object","properties":{"list":{"title":"list","type":"string"},"type":{"title":"type","type":"string"},"value":{"title":"value","type":"string"}}},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"url":{"title":"url","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"userAvatarUrl":{"title":"userAvatarUrl","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}}},"example":"[{key:'FIRSTNAME', value:'John', status:'user'}]"},"content":{"title":"content","maxLength":65536,"type":"string","description":"The HTML content that describes the email signature"},"create_signatures":{"title":"create_signatures","type":"boolean","description":"Indicates if the signature should be created for all the users of the mail service."},"created_by":{"title":"created_by","type":"integer","description":" The identifier of the creator of the signature template."},"form_data":{"title":"form_data","type":"object","properties":{"globalStyle":{"title":"globalStyle","type":"object","properties":{"backgroundColor":{"title":"backgroundColor","type":"string"},"displaySeparators":{"title":"displaySeparators","type":"boolean"},"fontColor":{"title":"fontColor","type":"string"},"fontFamily":{"title":"fontFamily","type":"string"},"fontSize":{"title":"fontSize","type":"string"},"iconBackgroundColor":{"title":"iconBackgroundColor","type":"string"},"iconFontColor":{"title":"iconFontColor","enum":["dark","light"],"type":"string"},"linkFontColor":{"title":"linkFontColor","type":"string"}}},"layout":{"title":"layout","type":"object","properties":{"'layout'":{"title":"'layout'","type":"string"}}},"media":{"title":"media","type":"object","properties":{"accountLogoUrlMode":{"title":"accountLogoUrlMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"},"accountRectangleLogoUrl":{"title":"accountRectangleLogoUrl","type":"string"},"accountSquareLogoUrl":{"title":"accountSquareLogoUrl","type":"string"},"userAvatarUrl":{"title":"userAvatarUrl","type":"string"},"userAvatarUrlMode":{"title":"userAvatarUrlMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"}}},"network":{"title":"network","type":"object","properties":{"backgroundColor":{"title":"backgroundColor","type":"string"},"fontColor":{"title":"fontColor","enum":["dark","light"],"type":"string"},"networks":{"title":"networks","type":"array","items":{"title":"item","type":"object","properties":{"name":{"title":"name","enum":["Facebook","Instagram","LinkedIn","X","Youtube"],"type":"string","description":"Name of the resource `{name}`"},"url":{"title":"url","type":"string"}}}}}},"personal":{"title":"personal","type":"object","properties":{"department":{"title":"department","type":"string","description":"The value of the attribute"},"departmentMode":{"title":"departmentMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"firstName":{"title":"firstName","type":"string"},"firstNameMode":{"title":"firstNameMode","enum":["user"],"type":"string"},"hasDepartment":{"title":"hasDepartment","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"hasFirstName":{"title":"hasFirstName","type":"boolean"},"hasJob":{"title":"hasJob","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"hasLastName":{"title":"hasLastName","type":"boolean"},"hasMail":{"title":"hasMail","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"job":{"title":"job","type":"string","description":"The value of the attribute"},"jobMode":{"title":"jobMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"lastName":{"title":"lastName","type":"string"},"lastNameMode":{"title":"lastNameMode","enum":["user"],"type":"string"},"mail":{"title":"mail","type":"string","description":"The value of the attribute"},"mailMode":{"title":"mailMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"},"nameFormat":{"title":"nameFormat","type":"string","description":"The value of the attribute"},"nameFormatMode":{"title":"nameFormatMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"phones":{"title":"phones","type":"array","items":{"title":"item","type":"object","properties":{"type":{"title":"type","enum":["mobile_icon","mobile_letter","none","phone_icon","phone_letter","phone_letter_alt"],"type":"string","description":"Choose the icon associated with the phone number."},"value":{"title":"value","type":"string","description":"The phone number","example":"+33600000000"}}},"description":"List of phone numbers associated with the signature template."}}},"professional":{"title":"professional","type":"object","properties":{"accountName":{"title":"accountName","type":"string"},"accountNameMode":{"title":"accountNameMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"additionalAddress":{"title":"additionalAddress","type":"string"},"address":{"title":"address","type":"string"},"addressMode":{"title":"addressMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"addressUrl":{"title":"addressUrl","type":"string"},"city":{"title":"city","type":"string"},"country":{"title":"country","type":"string"},"url":{"title":"url","type":"string"},"urlMode":{"title":"urlMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"zipCode":{"title":"zipCode","type":"string"}}}}},"name":{"title":"name","maxLength":255,"type":"string","description":"Name of the resource `{name}`"},"name_format":{"title":"name_format","enum":["first_last","first_only","last_first","last_only"],"type":"string","description":"Describes the format in which the name should be displayed.<note>first_last<\/strong>: First_last.<\/note><note>first_only<\/strong>: First_only.<\/note><note>last_first<\/strong>: Last_first.<\/note><note>last_only<\/strong>: Last_only.<\/note>","nullable":true,"example":"first_last"},"notify":{"title":"notify","type":"boolean","description":"Indicates if the notification should be sent for all users of the mail service."},"position":{"title":"position","enum":["bottom","top"],"type":"string","description":"Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.<note>bottom<\/strong>: The signature is placed at the bottom of the email.<\/note><note>top<\/strong>: The signature is placed at the top of the email.<\/note>","example":"bottom"},"status":{"title":"status","enum":["draft","enabled"],"type":"string","description":"Specifies the current status of the signature template. The signature can either be enabled and ready for use, or in draft mode awaiting validation.<note>draft<\/strong>: The signature is in draft mode and cannot be used until it has been validated.<\/note><note>enabled<\/strong>: The signature is enabled and available for use in emails.<\/note>","example":"draft"},"substitutions":{"title":"substitutions","type":"object","properties":{"address":{"title":"address","type":"string","description":" Defines the HTML template that will be applied to each address defined in the form to display them in the email signature template."},"phones":{"title":"phones","type":"string","description":" Defines the HTML template that will be applied to each phone number defined in the form to display them in the email signature template."}},"description":" These values are used to define an HTML template with placeholder values for fields that require multiple substitutions."}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"string"}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/signatures\/templates\/upload":{"post":{"tags":["Service Mail > Signatures templates"],"summary":"Upload image","description":"Upload an image to prepare for insertion in the template","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["image"],"type":"object","properties":{"image":{"title":"image","type":"string","description":"Base64 image content (png,jpg,jpeg,svg or gif MIME type)"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_ImageURL","schema":[]}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_create_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_create_object<\/strong>: Triggered when the entity cannot be created.<\/note>","example":"cannot_create_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/signatures\/templates\/{signature_template}\/create_signatures":{"post":{"tags":["Service Mail > Signatures templates"],"summary":"Create a signature for all users","description":"Create a signature for all the users of the mail service conformed to the template specified","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"signature_template","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/auto_replies":{"get":{"tags":["Service Mail > Auto Reply"],"summary":"List auto replies","description":"Returns list of auto replies models for given service mail","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailResponder","schema":[]}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Service Mail > Auto Reply"],"summary":"Create auto reply","description":"Create new auto reply for given service mail","parameters":[{"description":"ServiceMail identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["is_recurrent","message","name"],"type":"object","properties":{"dont_reply_to":{"title":"dont_reply_to","type":"array","description":"List of emails the auto reply won't respond to","example":"[test@tests.ch]"},"ended_at":{"title":"ended_at","type":"integer","description":"When should end the auto reply activation","nullable":true},"is_recurrent":{"title":"is_recurrent","type":"boolean","description":"Define if the responder should be activate for some days in the week instead of a certain time"},"is_visible":{"title":"is_visible","type":"boolean","description":"Define if the attributes is visible for all the users"},"message":{"title":"message","maxLength":65536,"type":"string"},"name":{"title":"name","type":"string","description":"Name of the resource `{name}`"},"recurrent_days":{"title":"recurrent_days","type":"object","properties":{"friday":{"title":"friday","type":"boolean"},"monday":{"title":"monday","type":"boolean"},"saturday":{"title":"saturday","type":"boolean"},"sunday":{"title":"sunday","type":"boolean"},"thursday":{"title":"thursday","type":"boolean"},"tuesday":{"title":"tuesday","type":"boolean"},"wednesday":{"title":"wednesday","type":"boolean"}},"description":"List of the days when the auto reply is activated"},"started_at":{"title":"started_at","type":"integer","description":"When the responder start to be active","format":"timestamp","nullable":true}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"integer"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/filters":{"get":{"tags":["Service Mail > Filters Models"],"summary":"List filters model","description":"Returns the list of filter model for the given Service Mail\nList all the filter for the specified mail service","parameters":[{"description":"ServiceMail identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailboxSieveFilter","schema":[]}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Service Mail > Filters Models"],"summary":"Create a filter model","description":"Create filters for given Service Mail","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["is_visible","name"],"type":"object","properties":{"actions":{"title":"actions","type":"array","items":{"title":"item","required":["type"],"type":"object","properties":{"type":{"title":"type","enum":["copy","discard","flag_seen","forward","move","stop"],"type":"string"}}}},"conditions":{"title":"conditions","type":"array","items":{"title":"item","required":["operator","property","value"],"type":"object","properties":{"operator":{"title":"operator","type":"string"},"property":{"title":"property","enum":["body","cc","from","reply-to","size","subject","to","x-infomaniak-type"],"type":"string"},"value":{"title":"value","type":"string"}}}},"has_all_conditions":{"title":"has_all_conditions","type":"boolean"},"is_visible":{"title":"is_visible","type":"boolean"},"name":{"title":"name","maxLength":64,"type":"string","description":"Name of the resource `{name}`"},"script":{"title":"script","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailboxSieveFilter","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes":{"get":{"tags":["Mailbox management"],"summary":"List mailboxes","description":"This endpoint allows you to retrieve all the mailboxes for a given mail hosting.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"search","type":"string"},"name":"search","in":"query"},{"style":"form","explode":true,"schema":{"type":"string"},"name":"filter_by","in":"query"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"filter","maxItems":99,"type":"object","properties":{"has_alias":{"title":"has_alias","type":"boolean"},"has_anti_spam":{"title":"has_anti_spam","type":"boolean"},"has_redirection":{"title":"has_redirection","type":"boolean"},"has_responder":{"title":"has_responder","type":"boolean"},"is_using_imap":{"title":"is_using_imap","type":"boolean"},"is_using_pop3":{"title":"is_using_pop3","type":"boolean"},"last_login_at":{"title":"last_login_at","type":"integer","description":"Timestamp `{name}` has been logged"}}},"name":"filter","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Limit","schema":[]},{"$ref":"#\/components\/parameters\/Skip","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["mailIDN","created_at"]}},{"$ref":"#\/components\/parameters\/Order","schema":[]},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[mailIDN]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Mailbox","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailbox management"],"summary":"Add a mailbox","description":"Creates a new mailbox in the mail hosting.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["mailbox_name"],"type":"object","properties":{"link_to_current_user":{"title":"link_to_current_user","type":"boolean"},"mailbox_name":{"title":"mailbox_name","maxLength":64,"type":"string"},"note":{"title":"note","maxLength":80,"type":"string"},"password":{"title":"password","type":"string","description":"This field is not used anymore for selected accounts. This field will be gradually become deprecated over the coming weeks. The method will just ignore this field if your account is selected."},"random_delivery_host":{"title":"random_delivery_host","type":"boolean","nullable":true},"signature_model_id":{"title":"signature_model_id","type":"string","nullable":true},"target":{"title":"target","enum":["current_user","ksuite_user","other_user"],"type":"string","description":"Specifies who has access to the mailbox during its creation.<note>current_user<\/strong>: Only the current user has access to the mailbox.<\/note><note>ksuite_user<\/strong>: All users who are part of the kSuite product can access the mailbox.<\/note><note>other_user<\/strong>: All invited users can have access to the mailbox.<\/note>","example":"current_user"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_CreatedMailbox","schema":[]}}}]}}}},"400":{"description":"Catchall not allow for starter","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["catchall_not_allow_for_starter"],"type":"string","description":"Error code","example":"catchall_not_allow_for_starter"},"description":{"enum":["Catchall not allow for starter"],"type":"string","description":"Description of the error","example":"Catchall not allow for starter"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Catchall not allow for starter":{"summary":"Example","value":{"result":"error","error":{"code":"catchall_not_allow_for_starter","description":"Catchall not allow for starter","errors":[]}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/request_reset_password":{"post":{"tags":["Mailboxes"],"summary":"Request password reset","description":"Request reset of mailbox password\n<note>This endpoint is not available anymore only for selected accounts. Access will be gradually disabled over the coming weeks. Accounts that are already eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["type"],"type":"object","properties":{"email":{"title":"email","maxLength":128,"type":"string","description":"Email"},"phone":{"title":"phone","type":"string"},"type":{"title":"type","enum":["email","email_reminder","phone","phone_reminder","token"],"type":"string","description":"Defines the different types of password reset requests.<note>email<\/strong>: The request will be sent to the specified email address.<\/note><note>email_reminder<\/strong>: The request will be sent to the designated backup email address.<\/note><note>phone<\/strong>: The request will be sent to the specified phone number.<\/note><note>phone_reminder<\/strong>: The request will be sent to the designated backup phone number.<\/note><note>token<\/strong>: The request will return a token in the HTTP response.<\/note>","example":"email"},"user_id":{"title":"user_id","type":"integer"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"oneOf":[{"type":"boolean"},{"$ref":"#\/components\/schemas\/93e74a89_","schema":[]}]}}}]}}}},"400":{"description":"Too many attempts try again in one hour","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["too_many_attempts_try_again_in_one_hour","unexpected_error"],"type":"string","description":"Error code","example":"too_many_attempts_try_again_in_one_hour"},"description":{"enum":["Too many attempts try again in one hour","Unexpected error"],"type":"string","description":"Description of the error","example":"Too many attempts try again in one hour"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Too many attempts try again in one hour":{"summary":"Example","value":{"result":"error","error":{"code":"too_many_attempts_try_again_in_one_hour","description":"Too many attempts try again in one hour","errors":[]}}},"Unexpected error":{"summary":"Example","value":{"result":"error","error":{"code":"unexpected_error","description":"Unexpected error","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailing_lists\/{mailing_list_name}\/subscribers":{"get":{"tags":["Mailing List > Subscribers"],"summary":"All subscribers","description":"Returns a variety of information about one or more Mailing list subscribers from a Unique identifier of the Hosting Mail to request.","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"},{"style":"form","explode":true,"schema":{"title":"search","type":"string"},"name":"search","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["mail_idn","full_name","mailIDN","errors.count","errors.last_error"]}},{"$ref":"#\/components\/parameters\/Order","schema":[]},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[mail_idn]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_MailingListSubscriber","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailing List > Subscribers"],"summary":"Add a new subscriber","description":"Add a new list member for the specified mailing list","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["email"],"type":"object","properties":{"email":{"title":"email","type":"string","description":"Email"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailing List > Subscribers"],"summary":"Remove a subscriber","description":"Remove a subscriber from a Mailing list identified by his email","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"emails":{"title":"emails","type":"array","items":{"title":"item","type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailing List > Subscribers"],"summary":"Update subscriber parameters\/details","description":"Update the email of an existing subscriber identified by his previous email adress","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["email"],"type":"object","properties":{"email":{"title":"email","type":"string","description":"The email that identifies the subscriber."},"new_email":{"title":"new_email","type":"string","description":"The new email for the specified subscriber.","example":"riccardeau@infomaniak.com"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailing_lists\/{mailing_list_name}\/subscribers\/import":{"post":{"tags":["Mailing List > Subscribers"],"summary":"Import subscribers","description":"Add a list of subscriber to the specified mailing list by specifying the fullname and the email for each subscribers","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["datas"],"type":"object","properties":{"datas":{"title":"datas","type":"string","description":"The list of new subscribers email. The format should be email address, name each subscriber separated by a back to line","example":"gigi@infomaniak, Gui \\n ric@infomaniak.com"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["validation_failed"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>validation_failed<\/strong>: Triggered when the input send does not pass the validation rule.<\/note>","example":"validation_failed"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailing_lists":{"get":{"tags":["Mailing List"],"summary":"List all the mailing lists","description":"Returns all the mailing list that are owned by the given email service\n<note>Please note that this may respond a 200 response with swap attributes if the main domain of the mail service is swapping<\/note>","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"oneOf":[{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Mailinglist","schema":[]}},{"$ref":"#\/components\/schemas\/93e74a89_Mailservicecurrentlyunavailableforcauseofswap","schema":[]}]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailing List"],"summary":"Create a mailing list","description":"Creates a new mailing list with for the current mail service with the specified parameters","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["info","is_reply_to_forced","max_message_size","moderators","name","should_send_notifications","subject","use_reply_to","who_can_send","who_can_subscribe"],"type":"object","properties":{"goodbye_message":{"title":"goodbye_message","maxLength":4096,"type":"string","nullable":true},"info":{"title":"info","type":"string"},"is_reply_to_forced":{"title":"is_reply_to_forced","type":"boolean","description":"Tells if the mail of the sender is replaced by the mailing list mail"},"lang":{"title":"lang","enum":["de","en","es","fr","it"],"type":"string","description":"Current language preference code.<note>de<\/strong>: German language.<\/note><note>en<\/strong>: English language.<\/note><note>es<\/strong>: Spanish language.<\/note><note>fr<\/strong>: French language.<\/note><note>it<\/strong>: Italian language.<\/note>","nullable":true,"example":"de"},"max_message_size":{"title":"max_message_size","maximum":209715200,"minimum":1024,"type":"integer"},"moderators":{"title":"moderators","type":"string"},"name":{"title":"name","maxLength":64,"type":"string","description":"Name that identifies the mailing list"},"should_send_notifications":{"title":"should_send_notifications","type":"boolean","description":"Tells if the mailing list should send or not welcome\/goodbye message"},"subject":{"title":"subject","maxLength":300,"type":"string"},"use_reply_to":{"title":"use_reply_to","type":"boolean","description":"Tells if the expeditor's mail is substitute by the mailing list email when responding to it"},"welcome_message":{"title":"welcome_message","maxLength":4096,"type":"string","nullable":true},"who_can_send":{"title":"who_can_send","enum":["0","1","2","3","4","5"],"type":"string","description":"Indicates who can send mails in the mailing list.<note>0<\/strong>: Only moderator and subscriber can send email through the mailing list.<\/note><note>1<\/strong>: Only moderator can send email through the mailing list.<\/note><note>2<\/strong>: Everyone can send email through the mailing list but requires a moderator validation.<\/note><note>3<\/strong>: Only moderator and subscriber can send email through the mailing list but requires a moderator validation.<\/note><note>4<\/strong>: Everyone can send a mail through the mailing list but requires a moderator validation for the mail sent by non subscribers.<\/note><note>5<\/strong>: Everyone can send a mail through the mailing list.<\/note>","example":"0"},"who_can_subscribe":{"title":"who_can_subscribe","enum":["0","1","2"],"type":"string","description":"The subscription policy setup for the mailing list.<note>0<\/strong>: Anybody can subscribe.<\/note><note>1<\/strong>: Any new subscription should be confirmed by the owner.<\/note><note>2<\/strong>: Any new subscription should be confirmed by the owner and the subscriber.<\/note>","example":"0"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"string"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/ask_password":{"post":{"tags":["Mailboxes"],"summary":"Ask password to admin.","description":"Ask mailbox password copy or reset by sending a notification to the admins of the service mail\n<note>This endpoint is not available anymore only for selected accounts. Access will be gradually disabled over the coming weeks. Accounts that are already eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/invitations":{"post":{"tags":["Mailboxes > Users"],"summary":"Add an invitation","description":"Create a new invitation of a given mailbox linked to the current user\n<note>This endpoint is not available anymore only for selected accounts. Access will be gradually disabled over the coming weeks. Accounts that are already eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["permissions"],"type":"object","properties":{"firstname":{"title":"firstname","type":"string"},"force_email":{"title":"force_email","type":"integer"},"lastname":{"title":"lastname","type":"string"},"permissions":{"title":"permissions","type":"object","properties":{"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_manage_chat":{"title":"can_manage_chat","type":"boolean"},"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"}}},"send_email":{"title":"send_email","type":"boolean"},"signature_template_id":{"title":"signature_template_id","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_Invitationtoamailbox","schema":[]}}}]}}}},"400":{"description":"Mailbox is blocked","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["mailbox_is_blocked"],"type":"string","description":"Error code","example":"mailbox_is_blocked"},"description":{"enum":["Mailbox is blocked"],"type":"string","description":"Description of the error","example":"Mailbox is blocked"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Mailbox is blocked":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_is_blocked","description":"Mailbox is blocked","errors":[]}}}}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/filters\/set_activation":{"put":{"tags":["Mailboxes > Sieve filters"],"summary":"Enable \/ disable filter","description":"Enable or disable the filter of a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["is_enabled","name"],"type":"object","properties":{"is_enabled":{"title":"is_enabled","type":"boolean","description":"Specify if the filter is enabled or disabled"},"name":{"title":"name","type":"string","description":"Name of the filter"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Sieve load error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_filter_name","invalid_mailbox_password","mailbox_not_linked_to_current_user","sieve_load_error"],"type":"string","description":"Error code","example":"sieve_load_error"},"description":{"enum":["Invalid filter name","Invalid mailbox password","Mailbox not linked to current user","Sieve load error"],"type":"string","description":"Description of the error","example":"Sieve load error"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Sieve load error":{"summary":"Example","value":{"result":"error","error":{"code":"sieve_load_error","description":"Sieve load error","errors":[]}}},"Invalid filter name":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_filter_name","description":"Invalid filter name","errors":[]}}},"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/filters\/reorder":{"put":{"tags":["Mailboxes > Sieve filters"],"summary":"Reorder filters","description":"Reorder the filters of a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["order"],"type":"object","properties":{"order":{"title":"order","type":"array","items":{"title":"item","type":"string"},"description":"The new order of the filter referenced by their name","example":"[\"test1\",\"test2\"]"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Sieve load error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_filters","invalid_mailbox_password","mailbox_not_linked_to_current_user","sieve_load_error"],"type":"string","description":"Error code","example":"sieve_load_error"},"description":{"enum":["Invalid mailbox filters","Invalid mailbox password","Mailbox not linked to current user","Sieve load error"],"type":"string","description":"Description of the error","example":"Sieve load error"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Sieve load error":{"summary":"Example","value":{"result":"error","error":{"code":"sieve_load_error","description":"Sieve load error","errors":[]}}},"Invalid mailbox filters":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_filters","description":"Invalid mailbox filters","errors":[]}}},"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/filters":{"get":{"tags":["Mailboxes > Sieve filters"],"summary":"List filters","description":"Retrieve the sieve filters of a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_MailboxSieveFilter","schema":[]}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailboxes > Sieve filters"],"summary":"Add a filter","description":"Add a filter to the given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["actions","conditions","has_all_of","is_enabled","name"],"type":"object","properties":{"actions":{"title":"actions","type":"object","properties":{"create_a_folder":{"title":"create_a_folder","type":"string"},"type":{"title":"type","type":"string"},"value":{"title":"value","enum":["copy","discard","flag_seen","forward","move","stop"],"type":"string"}},"description":"Action to do when the filter is triggered","example":"[{\"type\": \"move\", \"value\": \"Spam\"}]"},"conditions":{"title":"conditions","type":"object","properties":{"operator":{"title":"operator","enum":["begin","contains","end","is","not"],"type":"string"},"property":{"title":"property","enum":["body","cc","from","reply-to","size","subject","to","x-infomaniak-type"],"type":"string"},"value":{"title":"value","type":"string"}},"description":"Condition when the filter is triggered","example":"[{\"property\": \"from\", \"operator\": \"contains\", \"value\": \"example_value\"}]"},"has_all_of":{"title":"has_all_of","type":"boolean","description":"Indicates if all the condition are needed or if just one is sufficient"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Indicates if the filter is enabled"},"name":{"title":"name","type":"string","description":"Name of the filter"},"template_id":{"title":"template_id","type":"integer","nullable":true}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Sieve filters"],"summary":"Delete a filter","description":"Delete a filter from the given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["name"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of the filter"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Sieve load error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user","sieve_load_error"],"type":"string","description":"Error code","example":"sieve_load_error"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user","Sieve load error"],"type":"string","description":"Description of the error","example":"Sieve load error"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Sieve load error":{"summary":"Example","value":{"result":"error","error":{"code":"sieve_load_error","description":"Sieve load error","errors":[]}}},"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailboxes > Sieve filters"],"summary":"Update a filter","description":"Update the filter of a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["actions","conditions","has_all_of","is_enabled","name","old_name"],"type":"object","properties":{"actions":{"title":"actions","type":"object","properties":{"create_a_folder":{"title":"create_a_folder","type":"string"},"type":{"title":"type","type":"string"},"value":{"title":"value","enum":["copy","discard","flag_seen","forward","move","stop"],"type":"string"}},"description":"Action to do when the filter is triggered","example":"[{\"type\": \"move\", \"value\": \"Spam\"}]"},"conditions":{"title":"conditions","type":"object","properties":{"operator":{"title":"operator","enum":["begin","contains","end","is","not"],"type":"string"},"property":{"title":"property","enum":["body","cc","from","reply-to","size","subject","to","x-infomaniak-type"],"type":"string"},"value":{"title":"value","type":"string"}},"description":"Condition when the filter is triggered","example":"[{\"property\": \"from\", \"operator\": \"contains\", \"value\": \"example_value\"}]"},"has_all_of":{"title":"has_all_of","type":"boolean","description":"Indicates if all the condition are needed or if just one is sufficient"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Indicates if the filter is enabled"},"name":{"title":"name","type":"string","description":"Name of the filter"},"old_name":{"title":"old_name","type":"string","description":"The actual name of the filter"},"template_id":{"title":"template_id","type":"integer","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/filters\/scripts":{"post":{"tags":["Mailboxes > Sieve filters"],"summary":"Add a script","description":"Add a sieve script to a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["content","name"],"type":"object","properties":{"content":{"title":"content","type":"string","description":"Filter script content","example":"if header :contains \"Subject\" \"Urgent\" {stop;}"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Specify if the script is enabled or disabled"},"name":{"title":"name","type":"string","description":"Filter script name"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_create_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_create_object<\/strong>: Triggered when the entity cannot be created.<\/note>","example":"cannot_create_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Sieve filters"],"summary":"Delete a script","description":"Delete a sieve script from the given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["name"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Filter name"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid filter script name","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_filter_script_name","invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_filter_script_name"},"description":{"enum":["Invalid filter script name","Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid filter script name"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid filter script name":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_filter_script_name","description":"Invalid filter script name","errors":[]}}},"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailboxes > Sieve filters"],"summary":"Update a script","description":"Update a sieve script for a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["content","is_enabled","name","old_name"],"type":"object","properties":{"content":{"title":"content","type":"string","description":"Filter script content","example":"if header :contains \"Subject\" \"Urgent\" {stop;}"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Specify if the script is enabled or disabled"},"name":{"title":"name","type":"string","description":"Filter script name"},"old_name":{"title":"old_name","type":"string","description":"Filter actual name identifier"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/filters\/scripts\/set_activation":{"put":{"tags":["Mailboxes > Sieve filters"],"summary":"Enable \/ disable script","description":"Enable \/ disable a filter script for a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["is_enabled","name"],"type":"object","properties":{"is_enabled":{"title":"is_enabled","type":"boolean","description":"Script is active or not"},"name":{"title":"name","type":"string","description":"Script actual name identifier"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid filter script name","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_filter_script_name","invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_filter_script_name"},"description":{"enum":["Invalid filter script name","Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid filter script name"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid filter script name":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_filter_script_name","description":"Invalid filter script name","errors":[]}}},"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/filters\/scripts\/import":{"put":{"tags":["Mailboxes > Sieve filters"],"summary":"Import .siv file","description":"Import .siv file in a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["file","name"],"type":"object","properties":{"file":{"title":"file","type":"string","description":"Base64 Filter script content"},"name":{"title":"name","type":"string","description":"Filter script name"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid filter script name","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["import_filter_script_error","invalid_filter_script_name","invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_filter_script_name"},"description":{"enum":["Import filter script error","Invalid filter script name","Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid filter script name"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid filter script name":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_filter_script_name","description":"Invalid filter script name","errors":[]}}},"Import filter script error":{"summary":"Example","value":{"result":"error","error":{"code":"import_filter_script_error","description":"Import filter script error","errors":[]}}},"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_create_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_create_object<\/strong>: Triggered when the entity cannot be created.<\/note>","example":"cannot_create_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/folders":{"get":{"tags":["Mailboxes > Folders"],"summary":"List folders","description":"Retrieves the folders of a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_MailboxFolders","schema":[]}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Mailboxes > Folders"],"summary":"Update folders","description":"Updates the folder mapping configuration for the draft, trash, sent an spam folders of a given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["archives_folder","draft_folder","sent_folder","trash_folder"],"type":"object","properties":{"archives_folder":{"title":"archives_folder","type":"string"},"commercials_folder":{"title":"commercials_folder","type":"string","description":"The location where the referenced commercial mail goes. Required if the option is activated on the mailbox","nullable":true},"draft_folder":{"title":"draft_folder","type":"string"},"sent_folder":{"title":"sent_folder","type":"string"},"social_networks_folder":{"title":"social_networks_folder","type":"string","description":"The location where the referenced social mails are placed. Required if the option is activated on the mailbox","nullable":true},"spam_folder":{"title":"spam_folder","type":"string","description":"The location where all the spam labelled mail are stored.Required if the spam filter is activated on the mailbox.","nullable":true},"trash_folder":{"title":"trash_folder","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_folders","invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox folders","Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}},"Invalid mailbox folders":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_folders","description":"Invalid mailbox folders","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/signatures\/set_defaults":{"post":{"tags":["Mailboxes > Signatures"],"summary":"Set default signature","description":"Set default signature for send and reply","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"default_reply_signature_id":{"title":"default_reply_signature_id","type":"integer","nullable":true},"default_signature_id":{"title":"default_signature_id","type":"integer","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/signatures":{"get":{"tags":["Mailboxes > Signatures"],"summary":"List all Signatures","description":"List all signatures for the given Mailbox","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_MailboxSignature","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailboxes > Signatures"],"summary":"Create signature","description":"Create a new signatures for the given MailHosting product","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["name"],"type":"object","properties":{"content":{"title":"content","type":"string","nullable":true},"form_data":{"title":"form_data","type":"object","properties":{"globalStyle":{"title":"globalStyle","type":"object","properties":{"backgroundColor":{"title":"backgroundColor","type":"string"},"displaySeparators":{"title":"displaySeparators","type":"boolean"},"fontColor":{"title":"fontColor","type":"string"},"fontFamily":{"title":"fontFamily","type":"string"},"fontSize":{"title":"fontSize","type":"string"},"iconBackgroundColor":{"title":"iconBackgroundColor","type":"string"},"iconFontColor":{"title":"iconFontColor","enum":["dark","light"],"type":"string"},"linkFontColor":{"title":"linkFontColor","type":"string"}}},"layout":{"title":"layout","type":"object","properties":{"'layout'":{"title":"'layout'","type":"string"}}},"media":{"title":"media","type":"object","properties":{"accountLogoUrlMode":{"title":"accountLogoUrlMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"},"accountRectangleLogoUrl":{"title":"accountRectangleLogoUrl","type":"string"},"accountSquareLogoUrl":{"title":"accountSquareLogoUrl","type":"string"},"userAvatarUrl":{"title":"userAvatarUrl","type":"string"},"userAvatarUrlMode":{"title":"userAvatarUrlMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"}}},"network":{"title":"network","type":"object","properties":{"backgroundColor":{"title":"backgroundColor","type":"string"},"fontColor":{"title":"fontColor","enum":["dark","light"],"type":"string"},"networks":{"title":"networks","type":"array","items":{"title":"item","type":"object","properties":{"name":{"title":"name","enum":["Facebook","Instagram","LinkedIn","X","Youtube"],"type":"string","description":"Name of the resource `{name}`"},"url":{"title":"url","type":"string"}}}}}},"personal":{"title":"personal","type":"object","properties":{"department":{"title":"department","type":"string","description":"The value of the attribute"},"departmentMode":{"title":"departmentMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"firstName":{"title":"firstName","type":"string"},"firstNameMode":{"title":"firstNameMode","enum":["user"],"type":"string"},"hasDepartment":{"title":"hasDepartment","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"hasFirstName":{"title":"hasFirstName","type":"boolean"},"hasJob":{"title":"hasJob","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"hasLastName":{"title":"hasLastName","type":"boolean"},"hasMail":{"title":"hasMail","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"job":{"title":"job","type":"string","description":"The value of the attribute"},"jobMode":{"title":"jobMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"lastName":{"title":"lastName","type":"string"},"lastNameMode":{"title":"lastNameMode","enum":["user"],"type":"string"},"mail":{"title":"mail","type":"string","description":"The value of the attribute"},"mailMode":{"title":"mailMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"},"nameFormat":{"title":"nameFormat","type":"string","description":"The value of the attribute"},"nameFormatMode":{"title":"nameFormatMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"phones":{"title":"phones","type":"array","items":{"title":"item","type":"object","properties":{"type":{"title":"type","enum":["mobile_icon","none","phone_icon","phone_letter","phone_letter_alt"],"type":"string","description":"Choose the icon associated with the phone number."},"value":{"title":"value","type":"string","description":"The phone number","example":"+33600000000"}}},"description":"List of phone numbers associated with the signature template."}}},"professional":{"title":"professional","type":"object","properties":{"accountName":{"title":"accountName","type":"string"},"accountNameMode":{"title":"accountNameMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"additionalAddress":{"title":"additionalAddress","type":"string"},"address":{"title":"address","type":"string"},"addressMode":{"title":"addressMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"addressUrl":{"title":"addressUrl","type":"string"},"city":{"title":"city","type":"string"},"country":{"title":"country","type":"string"},"url":{"title":"url","type":"string"},"urlMode":{"title":"urlMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"zipCode":{"title":"zipCode","type":"string"}}}}},"fullname":{"title":"fullname","type":"string"},"has_infomaniak_footer":{"title":"has_infomaniak_footer","type":"boolean"},"is_available_for_all":{"title":"is_available_for_all","type":"boolean"},"is_default":{"title":"is_default","type":"boolean","example":true},"name":{"title":"name","maxLength":255,"type":"string","description":"Name of the resource `{name}`"},"position":{"title":"position","enum":["bottom","top"],"type":"string","description":"Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.<note>bottom<\/strong>: The signature is placed at the bottom of the email.<\/note><note>top<\/strong>: The signature is placed at the top of the email.<\/note>","example":"bottom"},"reply_email":{"title":"reply_email","type":"string","nullable":true},"sending_email":{"title":"sending_email","type":"string","nullable":true},"template_id":{"title":"template_id","type":"string","nullable":true},"attributes":{"title":"attributes","type":"object","properties":{"department":{"title":"department","type":"string"},"firstName":{"title":"firstName","type":"string"},"job":{"title":"job","type":"string"},"lastName":{"title":"lastName","type":"string"},"mail":{"title":"mail","type":"string"},"name":{"title":"name","type":"string","description":"Name of the resource `{name}`"},"nameFormat":{"title":"nameFormat","type":"string"},"phones":{"title":"phones","type":"array","items":{"title":"item","type":"object","properties":{"type":{"title":"type","type":"string"},"value":{"title":"value","type":"string"}}}},"userAvatarUrl":{"title":"userAvatarUrl","type":"string"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_Signature","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/signatures\/upload":{"post":{"tags":["Mailboxes > Signatures"],"summary":"Upload image","description":"Upload an image to prepare for insertion in the signature","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["image"],"type":"object","properties":{"image":{"title":"image","type":"string","description":"Base64 image content (png,jpg,jpeg,svg or gif MIME type)"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_ImageURL","schema":[]}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_create_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_create_object<\/strong>: Triggered when the entity cannot be created.<\/note>","example":"cannot_create_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/forwarding_addresses":{"get":{"tags":["Mailboxes > Forwarding"],"summary":"List forwarding","description":"Retrieves information about the forwarding configuration of a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_MailboxRedirection","schema":[]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Mailboxes > Forwarding"],"summary":"Update a forwarding","description":"Update a given mailbox forwarding.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"has_dont_deliver":{"title":"has_dont_deliver","type":"boolean","description":"Indicates if the mailbox should delete emails locally after forwarding them"},"has_forward_spam":{"title":"has_forward_spam","type":"boolean","description":"Indicates if the mailbox should forward mail that are considered to be spam"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Indicates if the redirection is enabled on the mailbox.\\n Warning: setting it to false drop all the existing adresses"},"redirect_addresses":{"title":"redirect_addresses","maxItems":100,"minItems":1,"type":"array","items":{"title":"item","type":"string"},"description":"List of the redirection addresses where the mail are redirected in the mailbox, the maximum is set to 1 if you have a starter pack"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Too much redirections","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["redirect_address_alias_or_mailboxname","too_much_redirections"],"type":"string","description":"Error code","example":"too_much_redirections"},"description":{"enum":["Redirect address alias or mailboxname","Too much redirections"],"type":"string","description":"Description of the error","example":"Too much redirections"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Too much redirections":{"summary":"Example","value":{"result":"error","error":{"code":"too_much_redirections","description":"Too much redirections","errors":[]}}},"Redirect address alias or mailboxname":{"summary":"Example","value":{"result":"error","error":{"code":"redirect_address_alias_or_mailboxname","description":"Redirect address alias or mailboxname","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailboxes > Forwarding"],"summary":"Add a forwarding","description":"Adds a new forwarding address to the given mailbox","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["redirect_address"],"type":"object","properties":{"redirect_address":{"title":"redirect_address","type":"string"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_CreateForwardingResponse","schema":[]}}}]}}}},"400":{"description":"Cannot get redirections addresses","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["cannot_add_redirection","cannot_get_redirections_addresses","cannot_set_redirection_keep","incorrect_redirect_address","max_mailbox_redirection","redirect_address_already_exists"],"type":"string","description":"Error code","example":"cannot_get_redirections_addresses"},"description":{"enum":["Cannot add redirection","Cannot get redirections addresses","Cannot set redirection keep","Incorrect redirect address","Max mailbox redirection","Redirect address already exists"],"type":"string","description":"Description of the error","example":"Cannot get redirections addresses"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Cannot get redirections addresses":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_get_redirections_addresses","description":"Cannot get redirections addresses","errors":[]}}},"Max mailbox redirection":{"summary":"Example","value":{"result":"error","error":{"code":"max_mailbox_redirection","description":"Max mailbox redirection","errors":[]}}},"Redirect address already exists":{"summary":"Example","value":{"result":"error","error":{"code":"redirect_address_already_exists","description":"Redirect address already exists","errors":[]}}},"Incorrect redirect address":{"summary":"Example","value":{"result":"error","error":{"code":"incorrect_redirect_address","description":"Incorrect redirect address","errors":[]}}},"Cannot add redirection":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_add_redirection","description":"Cannot add redirection","errors":[]}}},"Cannot set redirection keep":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_set_redirection_keep","description":"Cannot set redirection keep","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Forwarding"],"summary":"Delete all forwardings","description":"Deletes all configured forwarding addresses of the given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auto_reply\/model":{"get":{"tags":["Mailboxes > Auto reply"],"summary":"List auto replies models","description":"Get auto replies models available for a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailResponder","schema":[]}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailboxes > Auto reply"],"summary":"Add auto reply model","description":"Create an auto replies model for a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["is_recurrent","message","name","reply_from_id"],"type":"object","properties":{"dont_reply_to":{"title":"dont_reply_to","type":"array","description":" List of mail that aren't concerned by the responder","example":"[test@tests.ch]"},"ended_at":{"title":"ended_at","type":"integer","description":"When the responder is supposed to end","format":"timestamp","nullable":true},"is_recurrent":{"title":"is_recurrent","type":"boolean"},"message":{"title":"message","maxLength":65536,"type":"string"},"name":{"title":"name","type":"string","description":"Name the auto reply model"},"recurrent_days":{"title":"recurrent_days","type":"object","properties":{"friday":{"title":"friday","type":"boolean"},"monday":{"title":"monday","type":"boolean"},"saturday":{"title":"saturday","type":"boolean"},"sunday":{"title":"sunday","type":"boolean"},"thursday":{"title":"thursday","type":"boolean"},"tuesday":{"title":"tuesday","type":"boolean"},"wednesday":{"title":"wednesday","type":"boolean"}},"description":"List of the days when the auto reply is activated"},"reply_from_id":{"title":"reply_from_id","type":"integer","description":"Id of the Email that send the auto reply"},"started_at":{"title":"started_at","type":"integer","description":"Dates when the responder has become active","format":"timestamp","nullable":true}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"integer"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auto_reply\/reset":{"put":{"tags":["Mailboxes > Auto reply"],"summary":"Reset an auto reply","description":"Resets the count of automatic replies that were sent per sender.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/aliases":{"get":{"tags":["Mailboxes > Aliases"],"summary":"List aliases","description":"This endpoint allows you to retrieve all the aliases for a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_MailboxAliases","schema":[]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Mailboxes > Aliases"],"summary":"Update aliases","description":"Updates the list of aliases for a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["aliases"],"type":"object","properties":{"aliases":{"title":"aliases","type":"array","items":{"title":"item","maxLength":64,"type":"string"},"description":"List of aliases"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Cannot create alias for generic mailbox","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["alias_limit_reached","cannot_create_alias_for_generic_mailbox","unknown_error"],"type":"string","description":"Error code","example":"cannot_create_alias_for_generic_mailbox"},"description":{"enum":["Alias limit reached","Cannot create alias for generic mailbox","Unknown error"],"type":"string","description":"Description of the error","example":"Cannot create alias for generic mailbox"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Cannot create alias for generic mailbox":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_create_alias_for_generic_mailbox","description":"Cannot create alias for generic mailbox","errors":[]}}},"Alias limit reached":{"summary":"Example","value":{"result":"error","error":{"code":"alias_limit_reached","description":"Alias limit reached","errors":[]}}},"Unknown error":{"summary":"Example","value":{"result":"error","error":{"code":"unknown_error","description":"Unknown error","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailboxes > Aliases"],"summary":"Add an alias","description":"Creates an alias on the given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["alias"],"type":"object","properties":{"alias":{"title":"alias","maxLength":64,"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Cannot create alias for generic mailbox","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["alias_limit_reached","cannot_create_alias_for_generic_mailbox","cannot_create_alias_with_a_redirection"],"type":"string","description":"Error code","example":"cannot_create_alias_for_generic_mailbox"},"description":{"enum":["Alias limit reached","Cannot create alias for generic mailbox","Cannot create alias with a redirection"],"type":"string","description":"Description of the error","example":"Cannot create alias for generic mailbox"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Cannot create alias for generic mailbox":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_create_alias_for_generic_mailbox","description":"Cannot create alias for generic mailbox","errors":[]}}},"Cannot create alias with a redirection":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_create_alias_with_a_redirection","description":"Cannot create alias with a redirection","errors":[]}}},"Alias limit reached":{"summary":"Example","value":{"result":"error","error":{"code":"alias_limit_reached","description":"Alias limit reached","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/redirections":{"get":{"tags":["Service Mail > Redirections"],"summary":"List redirections","description":"Return redirections for the given mail service","parameters":[{"description":"ServiceMail identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"order_by","enum":["created_at","id","name","send_confirmation_requests_enabled","send_confirmation_requests_state","state","updated_at"],"type":"string"},"name":"order_by","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_dir","enum":["asc","desc"],"type":"string"},"name":"order_dir","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Redirection","schema":[]}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Service Mail > Redirections"],"summary":"Create redirection","description":"Create a new redirection with the specified parameters for the current mail service","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["name","targets"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"The name of the redirection, where the emails should be sent."},"targets":{"title":"targets","maxItems":10,"type":"array","items":{"title":"item","maxLength":255,"type":"string"},"description":"Emails that should receive the mail that are redirected"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"string"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/redirections\/{redirection_id}\/targets":{"get":{"tags":["Service Mail > Redirections > Target"],"summary":"Get all targets","description":"This returns all targets email for the specified redirection","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_RedirectionTarget","schema":[]}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Service Mail > Redirections > Target"],"summary":"Add new target","description":"Add a new target email for the specified redirection","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["address"],"type":"object","properties":{"address":{"title":"address","type":"string"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"string"}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Service Mail > Redirections > Target"],"summary":"Remove a target","description":"Remove one target from the redirection list","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"description":"Can be any value - string, number, boolean, array or object."}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/mailboxes\/{mailbox_name}\/accesses\/webmail":{"get":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"List user access and invitations","description":"Returns list of user accesses for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"search","maxLength":255,"minLength":1,"type":"string"},"name":"search","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["user","last_used_at"]}},{"$ref":"#\/components\/parameters\/Order","schema":[]},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[user]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_UserAccessorInvitationtoaccessamailbox","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"Create webmail access","description":"Create a webmail access for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["user_id"],"type":"object","properties":{"permissions":{"title":"permissions","type":"object","properties":{"can_access_logs":{"title":"can_access_logs","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"}}},"user_id":{"title":"user_id","type":"integer"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 409","type":"object","properties":{"code":{"enum":["user_already_has_access_to_mailbox"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>user_already_has_access_to_mailbox<\/strong>: The user already has access to the mailbox.<\/note>","example":"user_already_has_access_to_mailbox"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["user_not_attached_to_account"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>user_not_attached_to_account<\/strong>: The user is not attached to the account.<\/note>","example":"user_not_attached_to_account"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/mailboxes\/{mailbox_name}\/accesses\/webmail\/invitations":{"post":{"tags":["Mailboxes > Accesses > Invitations"],"summary":"Create webmail access link","description":"Create a link to access the mailbox specified in the webmail\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"firstname":{"title":"firstname","type":"string"},"force_email":{"title":"force_email","type":"boolean"},"lastname":{"title":"lastname","type":"string"},"permissions":{"title":"permissions","type":"object","properties":{"can_access_logs":{"title":"can_access_logs","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"}}},"signature_template_id":{"title":"signature_template_id","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_Invitationtoaccessamailbox","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/mailboxes\/{mailbox_name}\/accesses\/webmail\/invitations\/{invitation_webmail}\/send":{"post":{"tags":["Mailboxes > Accesses > Invitations"],"summary":"Send webmail access link by e-mail","description":"Send a link to access the mailbox specified in the webmail by e-mail\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The identifier of the invitation.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"invitation_webmail","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["email"],"type":"object","properties":{"email":{"title":"email","type":"string","description":"Email"},"language":{"title":"language","enum":["de","en","es","fr","it"],"type":"string","description":"Current language preference code.<note>de<\/strong>: German language.<\/note><note>en<\/strong>: English language.<\/note><note>es<\/strong>: Spanish language.<\/note><note>fr<\/strong>: French language.<\/note><note>it<\/strong>: Italian language.<\/note>","example":"de"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"429":{"description":"Response","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 429","type":"object","properties":{"code":{"enum":["invitation_sending_rate_limit_reached"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>invitation_sending_rate_limit_reached<\/strong>: The invitation was already sent in the last minute.<\/note>","example":"invitation_sending_rate_limit_reached"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/mailboxes\/{mailbox_name}\/accesses\/devices":{"get":{"tags":["Mailboxes > Accesses > Devices"],"summary":"List device access","description":"Returns list of device accesses for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"no_user","type":"boolean"},"name":"no_user","in":"query"},{"style":"form","explode":true,"schema":{"title":"search","type":"string"},"name":"search","in":"query"},{"style":"form","explode":true,"schema":{"title":"type","enum":["computer","legacy","other","phone","tablet"],"type":"string","description":"Specifies the type of the device.<note>computer<\/strong>: The device is a computer.<\/note><note>legacy<\/strong>: The device'password is a legacy password used by all users before the feature of multiples password.<\/note><note>other<\/strong>: The device is an other type.<\/note><note>phone<\/strong>: The device is a phone.<\/note><note>tablet<\/strong>: The device is a tablet.<\/note>","example":"computer"},"name":"type","in":"query"},{"style":"form","explode":true,"schema":{"title":"user_id","type":"integer"},"name":"user_id","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["type","label","user"]}},{"$ref":"#\/components\/parameters\/Order","schema":[]},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[type]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_DeviceAccess","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Mailboxes > Accesses > Devices"],"summary":"Create device access","description":"Create a device access for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["protocols"],"type":"object","properties":{"device_id":{"title":"device_id","type":"integer","description":"id of the device used by the mailbox"},"device_uid":{"title":"device_uid","type":"string","description":"UID of the true device used by an access token","nullable":true},"label":{"title":"label","maxLength":255,"type":"string"},"protocols":{"title":"protocols","enum":["imap","pop3","pop3-imap"],"type":"string","description":"Specifies the protocol of the access. By default, all protocol choices include smtp protocol.<note>imap<\/strong>: The protocol is imap.<\/note><note>pop3<\/strong>: The protocol is pop3.<\/note><note>pop3-imap<\/strong>: The protocol is imap and pop3.<\/note>","example":"imap"},"type":{"title":"type","enum":["computer","other","phone","tablet"],"type":"string","description":"Specifies the type of the device.<note>computer<\/strong>: The device is a computer.<\/note><note>other<\/strong>: The device is an other type.<\/note><note>phone<\/strong>: The device is a phone.<\/note><note>tablet<\/strong>: The device is a tablet.<\/note>","example":"computer"},"user_id":{"title":"user_id","type":"integer","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_GeneratedPassword","schema":[]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 409","type":"object","properties":{"code":{"enum":["device_already_has_access_to_mailbox"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>device_already_has_access_to_mailbox<\/strong>: The device already has access to the mailbox.<\/note>","example":"device_already_has_access_to_mailbox"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["existing_device_can_only_have_one_user","legacy_device_creation"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>existing_device_can_only_have_one_user<\/strong>: The device can't give access to many users.<\/note><note>legacy_device_creation<\/strong>: A legacy device can't have more accesses.<\/note>","example":"legacy_device_creation"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Accesses > Devices"],"summary":"Delete device accesses for mailbox","description":"Delete all device accesses on an address\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["legacy_device_deletion"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>legacy_device_deletion<\/strong>: A legacy device can't be deleted by another user.<\/note>","example":"legacy_device_deletion"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/mailboxes\/{mailbox_name}\/accesses\/devices\/{device_access}":{"post":{"tags":["Mailboxes > Accesses > Devices"],"summary":"Regenerate password device access","description":"Regenerate the password of a device access for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the device access to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"device_access","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_GeneratedPassword","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Accesses > Devices"],"summary":"Delete device access","description":"Delete a device access\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the device access to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"device_access","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["legacy_device_deletion"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>legacy_device_deletion<\/strong>: A legacy device can't be deleted by another user.<\/note>","example":"legacy_device_deletion"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/accesses\/webmail\/mailboxes\/{mailbox_id}\/set_primary":{"post":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"Set the primary mailbox for the authenticated user","description":"Returns list of user accesses for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the email address.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mailbox_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["user_has_no_access_to_mailbox"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>user_has_no_access_to_mailbox<\/strong>: The user has no access to the mailbox.<\/note>","example":"user_has_no_access_to_mailbox"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/preferences":{"get":{"tags":["Service Mail > Preferences"],"summary":"List preferences","description":"Returns preferences for given Service Mail","parameters":[{"description":"ServiceMail identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailpreferences","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Service Mail > Preferences"],"summary":"Update preferences","description":"Update preferences for given service Mail","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"authorized_senders":{"title":"authorized_senders","type":"array","items":{"title":"item","type":"string"}},"blocked_senders":{"title":"blocked_senders","type":"array","items":{"title":"item","type":"string"}},"default_permission":{"title":"default_permission","type":"string"},"dkim_enabled":{"title":"dkim_enabled","type":"boolean"},"external_mail_flag_enabled":{"title":"external_mail_flag_enabled","type":"boolean"},"promotion_filter_enabled":{"title":"promotion_filter_enabled","type":"boolean"},"spam_filter_enabled":{"title":"spam_filter_enabled","type":"boolean"},"default_permissions":{"title":"default_permissions","type":"object","properties":{"can_access_logs":{"title":"can_access_logs","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/signatures\/templates\/default":{"get":{"tags":["Service Mail > Signatures templates"],"summary":"Show default","description":"Return the default signature template if there is one for the specified mail service","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_SignatureTemplate","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/signatures\/templates\/{signature_template}":{"get":{"tags":["Service Mail > Signatures templates"],"summary":"Show a signature template","description":"Show details about the specified signature template","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"signature_template","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_SignatureTemplate","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Service Mail > Signatures templates"],"summary":"Update","description":"Update a given signature template","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"signature_template","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"attributes":{"title":"attributes","type":"object","properties":{"accountName":{"title":"accountName","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"accountRectangleLogoUrl":{"title":"accountRectangleLogoUrl","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"accountSquareLogoUrl":{"title":"accountSquareLogoUrl","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"address":{"title":"address","type":"object","properties":{"keys":{"title":"keys","type":"object","properties":{"additionalAddress":{"title":"additionalAddress","type":"string"},"address":{"title":"address","type":"string"},"city":{"title":"city","type":"string"},"country":{"title":"country","type":"string"},"zipCode":{"title":"zipCode","type":"string"}}},"markers":{"title":"markers","type":"object","properties":{"additionalAddress":{"title":"additionalAddress","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"address":{"title":"address","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"city":{"title":"city","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"country":{"title":"country","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"zipCode":{"title":"zipCode","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"department":{"title":"department","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"firstName":{"title":"firstName","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"job":{"title":"job","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"lastName":{"title":"lastName","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"mail":{"title":"mail","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"name":{"title":"name","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}},"description":"Name of the resource `{name}`"},"phones":{"title":"phones","type":"object","properties":{"keys":{"title":"keys","type":"object","properties":{"list":{"title":"list","type":"string"},"type":{"title":"type","type":"string"},"value":{"title":"value","type":"string"}}},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"url":{"title":"url","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}},"userAvatarUrl":{"title":"userAvatarUrl","type":"object","properties":{"key":{"title":"key","type":"string"},"markers":{"title":"markers","type":"object","properties":{"raw":{"title":"raw","type":"object","properties":{"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}}}},"mode":{"title":"mode","type":"string"}}}},"example":"[{key:'FIRSTNAME', value:'John', status:'user'}]"},"content":{"title":"content","maxLength":65536,"type":"string"},"default":{"title":"default","type":"boolean"},"form_data":{"title":"form_data","type":"object","properties":{"globalStyle":{"title":"globalStyle","type":"object","properties":{"backgroundColor":{"title":"backgroundColor","type":"string"},"displaySeparators":{"title":"displaySeparators","type":"boolean"},"fontColor":{"title":"fontColor","type":"string"},"fontFamily":{"title":"fontFamily","type":"string"},"fontSize":{"title":"fontSize","type":"string"},"iconBackgroundColor":{"title":"iconBackgroundColor","type":"string"},"iconFontColor":{"title":"iconFontColor","enum":["dark","light"],"type":"string"},"linkFontColor":{"title":"linkFontColor","type":"string"}}},"layout":{"title":"layout","type":"object","properties":{"'layout'":{"title":"'layout'","type":"string"}}},"media":{"title":"media","type":"object","properties":{"accountLogoUrlMode":{"title":"accountLogoUrlMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"},"accountRectangleLogoUrl":{"title":"accountRectangleLogoUrl","type":"string"},"accountSquareLogoUrl":{"title":"accountSquareLogoUrl","type":"string"},"userAvatarUrl":{"title":"userAvatarUrl","type":"string"},"userAvatarUrlMode":{"title":"userAvatarUrlMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"}}},"network":{"title":"network","type":"object","properties":{"backgroundColor":{"title":"backgroundColor","type":"string"},"fontColor":{"title":"fontColor","enum":["dark","light"],"type":"string"},"networks":{"title":"networks","type":"array","items":{"title":"item","type":"object","properties":{"name":{"title":"name","enum":["Facebook","Instagram","LinkedIn","X","Youtube"],"type":"string","description":"Name of the resource `{name}`"},"url":{"title":"url","type":"string"}}}}}},"personal":{"title":"personal","type":"object","properties":{"department":{"title":"department","type":"string","description":"The value of the attribute"},"departmentMode":{"title":"departmentMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"firstName":{"title":"firstName","type":"string"},"firstNameMode":{"title":"firstNameMode","enum":["user"],"type":"string"},"hasDepartment":{"title":"hasDepartment","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"hasFirstName":{"title":"hasFirstName","type":"boolean"},"hasJob":{"title":"hasJob","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"hasLastName":{"title":"hasLastName","type":"boolean"},"hasMail":{"title":"hasMail","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"job":{"title":"job","type":"string","description":"The value of the attribute"},"jobMode":{"title":"jobMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"lastName":{"title":"lastName","type":"string"},"lastNameMode":{"title":"lastNameMode","enum":["user"],"type":"string"},"mail":{"title":"mail","type":"string","description":"The value of the attribute"},"mailMode":{"title":"mailMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"},"nameFormat":{"title":"nameFormat","type":"string","description":"The value of the attribute"},"nameFormatMode":{"title":"nameFormatMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"phones":{"title":"phones","type":"array","items":{"title":"item","type":"object","properties":{"type":{"title":"type","enum":["mobile_icon","mobile_letter","none","phone_icon","phone_letter","phone_letter_alt"],"type":"string","description":"Choose the icon associated with the phone number."},"value":{"title":"value","type":"string","description":"The phone number","example":"+33600000000"}}},"description":"List of phone numbers associated with the signature template."}}},"professional":{"title":"professional","type":"object","properties":{"accountName":{"title":"accountName","type":"string"},"accountNameMode":{"title":"accountNameMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"additionalAddress":{"title":"additionalAddress","type":"string"},"address":{"title":"address","type":"string"},"addressMode":{"title":"addressMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"addressUrl":{"title":"addressUrl","type":"string"},"city":{"title":"city","type":"string"},"country":{"title":"country","type":"string"},"url":{"title":"url","type":"string"},"urlMode":{"title":"urlMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"zipCode":{"title":"zipCode","type":"string"}}}}},"is_default":{"title":"is_default","type":"boolean","example":true},"name":{"title":"name","maxLength":255,"type":"string","description":"Name of the resource `{name}`"},"name_format":{"title":"name_format","enum":["first_last","first_only","last_first","last_only"],"type":"string","description":"Describes the format in which the name should be displayed.<note>first_last<\/strong>: First_last.<\/note><note>first_only<\/strong>: First_only.<\/note><note>last_first<\/strong>: Last_first.<\/note><note>last_only<\/strong>: Last_only.<\/note>","nullable":true,"example":"first_last"},"notify":{"title":"notify","type":"boolean"},"position":{"title":"position","enum":["bottom","top"],"type":"string","description":"Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.<note>bottom<\/strong>: The signature is placed at the bottom of the email.<\/note><note>top<\/strong>: The signature is placed at the top of the email.<\/note>","example":"bottom"},"status":{"title":"status","enum":["draft","enabled"],"type":"string","description":"Specifies the current status of the signature template. The signature can either be enabled and ready for use, or in draft mode awaiting validation.<note>draft<\/strong>: The signature is in draft mode and cannot be used until it has been validated.<\/note><note>enabled<\/strong>: The signature is enabled and available for use in emails.<\/note>","example":"draft"},"substitutions":{"title":"substitutions","type":"object","properties":{"address":{"title":"address","type":"string","description":" Defines the HTML template that will be applied to each address defined in the form to display them in the email signature template."},"phones":{"title":"phones","type":"string","description":" Defines the HTML template that will be applied to each phone number defined in the form to display them in the email signature template."}},"description":" These values are used to define an HTML template with placeholder values for fields that require multiple substitutions."}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Service Mail > Signatures templates"],"summary":"Delete","description":"Delete the given signature template","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"signature_template","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/auto_replies\/{auto_reply_id}":{"get":{"tags":["Service Mail > Auto Reply"],"summary":"Show a specific auto reply","description":"Show a specific auto reply model","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"auto_reply_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailResponder","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Service Mail > Auto Reply"],"summary":"Delete auto reply","description":"Delete auto reply","parameters":[{"description":"ServiceMail identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"Auto reply identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"auto_reply_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Service Mail > Auto Reply"],"summary":"Update auto reply","description":"Update auto reply","parameters":[{"description":"ServiceMail identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"ServiceMailAutoReply identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"auto_reply_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"dont_reply_to":{"title":"dont_reply_to","type":"array","description":"List of emails the auto reply won't respond to","example":"[test@tests.ch]"},"ended_at":{"title":"ended_at","type":"integer","description":"When should end the auto reply activation","nullable":true},"is_recurrent":{"title":"is_recurrent","type":"boolean","description":"Define if the responder should be activate for some days in the week instead of a certain time"},"is_visible":{"title":"is_visible","type":"boolean","description":"Define if the attributes is visible for all the users"},"message":{"title":"message","maxLength":65536,"type":"string"},"name":{"title":"name","type":"string","description":"Name of the resource `{name}`"},"recurrent_days":{"title":"recurrent_days","type":"object","properties":{"friday":{"title":"friday","type":"boolean"},"monday":{"title":"monday","type":"boolean"},"saturday":{"title":"saturday","type":"boolean"},"sunday":{"title":"sunday","type":"boolean"},"thursday":{"title":"thursday","type":"boolean"},"tuesday":{"title":"tuesday","type":"boolean"},"wednesday":{"title":"wednesday","type":"boolean"}},"description":"List of the days when the auto reply is activated"},"started_at":{"title":"started_at","type":"integer","description":"When the responder start to be active","format":"timestamp","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/filters\/{filter_id}":{"get":{"tags":["Service Mail > Filters Models"],"summary":"Show a filter model","description":"Return the information from the specified filter model linked to the given mail service","parameters":[{"description":"The identifier of the concerned mail service","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"description":"The identifier of the concerned filter","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"filter_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailboxSieveFilter","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Service Mail > Filters Models"],"summary":"Update a filter model","description":"Update filter model for given Service Mail","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"filter_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["is_visible","name"],"type":"object","properties":{"actions":{"title":"actions","type":"array","items":{"title":"item","required":["type"],"type":"object","properties":{"type":{"title":"type","enum":["copy","discard","flag_seen","forward","move","stop"],"type":"string"}}}},"conditions":{"title":"conditions","type":"array","items":{"title":"item","required":["operator","property","value"],"type":"object","properties":{"operator":{"title":"operator","type":"string"},"property":{"title":"property","enum":["body","cc","from","reply-to","size","subject","to","x-infomaniak-type"],"type":"string"},"value":{"title":"value","type":"string"}}}},"has_all_conditions":{"title":"has_all_conditions","type":"boolean"},"is_visible":{"title":"is_visible","type":"boolean"},"name":{"title":"name","maxLength":64,"type":"string","description":"Name of the resource `{name}`"},"script":{"title":"script","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Service Mail > Filters Models"],"summary":"Delete a filter model","description":"Delete filters for given Service Mail\n\n\napi_return boolean","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"filter_id","in":"path"}],"requestBody":{"description":"Request body of the called URI","content":{"application\/json":{"schema":{"title":"Request body","required":["filter_id","mail_hosting_id"],"type":"object","properties":{"mail_hosting_id":{"title":"mail_hosting_id","type":"integer","description":"ServiceMail identifier"},"filter_id":{"title":"filter_id","type":"integer","description":"Sieve filter identifier"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailing_lists\/{mailing_list_name}":{"get":{"tags":["Mailing List"],"summary":"Show one mailing list","description":"Getting all the details from the specified mailing list","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_Mailinglist","schema":[]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailing List"],"summary":"Delete a mailing list","description":"Delete the specified mailing list from the current mail service","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailing List"],"summary":"Update mailing list parameters","description":"Update some information like welcome message, maximum size of message for the specified mailing list owned by the given mail service","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["info","is_reply_to_forced","max_message_size","moderators","should_send_notifications","subject","use_reply_to","who_can_send","who_can_subscribe"],"type":"object","properties":{"goodbye_message":{"title":"goodbye_message","maxLength":4096,"type":"string","nullable":true},"info":{"title":"info","type":"string"},"is_reply_to_forced":{"title":"is_reply_to_forced","type":"boolean","description":"Tells if the mail of the sender is replaced by the mailing list mail"},"lang":{"title":"lang","enum":["de","en","es","fr","it"],"type":"string","description":"Current language preference code.<note>de<\/strong>: German language.<\/note><note>en<\/strong>: English language.<\/note><note>es<\/strong>: Spanish language.<\/note><note>fr<\/strong>: French language.<\/note><note>it<\/strong>: Italian language.<\/note>","nullable":true,"example":"de"},"max_message_size":{"title":"max_message_size","maximum":209715200,"minimum":1024,"type":"integer"},"moderators":{"title":"moderators","type":"string"},"should_send_notifications":{"title":"should_send_notifications","type":"boolean","description":"Tells if the mailing list should send or not welcome\/goodbye message"},"subject":{"title":"subject","maxLength":300,"type":"string"},"use_reply_to":{"title":"use_reply_to","type":"boolean","description":"Tells if the expeditor's mail is substitute by the mailing list email when responding to it"},"welcome_message":{"title":"welcome_message","maxLength":4096,"type":"string","nullable":true},"who_can_send":{"title":"who_can_send","enum":["0","1","2","3","4","5"],"type":"string","description":"Indicates who can send mails in the mailing list.<note>0<\/strong>: Only moderator and subscriber can send email through the mailing list.<\/note><note>1<\/strong>: Only moderator can send email through the mailing list.<\/note><note>2<\/strong>: Everyone can send email through the mailing list but requires a moderator validation.<\/note><note>3<\/strong>: Only moderator and subscriber can send email through the mailing list but requires a moderator validation.<\/note><note>4<\/strong>: Everyone can send a mail through the mailing list but requires a moderator validation for the mail sent by non subscribers.<\/note><note>5<\/strong>: Everyone can send a mail through the mailing list.<\/note>","example":"0"},"who_can_subscribe":{"title":"who_can_subscribe","enum":["0","1","2"],"type":"string","description":"The subscription policy setup for the mailing list.<note>0<\/strong>: Anybody can subscribe.<\/note><note>1<\/strong>: Any new subscription should be confirmed by the owner.<\/note><note>2<\/strong>: Any new subscription should be confirmed by the owner and the subscriber.<\/note>","example":"0"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}":{"get":{"tags":["Mailbox management"],"summary":"Display a mailbox","description":"Returns a variety of information about a single a Mailbox specified by the requested unique identifier.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"unit","enum":["B","MB","kB"],"type":"string","description":"Specifies the storage unit for the mailbox.<note>b<\/strong>: Return the unit size in Bytes.<\/note><note>mb<\/strong>: Return the unit size in Megabytes.<\/note><note>kb<\/strong>: Return the unit size in Kilobytes.<\/note>","example":"B"},"name":"unit","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_Mailbox","schema":[]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/users":{"get":{"tags":["Mailboxes > Users"],"summary":"List users","description":"Retrieves the users of a given mailbox alias\n<note>This endpoint is not available anymore only for selected accounts. Access will be gradually disabled over the coming weeks. Accounts that are already eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_Mailboxusersandinvitations","schema":[]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/invitations":{"get":{"tags":["Mailboxes > Users"],"summary":"List user invitations","description":"Retrieves the user invitations of a given mailbox alias.\n<note>This endpoint is not available anymore only for selected accounts. Access will be gradually disabled over the coming weeks. Accounts that are already eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Invitationtoamailbox","schema":[]}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/signatures\/templates":{"get":{"tags":["Mailboxes > Signatures"],"summary":"List templates","description":"List all templates for specific mailbox","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_SignatureTemplate","schema":[]}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/signatures\/templates\/{signature_template}":{"get":{"tags":["Mailboxes > Signatures"],"summary":"Show one template","description":"Return the information of the specified signature template","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The unique name of the mailbox.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier of the signature template.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"signature_template","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_SignatureTemplate","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/signatures\/{signature}":{"get":{"tags":["Mailboxes > Signatures"],"summary":"Show a signature","description":"Show the specified signature from the current mailbox","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the signature to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"signature","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_Signature","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Signatures"],"summary":"Delete a signature","description":"Delete a given signature","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the signature to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"signature","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailboxes > Signatures"],"summary":"Update a specific signature","description":"Update the specified signature","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the signature to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"signature","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"attributes":{"title":"attributes","type":"object","properties":{"department":{"title":"department","type":"string"},"firstName":{"title":"firstName","type":"string"},"job":{"title":"job","type":"string"},"lastName":{"title":"lastName","type":"string"},"mail":{"title":"mail","type":"string"},"name":{"title":"name","type":"string","description":"Name of the resource `{name}`"},"nameFormat":{"title":"nameFormat","type":"string"},"phones":{"title":"phones","type":"array","items":{"title":"item","type":"object","properties":{"type":{"title":"type","type":"string"},"value":{"title":"value","type":"string"}}}},"userAvatarUrl":{"title":"userAvatarUrl","type":"string"}},"example":"[{key:'FIRSTNAME', value:'John', status:'user'}]"},"content":{"title":"content","type":"string","nullable":true},"form_data":{"title":"form_data","type":"object","properties":{"globalStyle":{"title":"globalStyle","type":"object","properties":{"backgroundColor":{"title":"backgroundColor","type":"string"},"displaySeparators":{"title":"displaySeparators","type":"boolean"},"fontColor":{"title":"fontColor","type":"string"},"fontFamily":{"title":"fontFamily","type":"string"},"fontSize":{"title":"fontSize","type":"string"},"iconBackgroundColor":{"title":"iconBackgroundColor","type":"string"},"iconFontColor":{"title":"iconFontColor","enum":["dark","light"],"type":"string"},"linkFontColor":{"title":"linkFontColor","type":"string"}}},"layout":{"title":"layout","type":"object","properties":{"'layout'":{"title":"'layout'","type":"string"}}},"media":{"title":"media","type":"object","properties":{"accountLogoUrlMode":{"title":"accountLogoUrlMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"},"accountRectangleLogoUrl":{"title":"accountRectangleLogoUrl","type":"string"},"accountSquareLogoUrl":{"title":"accountSquareLogoUrl","type":"string"},"userAvatarUrl":{"title":"userAvatarUrl","type":"string"},"userAvatarUrlMode":{"title":"userAvatarUrlMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"}}},"network":{"title":"network","type":"object","properties":{"backgroundColor":{"title":"backgroundColor","type":"string"},"fontColor":{"title":"fontColor","enum":["dark","light"],"type":"string"},"networks":{"title":"networks","type":"array","items":{"title":"item","type":"object","properties":{"name":{"title":"name","enum":["Facebook","Instagram","LinkedIn","X","Youtube"],"type":"string","description":"Name of the resource `{name}`"},"url":{"title":"url","type":"string"}}}}}},"personal":{"title":"personal","type":"object","properties":{"department":{"title":"department","type":"string","description":"The value of the attribute"},"departmentMode":{"title":"departmentMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"firstName":{"title":"firstName","type":"string"},"firstNameMode":{"title":"firstNameMode","enum":["user"],"type":"string"},"hasDepartment":{"title":"hasDepartment","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"hasFirstName":{"title":"hasFirstName","type":"boolean"},"hasJob":{"title":"hasJob","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"hasLastName":{"title":"hasLastName","type":"boolean"},"hasMail":{"title":"hasMail","type":"boolean","description":"Indicates if the templates contains this attributes or not"},"job":{"title":"job","type":"string","description":"The value of the attribute"},"jobMode":{"title":"jobMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"lastName":{"title":"lastName","type":"string"},"lastNameMode":{"title":"lastNameMode","enum":["user"],"type":"string"},"mail":{"title":"mail","type":"string","description":"The value of the attribute"},"mailMode":{"title":"mailMode","enum":["auto","static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"auto"},"nameFormat":{"title":"nameFormat","type":"string","description":"The value of the attribute"},"nameFormatMode":{"title":"nameFormatMode","enum":["static","user"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>static<\/strong>: The value is predefined in the model and remains constant.<\/note><note>user<\/strong>: The values of the attributes must be provided by the user during the template creation process.<\/note>","example":"static"},"phones":{"title":"phones","type":"array","items":{"title":"item","type":"object","properties":{"type":{"title":"type","enum":["mobile_icon","none","phone_icon","phone_letter","phone_letter_alt"],"type":"string","description":"Choose the icon associated with the phone number."},"value":{"title":"value","type":"string","description":"The phone number","example":"+33600000000"}}},"description":"List of phone numbers associated with the signature template."}}},"professional":{"title":"professional","type":"object","properties":{"accountName":{"title":"accountName","type":"string"},"accountNameMode":{"title":"accountNameMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"additionalAddress":{"title":"additionalAddress","type":"string"},"address":{"title":"address","type":"string"},"addressMode":{"title":"addressMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"addressUrl":{"title":"addressUrl","type":"string"},"city":{"title":"city","type":"string"},"country":{"title":"country","type":"string"},"url":{"title":"url","type":"string"},"urlMode":{"title":"urlMode","enum":["auto","static"],"type":"string","description":"Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.<note>auto<\/strong>: The value of the attributes is automatically derived from the user's information.<\/note><note>static<\/strong>: The value is predefined in the model and remains constant.<\/note>","example":"auto"},"zipCode":{"title":"zipCode","type":"string"}}}}},"fullname":{"title":"fullname","type":"string"},"has_infomaniak_footer":{"title":"has_infomaniak_footer","type":"boolean"},"is_default":{"title":"is_default","type":"boolean","example":true},"name":{"title":"name","maxLength":255,"type":"string","description":"Name of the resource `{name}`"},"position":{"title":"position","enum":["bottom","top"],"type":"string","description":"Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.<note>bottom<\/strong>: The signature is placed at the bottom of the email.<\/note><note>top<\/strong>: The signature is placed at the top of the email.<\/note>","example":"bottom"},"reply_email":{"title":"reply_email","type":"string","nullable":true},"sending_email":{"title":"sending_email","type":"string","nullable":true},"template_id":{"title":"template_id","type":"string","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auto_reply\/model\/{model_id}":{"get":{"tags":["Mailboxes > Auto reply"],"summary":"Show auto reply model","description":"Show an auto replies model for a given mailbox","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"model_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailboxresponder","schema":[]}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Auto reply"],"summary":"Update auto reply model","description":"Delete an auto replies model for a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"model_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailboxes > Auto reply"],"summary":"Update auto reply model","description":"Update an auto replies model for a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"model_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["is_active"],"type":"object","properties":{"dont_reply_to":{"title":"dont_reply_to","type":"array","description":" List of mail that aren't concerned by the responder","example":"[test@tests.ch]"},"ended_at":{"title":"ended_at","type":"integer","description":"When the responder is supposed to end","format":"timestamp","nullable":true},"is_active":{"title":"is_active","type":"boolean","description":"Indicates if the responder is active"},"is_model":{"title":"is_model","type":"boolean"},"is_recurrent":{"title":"is_recurrent","type":"boolean"},"message":{"title":"message","maxLength":65536,"type":"string"},"name":{"title":"name","type":"string","description":"Name the auto reply model"},"recurrent_days":{"title":"recurrent_days","type":"object","properties":{"friday":{"title":"friday","type":"boolean"},"monday":{"title":"monday","type":"boolean"},"saturday":{"title":"saturday","type":"boolean"},"sunday":{"title":"sunday","type":"boolean"},"thursday":{"title":"thursday","type":"boolean"},"tuesday":{"title":"tuesday","type":"boolean"},"wednesday":{"title":"wednesday","type":"boolean"}},"description":"List of the days when the auto reply is activated"},"reply_from_id":{"title":"reply_from_id","type":"integer","description":"Id of the Email that send the auto reply"},"started_at":{"title":"started_at","type":"integer","description":"Dates when the responder has become active","format":"timestamp","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/redirections\/{redirection_id}":{"get":{"tags":["Service Mail > Redirections"],"summary":"Show details","description":"Return details about the specified redirections for the given mail service","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_Redirection","schema":[]}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Service Mail > Redirections"],"summary":"Update redirection","description":"Update the specified redirection's details","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["targets"],"type":"object","properties":{"targets":{"title":"targets","maxItems":10,"type":"array","items":{"title":"item","maxLength":255,"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"description":"Can be any value - string, number, boolean, array or object."}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Service Mail > Redirections"],"summary":"Delete redirection","description":"Delete a redirection from the mail service","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"description":"Can be any value - string, number, boolean, array or object."}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/mailboxes\/{mailbox_name}\/accesses\/devices\/users\/{user_id}":{"get":{"tags":["Mailboxes > Accesses > Devices"],"summary":"List device access for a user","description":"Returns list of device accesses for the mailbox specified for a user\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the user to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["type","label","user"]}},{"$ref":"#\/components\/parameters\/Order","schema":[]},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[type]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_DeviceAccess","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Accesses > Devices"],"summary":"Delete device access for a user","description":"Delete device accesses for the mailbox specified for a user\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the user to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["legacy_device_deletion"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>legacy_device_deletion<\/strong>: A legacy device can't be deleted by another user.<\/note>","example":"legacy_device_deletion"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/accesses\/devices\/users\/{user_id}":{"get":{"tags":["Mailboxes > Accesses > Devices"],"summary":"List device by user","description":"Returns list of device for a user\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The unique identifier (ID) of the user to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Device","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/mailboxes\/{mailbox_name}\/accesses\/webmail\/users":{"get":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"List users having access","description":"Returns list of user accesses for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"style":"form","explode":true,"schema":{"title":"search","maxLength":255,"minLength":1,"type":"string"},"name":"search","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_UserV2","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/accesses\/webmail":{"get":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"List of user accesses for the current user","description":"Returns list of user accesses for the current user\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_UserAccess","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/accesses\/webmail\/accounts\/{account_id}\/users\/{user_id}":{"get":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"List of user accesses for a account and a user","description":"Returns list of user accesses for a account and a user\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The account identifier","style":"simple","explode":true,"schema":{"type":"string"},"name":"account_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"user_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_UserAccess","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/accesses\/devices":{"get":{"tags":["Mailboxes > Accesses > Devices"],"summary":"List device","description":"Returns list of device and all their access\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Return","schema":[]},{"$ref":"#\/components\/parameters\/Page","schema":{"default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Device","schema":[]}}}},{"$ref":"#\/components\/schemas\/Pagination","schema":[]}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Mailboxes > Accesses > Devices"],"summary":"Delete devices for current user","description":"Delete all devices for current user\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailing_lists\/{mailing_list_name}\/send":{"put":{"tags":["Mailing List"],"summary":"Send a mail through a mailing list","description":"Send the specified message to all the adress of the mailing list","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["from","message","subject"],"type":"object","properties":{"from":{"title":"from","type":"string","description":"The email from where the mail is sent to the concerned mailing list","example":"mail@example.com"},"message":{"title":"message","type":"string","description":"The email message","example":"This the message"},"subject":{"title":"subject","type":"string","description":"The email subject","example":"subject"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailing_lists\/{mailing_list_name}\/form":{"put":{"tags":["Mailing List"],"summary":"Generate a form for a mailing list","description":"Generate a form concerning a mailing list for handling subscription or unsubscription","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailing_list_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["subscribe_submit","unsubscribe_submit","url_after_subscription","url_after_unsubscription"],"type":"object","properties":{"subscribe_submit":{"title":"subscribe_submit","type":"string","description":"Text on the subscription form button","example":"Subscribe"},"unsubscribe_submit":{"title":"unsubscribe_submit","type":"string","description":"Text on the unsubscription form button","example":"Unsubscribe"},"url_after_subscription":{"title":"url_after_subscription","type":"string","description":"Redirection link that can be applied after subscription","example":"https:\/\/www.infomaniak.com"},"url_after_unsubscription":{"title":"url_after_unsubscription","type":"string","description":"Redirection link that can be applied after unsubscription","example":"https:\/\/www.infomaniak.com"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/93e74a89_SubscribeandUnsubscribeMailingListForm","schema":[]}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/invitations\/send":{"put":{"tags":["Mailboxes > Users"],"summary":"Send an invitation","description":"Sends an invitation.\n<note>This endpoint is not available anymore only for selected accounts. Access will be gradually disabled over the coming weeks. Accounts that are already eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"email":{"title":"email","type":"string","description":"Email"},"firstname":{"title":"firstname","type":"string"},"force_email":{"title":"force_email","type":"integer"},"key":{"title":"key","type":"string"},"language":{"title":"language","enum":["de","en","es","fr","it"],"type":"string","description":"Current language preference code.<note>de<\/strong>: German language.<\/note><note>en<\/strong>: English language.<\/note><note>es<\/strong>: Spanish language.<\/note><note>fr<\/strong>: French language.<\/note><note>it<\/strong>: Italian language.<\/note>","example":"de"},"lastname":{"title":"lastname","type":"string"},"permissions":{"title":"permissions","type":"array"},"phone":{"title":"phone","maxLength":15,"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["cannot_send_invitation_email","invalid_password","too_many_attempts_try_again_in_1_minute"],"type":"string","description":"Error code","example":"invalid_password"},"description":{"enum":["Cannot send invitation email","Invalid password","Too many attempts try again in 1 minute"],"type":"string","description":"Description of the error","example":"Invalid password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_password","description":"Invalid password","errors":[]}}},"Too many attempts try again in 1 minute":{"summary":"Example","value":{"result":"error","error":{"code":"too_many_attempts_try_again_in_1_minute","description":"Too many attempts try again in 1 minute","errors":[]}}},"Cannot send invitation email":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_send_invitation_email","description":"Cannot send invitation email","errors":[]}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/users\/{user_id}":{"delete":{"tags":["Mailboxes > Users"],"summary":"Remove a user","description":"Removes a user from a given mailbox.\n<note>This endpoint is not available anymore only for selected accounts. Access will be gradually disabled over the coming weeks. Accounts that are already eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"User identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailboxes > Users"],"summary":"Update user permission","description":"Updates the permissions of a user on a given mailbox\n<note>This endpoint is not available anymore only for selected accounts. Access will be gradually disabled over the coming weeks. Accounts that are already eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"User identifier","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["permissions"],"type":"object","properties":{"permissions":{"title":"permissions","type":"object","properties":{"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_manage_chat":{"title":"can_manage_chat","type":"boolean"},"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/invitations\/{key}":{"delete":{"tags":["Mailboxes > Users"],"summary":"Delete an invitation","description":"Deletes an invitation from a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"key","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailboxes > Users"],"summary":"Update invitation permission","description":"Updates the permissions of a given invitation on a mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"key","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"force_email":{"title":"force_email","type":"boolean"},"permissions":{"title":"permissions","type":"object","properties":{"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_manage_chat":{"title":"can_manage_chat","type":"boolean"},"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Cannot update invitation","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["cannot_update_invitation"],"type":"string","description":"Error code","example":"cannot_update_invitation"},"description":{"enum":["Cannot update invitation"],"type":"string","description":"Description of the error","example":"Cannot update invitation"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Cannot update invitation":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_update_invitation","description":"Cannot update invitation","errors":[]}}}}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/redirections\/{redirection_id}\/enable":{"put":{"tags":["Service Mail > Redirections"],"summary":"Enable redirection","description":"Activate the specified redirection","parameters":[{"description":"The mail service identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The redirection identifier","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"description":"Can be any value - string, number, boolean, array or object."}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/redirections\/{redirection_id}\/send-confirmation-requests":{"put":{"tags":["Service Mail > Redirections"],"summary":"Send confirmation request","description":"This routes enables you to send a mail of confirmation for the redirection specified","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"description":"Can be any value - string, number, boolean, array or object."}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/redirections\/{redirection_id}\/targets\/{target_id}\/resend-confirmation-request":{"put":{"tags":["Service Mail > Redirections > Target"],"summary":"Resend confirmation email","description":"Resends the confirmation email to the specified target","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mail_hosting_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirection_id","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"target_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"object"}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["unexpected_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>unexpected_error<\/strong>: Triggered when something unknown happens.<\/note>","example":"unexpected_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{service_mail}\/mailboxes\/{mailbox_name}\/accesses\/webmail\/users\/{user_id}":{"delete":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"Delete webmail access","description":"Delete a webmail access for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the user to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["legacy_device_deletion"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>legacy_device_deletion<\/strong>: A legacy device can't be deleted by another user.<\/note>","example":"legacy_device_deletion"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["user_has_no_access_to_mailbox"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>user_has_no_access_to_mailbox<\/strong>: The user has no access to the mailbox.<\/note>","example":"user_has_no_access_to_mailbox"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"Update webmail access","description":"Update a webmail access for the mailbox specified\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"service_mail","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"The unique identifier (ID) of the user to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["permissions"],"type":"object","properties":{"permissions":{"title":"permissions","minItems":1,"type":"object","items":{"title":"item","enum":["can_access_logs","can_change_password","can_configure_mail_folders","can_manage_aliases","can_manage_auto_reply","can_manage_filters","can_manage_redirections","can_manage_rules","can_manage_security","can_manage_signatures","can_restore_emails"],"type":"string"},"properties":{"can_access_logs":{"title":"can_access_logs","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/accesses\/devices\/{device}":{"delete":{"tags":["Mailboxes > Accesses > Devices"],"summary":"Delete device accesses for device","description":"Delete all accesses of a device\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the device to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"device","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Mailboxes > Accesses > Devices"],"summary":"Update Device","description":"Update Device\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"description":"The unique identifier (ID) of the device to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"device","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["label"],"type":"object","properties":{"label":{"title":"label","maxLength":255,"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 409","type":"object","properties":{"code":{"enum":["device_already_exists"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>device_already_exists<\/strong>: The device with the same name already exists.<\/note>","example":"device_already_exists"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/folders\/spam":{"delete":{"tags":["Mailboxes > Folders"],"summary":"Purge spam folder","description":"Deletes all mails currently in the spam folder of the given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/auth\/folders\/trash":{"delete":{"tags":["Mailboxes > Folders"],"summary":"Empty trash folder","description":"Deletes all mails currently in the trash folder of the given mailbox linked to the current user","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invalid mailbox password","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invalid_mailbox_password","mailbox_not_linked_to_current_user"],"type":"string","description":"Error code","example":"invalid_mailbox_password"},"description":{"enum":["Invalid mailbox password","Mailbox not linked to current user"],"type":"string","description":"Description of the error","example":"Invalid mailbox password"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Invalid mailbox password":{"summary":"Example","value":{"result":"error","error":{"code":"invalid_mailbox_password","description":"Invalid mailbox password","errors":[]}}},"Mailbox not linked to current user":{"summary":"Example","value":{"result":"error","error":{"code":"mailbox_not_linked_to_current_user","description":"Mailbox not linked to current user","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/forwarding_addresses\/{redirect_addresses}":{"delete":{"tags":["Mailboxes > Forwarding"],"summary":"Delete a forwarding","description":"Deletes the given forwarding address from the given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"style":"simple","explode":true,"schema":{"type":"string"},"name":"redirect_addresses","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Cannot get redirection addresses","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["cannot_get_redirection_addresses","cannot_remove_redirection","redirect_address_does_not_exist"],"type":"string","description":"Error code","example":"cannot_get_redirection_addresses"},"description":{"enum":["Cannot get redirection addresses","Cannot remove redirection","Redirect address does not exist"],"type":"string","description":"Description of the error","example":"Cannot get redirection addresses"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Cannot get redirection addresses":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_get_redirection_addresses","description":"Cannot get redirection addresses","errors":[]}}},"Redirect address does not exist":{"summary":"Example","value":{"result":"error","error":{"code":"redirect_address_does_not_exist","description":"Redirect address does not exist","errors":[]}}},"Cannot remove redirection":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_remove_redirection","description":"Cannot remove redirection","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/{mail_hosting_id}\/mailboxes\/{mailbox_name}\/aliases\/{alias}":{"delete":{"tags":["Mailboxes > Aliases"],"summary":"Delete an alias","description":"Removes an alias from a given mailbox.","parameters":[{"description":"The unique identifier (ID) of the mail hosting to request.","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"mail_hosting_id","in":"path"},{"description":"The username (that is the part before the @) of the email address you want to request.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_name","in":"path"},{"description":"Alias to remove.","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"alias","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Alias does not exist","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["alias_does_not_exist"],"type":"string","description":"Error code","example":"alias_does_not_exist"},"description":{"enum":["Alias does not exist"],"type":"string","description":"Description of the error","example":"Alias does not exist"},"errors":{"type":"array","description":"Error details"}},"description":"Error object"}}}]},"examples":{"Alias does not exist":{"summary":"Example","value":{"result":"error","error":{"code":"alias_does_not_exist","description":"Alias does not exist","errors":[]}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/1\/mail_hostings\/accesses\/webmail\/mailboxes\/{mailbox_id}":{"delete":{"tags":["Mailboxes > Accesses > Webmail"],"summary":"Delete access to a mailbox for the current user","description":"Delete access to a mailbox for the current user\n<note>This endpoint is available only for selected accounts. Access will be gradually enabled over the coming weeks. Accounts that are not yet eligible will receive a 501 Method not yet implemented response.<\/note>","parameters":[{"style":"simple","explode":true,"schema":{"type":"string"},"name":"mailbox_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response","schema":[]},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["legacy_device_deletion"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>legacy_device_deletion<\/strong>: A legacy device can't be deleted by another user.<\/note>","example":"legacy_device_deletion"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["user_has_no_access_to_mailbox"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>user_has_no_access_to_mailbox<\/strong>: The user has no access to the mailbox.<\/note>","example":"user_has_no_access_to_mailbox"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse","schema":[]},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.<note>cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}}},"components":{"schemas":{"Response":{"title":"Generic response schema to be reused","required":["result"],"type":"object","properties":{"result":{"enum":["success","error","asynchronous"],"type":"string","description":"Result of the HTTP request","example":"success"}}},"93e74a89_CreatedorUpdatedBimi":{"title":"Created or Updated Bimi","required":["current","state","status","svg_uri","vmc_uri"],"type":"object","properties":{"status":{"title":"status","type":"string","description":"Status of the resource `Created or Updated Bimi`","example":"enabled"},"state":{"title":"state","enum":["CERTIFIED","ERROR","EXPIRED","NOT_CERTIFIED"],"type":"string","description":"Indicates the current state of the BIMI (Brand Indicators for Message Identification) associated with a mail service.<note>certified<\/strong>: The BIMI is certified and valid. The brand logo will be displayed in supported email clients.<\/note><note>error<\/strong>: An error occurred with the BIMI setup. The brand logo will not be displayed, and further investigation is needed.<\/note><note>expired<\/strong>: The BIMI certification has expired. The brand logo will not be displayed until the certification is renewed.<\/note><note>not_certified<\/strong>: The BIMI is not certified. The brand logo may not appear in many email clients.<\/note>","example":"CERTIFIED"},"svg_uri":{"title":"svg_uri","type":"string","description":"The URL of the SVG image associated with the BIMI record"},"vmc_uri":{"title":"vmc_uri","type":"string","description":"The URL of the VMC (Verified Mark Certificate) associated with the BIMI record"},"current":{"title":"current","type":"string","description":"The current DNS record for the BIMI, including the version, SVG link, and VMC link","example":"v=BIMI1; l=https:\/\/example.com\/logo.svg; a=https:\/\/example.com\/bimi.pem"}}},"ErrorResponse":{"title":"Generic error response schema to be reused","required":["result"],"type":"object","properties":{"result":{"type":"string","description":"Result of the HTTP request","example":"error"}}},"93e74a89_SignatureTemplate":{"title":"Signature Template","required":["id","is_default","name","name_format","service_mail_id","status"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Unique identifier of the resource `Signature Template`","example":"123456"},"name":{"title":"name","type":"string","description":"Name of the resource `Signature Template`"},"service_mail_id":{"title":"service_mail_id","type":"string"},"content":{"title":"content","type":"string"},"form_data":{"title":"form_data","type":"object"},"position":{"title":"position","type":"string","example":"top"},"name_format":{"title":"name_format","type":"string","nullable":true},"status":{"title":"status","enum":["draft","enabled"],"type":"string","description":"Specifies the current status of the signature template. The signature can either be enabled and ready for use, or in draft mode awaiting validation.<note>draft<\/strong>: The signature is in draft mode and cannot be used until it has been validated.<\/note><note>enabled<\/strong>: The signature is enabled and available for use in emails.<\/note>","example":"draft"},"is_default":{"title":"is_default","type":"boolean","example":true},"creator":{"$ref":"#\/components\/schemas\/93e74a89_SignatureTemplateCreator","schema":[]}}},"Pagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items\nAdded when using query parameter `page`\n","example":221},"page":{"type":"integer","description":"Number of the current page\nAdded when using query parameter `page`\n","example":2},"pages":{"type":"integer","description":"Total number of pages\nAdded when using query parameter `page`\n","example":15},"items_per_page":{"type":"integer","description":"Number of items per page\nAdded when using query parameter `page`\n","example":15}}},"93e74a89_ImageURL":{"title":"Image URL","required":["image"],"type":"object","properties":{"image":{"title":"image","type":"string","description":"The url where you can retrieve the stored image.","example":"https:\/\/example.com\/image.jpg"}}},"93e74a89_ServiceMailResponder":{"title":"Service Mail Responder","required":["ended_at","id","is_active","is_model","is_recurrent","is_visible","message","name","recurrent_days","source_model_id","started_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Service Mail Responder`","example":123456},"name":{"title":"name","type":"string","description":"Name of the pack mail responder"},"is_model":{"title":"is_model","type":"boolean"},"source_model_id":{"title":"source_model_id","type":"integer","nullable":true},"message":{"title":"message","type":"string","description":"Message sent by the responder","example":"Mail Content"},"is_recurrent":{"title":"is_recurrent","type":"boolean","description":"Days when the responder is activated","example":true},"recurrent_days":{"$ref":"#\/components\/schemas\/93e74a89_RecurrentDays","schema":[]},"started_at":{"title":"started_at","type":"integer","description":"Timestamp of the start of the responder","format":"timestamp","nullable":true},"ended_at":{"title":"ended_at","type":"integer","description":"Timestamp of the end of the responder","format":"timestamp","nullable":true},"is_active":{"title":"is_active","type":"boolean","description":"Tells if the responder is activated"},"is_visible":{"title":"is_visible","type":"boolean","description":"Tells if the responder is visible for the other users of the mail service","nullable":true},"dont_reply_to":{"title":"dont_reply_to","type":"array","description":"Emails that aren't concerned with the responder","example":"[test@tests.ch]"},"reply_from_id":{"title":"reply_from_id","type":"integer","description":"Id of the Email that send the auto reply","nullable":true},"reply_from":{"title":"reply_from","type":"string","description":"Email that send the auto reply"},"valid_emails":{"title":"valid_emails","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_ValidEmail","schema":[]},"description":"List of emails validated"}}},"93e74a89_ServiceMailboxSieveFilter":{"title":"Service Mailbox Sieve Filter","required":["actions","conditions","has_all_conditions","id","is_visible","name","requires"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Service Mailbox Sieve Filter`","example":123456},"name":{"title":"name","type":"string","description":"Name of the sieve filter"},"has_all_conditions":{"title":"has_all_conditions","type":"boolean"},"conditions":{"title":"conditions","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_MailboxFilterConditions","schema":[]}},"actions":{"title":"actions","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_MailboxFilterActions","schema":[]}},"requires":{"title":"requires","type":"array"},"is_visible":{"title":"is_visible","type":"boolean"}}},"93e74a89_Mailbox":{"title":"Mailbox","required":["can_access_logs","can_ask_reset_password","can_change_password","can_configure_mail_folders","can_create_device","can_create_webmail_access","can_delete_device_legacy","can_list_users","can_manage_aliases","can_manage_auto_reply","can_manage_filters","can_manage_redirections","can_manage_rules","can_manage_security","can_manage_signatures","can_regenerate_device_legacy","can_restore_emails","has_technical_right","is_active","is_free_mail","is_limited","is_used_for_account","mailbox","mailbox_idn","mailbox_name","note","private","type","users"],"type":"object","properties":{"users":{"title":"users","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_MailboxUser","schema":[]}},"invitations":{"title":"invitations","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Invitationtoamailbox","schema":[]}},"mailbox_name":{"title":"mailbox_name","type":"string"},"mailbox":{"title":"mailbox","type":"string"},"mailbox_idn":{"title":"mailbox_idn","type":"string"},"note":{"title":"note","type":"string","nullable":true},"type":{"title":"type","type":"integer","nullable":true},"count_signatures":{"title":"count_signatures","type":"integer"},"count_invitations":{"title":"count_invitations","type":"integer"},"is_limited":{"title":"is_limited","type":"boolean"},"is_free_mail":{"title":"is_free_mail","type":"boolean"},"has_auto_responder":{"title":"has_auto_responder","type":"boolean"},"auto_responder":{"title":"auto_responder","type":"object","properties":{"is_active":{"title":"is_active","type":"boolean","description":"Is the resource `Mailbox` active ?"}}},"has_redirection":{"title":"has_redirection","type":"boolean"},"redirection":{"title":"redirection","type":"array"},"aliases":{"title":"aliases","type":"array","description":"List of aliases"},"full_aliases":{"title":"full_aliases","type":"array"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Mailbox` has been created","format":"timestamp"},"password_last_changed_at":{"title":"password_last_changed_at","type":"integer","format":"timestamp"},"size":{"title":"size","type":"integer","description":"Display the size of the mailbox, should be displayed when with=size or when with=size_refresh(this activate the recalculation, forced when this was more then 3 months"},"size_checked_at":{"title":"size_checked_at","type":"integer","description":"This indicates the last time the size was calculated by the system. Should be display with the argument with=size_refresh or with=size","format":"timestamp"},"imap_last_login_at":{"title":"imap_last_login_at","type":"integer","format":"timestamp"},"pop3_last_login_at":{"title":"pop3_last_login_at","type":"integer","format":"timestamp"},"operation_in_progress":{"title":"operation_in_progress","type":"boolean"},"has_move_spam":{"title":"has_move_spam","type":"boolean"},"authorized_senders":{"title":"authorized_senders","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Listedsenders","schema":[]}},"blocked_senders":{"title":"blocked_senders","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Listedsenders","schema":[]}},"has_dkim_signature":{"title":"has_dkim_signature","type":"boolean"},"is_dkim_updatable":{"title":"is_dkim_updatable","type":"boolean"},"has_mail_filtering":{"title":"has_mail_filtering","type":"boolean"},"mail_filtering_folder_commercials":{"title":"mail_filtering_folder_commercials","type":"string"},"mail_filtering_folder_social_networks":{"title":"mail_filtering_folder_social_networks","type":"string"},"is_auth":{"title":"is_auth","type":"boolean"},"is_removable":{"title":"is_removable","type":"boolean"},"permissions":{"title":"permissions","type":"object","properties":{"has_technical_right":{"title":"has_technical_right","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_access_logs":{"title":"can_access_logs","type":"boolean"},"is_linked_to_user":{"title":"is_linked_to_user","type":"string"}}},"mailbox_id":{"title":"mailbox_id","type":"integer"},"is_used_for_account":{"title":"is_used_for_account","type":"string"},"account_user":{"$ref":"#\/components\/schemas\/93e74a89_UserV2","schema":[]},"external_mail_flag_enabled":{"title":"external_mail_flag_enabled","type":"string","description":"Indicates if the mailbox has the option to mark mail from external provider activated","nullable":true},"smtpban_bounce":{"title":"smtpban_bounce","type":"string"},"smtpban_auth":{"title":"smtpban_auth","type":"string"},"smtpban_url":{"title":"smtpban_url","type":"string","nullable":true},"private":{"title":"private","type":"object","properties":[]},"count_devices":{"title":"count_devices","type":"integer"},"has_legacy_device":{"title":"has_legacy_device","type":"boolean"},"has_multi_password":{"title":"has_multi_password","type":"boolean"},"access_rights":{"title":"access_rights","type":"object","properties":{"can_create_webmail_access":{"title":"can_create_webmail_access","type":"boolean"},"can_create_device":{"title":"can_create_device","type":"boolean"},"can_delete_device_legacy":{"title":"can_delete_device_legacy","type":"boolean"},"can_regenerate_device_legacy":{"title":"can_regenerate_device_legacy","type":"boolean"},"can_ask_reset_password":{"title":"can_ask_reset_password","type":"boolean"},"can_create_webmail_access_for_login":{"title":"can_create_webmail_access_for_login","type":"boolean"},"can_list_users":{"title":"can_list_users","type":"boolean"}}}}},"93e74a89_CreatedMailbox":{"title":"Created Mailbox","required":["mailbox","quota","total","used"],"type":"object","properties":{"mailbox":{"title":"mailbox","type":"string"},"quota":{"title":"quota","type":"integer","description":"The limit of memory associated with the mail service in Mo"},"used":{"title":"used","type":"integer","description":"The current number of mailboxes on the service"},"total":{"title":"total","type":"integer","description":"The total number of mailboxes that service can have"},"existing_user_email":{"title":"existing_user_email","type":"boolean"}}},"93e74a89_":{"title":"App\\Http\\Resources\\MailHostings\\ResetPasswordToken","required":["token","url"],"type":"object","properties":{"token":{"title":"token","type":"string"},"url":{"title":"url","type":"string"}}},"93e74a89_MailingListSubscriber":{"title":"Mailing List Subscriber","required":["errors","mail","mailIDN"],"type":"object","properties":{"mail":{"title":"mail","type":"string","description":"The subscriber's mailing address"},"mailIDN":{"title":"mailIDN","type":"string"},"errors":{"$ref":"#\/components\/schemas\/93e74a89_MailingListSubscriberErrorReport","schema":[]}}},"93e74a89_Mailinglist":{"title":"Mailing list","required":["being_deleted","config","info","mail","mailIDN","name","user_count"],"type":"object","properties":{"mail":{"title":"mail","type":"string","description":"The mail that is used to send the email to the subscriber"},"mailIDN":{"title":"mailIDN","type":"string"},"name":{"title":"name","type":"string","description":"The name of the mailing list"},"info":{"title":"info","type":"string","description":"The information about the mailing list"},"user_count":{"title":"user_count","type":"integer","description":"The number of subscriber associated with the mailing list"},"being_deleted":{"title":"being_deleted","type":"boolean","description":"Indicates if the mailing list is in the process to be deleted"},"config":{"$ref":"#\/components\/schemas\/93e74a89_Mailinglistconfig","schema":[]},"welcome_message":{"title":"welcome_message","type":"string","description":"The message sent when someone is a new subscriber","example":"Welcome to this new mailing list"},"goodbye_message":{"title":"goodbye_message","type":"string","description":"The message sent when someone unsubscribes from the mailing list"},"moderator":{"title":"moderator","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Mailinglistmoderator","schema":[]},"description":"Emails of all the moderators of the mailing list"}}},"93e74a89_Mailservicecurrentlyunavailableforcauseofswap":{"title":"Mail service currently unavailable for cause of swap","required":["swap"],"type":"object","properties":{"swap":{"title":"swap","enum":["ERROR","IN_PROGRESS","NO_SWAP"],"type":"string","description":"the current swap state of the domain"}}},"93e74a89_Invitationtoamailbox":{"title":"Invitation to a mailbox","required":["expired_at","is_used","is_valid","key","mailbox","mailbox_idn","mailbox_name","permissions","sent_to","short_url","signature_template_id"],"type":"object","properties":{"short_url":{"title":"short_url","type":"string","description":"The invitation url","example":"https:\/\/example.com"},"key":{"title":"key","type":"string"},"sent_to":{"title":"sent_to","type":"string","example":"Invitation recipient email address"},"permissions":{"$ref":"#\/components\/schemas\/93e74a89_Permissiononmailbox","schema":[]},"expired_at":{"title":"expired_at","type":"integer","description":"The expiration date of the invitation","format":"timestamp"},"is_valid":{"title":"is_valid","type":"boolean","description":"Indicates if the invitation is still working"},"is_used":{"title":"is_used","type":"boolean","description":"Indicates if the invitation has already been used"},"signature_template_id":{"title":"signature_template_id","type":"string"},"mailbox":{"title":"mailbox","type":"object","properties":{"mailbox_name":{"title":"mailbox_name","type":"string"},"mailbox":{"title":"mailbox","type":"string"},"mailbox_idn":{"title":"mailbox_idn","type":"string"}}}}},"93e74a89_MailboxSieveFilter":{"title":"Mailbox Sieve Filter","required":["filters","prevent_script","script","scripts","templates","use_scripts"],"type":"object","properties":{"prevent_script":{"title":"prevent_script","type":"boolean","description":"Indicates if your account can use script or not"},"use_scripts":{"title":"use_scripts","type":"boolean","description":"Indicates if the mailbox use script or base filter"},"scripts":{"title":"scripts","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Advancedsievefilterscript","schema":[]}},"filters":{"title":"filters","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_MailboxFilter","schema":[]}},"script":{"title":"script","type":"string"},"templates":{"title":"templates","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_ServiceMailboxSieveFilter","schema":[]}}}},"93e74a89_MailboxFolders":{"title":"Mailbox Folders","required":["archives_folder","commercials_folder","draft_folder","folders","sent_folder","social_networks_folder","spam_folder","trash_folder"],"type":"object","properties":{"folders":{"title":"folders","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Singlemailboxfolder","schema":[]},"example":"[{'name':'name_example'}]"},"draft_folder":{"title":"draft_folder","type":"string"},"trash_folder":{"title":"trash_folder","type":"string"},"sent_folder":{"title":"sent_folder","type":"string"},"spam_folder":{"title":"spam_folder","type":"string"},"archives_folder":{"title":"archives_folder","type":"string"},"commercials_folder":{"title":"commercials_folder","type":"string"},"social_networks_folder":{"title":"social_networks_folder","type":"string"}}},"93e74a89_MailboxSignature":{"title":"Mailbox Signature","required":["aliases","default_reply_signature_id","default_signature_id","is_forced","position","signatures","valid_emails","verified_emails"],"type":"object","properties":{"signatures":{"title":"signatures","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Signature","schema":[]}},"default_signature_id":{"title":"default_signature_id","type":"integer","nullable":true},"default_reply_signature_id":{"title":"default_reply_signature_id","type":"integer","nullable":true},"position":{"title":"position","enum":["bottom","top"],"type":"string","description":"Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.<note>bottom<\/strong>: The signature is placed at the bottom of the email.<\/note><note>top<\/strong>: The signature is placed at the top of the email.<\/note>","example":"bottom"},"verified_emails":{"title":"verified_emails","type":"array"},"valid_emails":{"title":"valid_emails","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_ValidEmail","schema":[]},"description":"List of emails validated"},"is_forced":{"title":"is_forced","type":"boolean"},"aliases":{"title":"aliases","type":"array","items":{"*":{"title":"*","type":"string"}},"description":"List of aliases"}}},"93e74a89_Signature":{"title":"Signature","required":["content","filled_at","full_name","fullname","has_infomaniak_footer","id","is_auto","is_default","name","position","reply_to","reply_to_id","reply_to_idn","sender","sender_id","sender_idn","template"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Signature`","example":123456},"name":{"title":"name","type":"string","description":"Name of the resource `Signature`"},"fullname":{"title":"fullname","type":"string"},"full_name":{"title":"full_name","type":"string"},"content":{"title":"content","type":"string"},"position":{"title":"position","enum":["bottom","top"],"type":"string","description":"Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.<note>bottom<\/strong>: The signature is placed at the bottom of the email.<\/note><note>top<\/strong>: The signature is placed at the top of the email.<\/note>","example":"bottom"},"attributes":{"title":"attributes","type":"array","example":"[{key:'FIRSTNAME', value:'John', status:'user'}]"},"form_data":{"title":"form_data","type":"object","nullable":true},"filled_at":{"title":"filled_at","type":"integer","format":"timestamp"},"is_auto":{"title":"is_auto","type":"boolean"},"is_default":{"title":"is_default","type":"boolean","example":true},"sender":{"title":"sender","type":"string","nullable":true},"sender_idn":{"title":"sender_idn","type":"string","nullable":true},"sender_id":{"title":"sender_id","type":"integer"},"reply_to":{"title":"reply_to","type":"string","nullable":true},"reply_to_idn":{"title":"reply_to_idn","type":"string","nullable":true},"reply_to_id":{"title":"reply_to_id","type":"integer"},"has_infomaniak_footer":{"title":"has_infomaniak_footer","type":"boolean"},"template":{"$ref":"#\/components\/schemas\/93e74a89_SignatureTemplate","schema":[]},"user_access":{"$ref":"#\/components\/schemas\/93e74a89_SignatureUserAccess","schema":[]}}},"93e74a89_MailboxRedirection":{"title":"Mailbox Redirection","required":["has_dont_deliver","has_forward_spam","is_enabled","redirect_adresses"],"type":"object","properties":{"is_enabled":{"title":"is_enabled","type":"string","description":"Indicates if the mailbox redirects mail"},"redirect_adresses":{"title":"redirect_adresses","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_RedirectionAddress","schema":[]}},"has_dont_deliver":{"title":"has_dont_deliver","type":"string","description":"Indicates if the mailbox should delete emails locally after forwarding them"},"has_forward_spam":{"title":"has_forward_spam","type":"string","description":"Indicates if the mailbox should forward mail that are considered to be spam"}}},"93e74a89_CreateForwardingResponse":{"title":"Create Forwarding Response","required":["email","email_idn","has_dont_deliver"],"type":"object","properties":{"email":{"title":"email","type":"string","description":"Email where the emails are sent"},"email_idn":{"title":"email_idn","type":"string","description":"Mail with special character like \u00e9 or other"},"has_dont_deliver":{"title":"has_dont_deliver","type":"boolean","description":"Indicates if the mailbox should delete emails locally after forwarding them"}}},"93e74a89_MailboxAliases":{"title":"Mailbox Aliases","required":["aliases","enabled_alias"],"type":"object","properties":{"enabled_alias":{"title":"enabled_alias","type":"integer"},"aliases":{"title":"aliases","type":"array","items":{"type":"string","ref":false,"primitive":false,"collection":false,"one-of":false,"format":null,"optional":false,"title":"aliases","description":"The list of a aliases of the mailbox.","conditional":false,"items":null,"in":null,"example":"alias@example.com","deprecated":null},"description":"The list of a aliases of the mailbox.","example":"alias@example.com"}}},"93e74a89_Redirection":{"title":"Redirection","required":["address","created_at","id","name","send_confirmation_requests_enabled","send_confirmation_requests_state","state","targets","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Unique identifier of the resource `Redirection`","example":"123456"},"name":{"title":"name","type":"string","description":"Name of the redirection"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Redirection` has been created","format":"datetime","nullable":true},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Redirection` has been updated","format":"datetime","nullable":true},"targets":{"title":"targets","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_RedirectionTarget","schema":[]}},"address":{"$ref":"#\/components\/schemas\/93e74a89_RedirectionAddress_fc08f222","schema":[]},"state":{"title":"state","type":"string","example":"disabled"},"send_confirmation_requests_enabled":{"title":"send_confirmation_requests_enabled","type":"boolean"},"send_confirmation_requests_state":{"title":"send_confirmation_requests_state","type":"string"}}},"93e74a89_RedirectionTarget":{"title":"Redirection Target","required":["address","created_at","id","opted_in_at","optin_code","optin_expires_at","state","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Unique identifier of the resource `Redirection Target`","example":"123456"},"address":{"title":"address","type":"string","description":"targeted email address"},"optin_code":{"title":"optin_code","type":"string","nullable":true},"optin_expires_at":{"title":"optin_expires_at","type":"integer","format":"datetime","nullable":true},"opted_in_at":{"title":"opted_in_at","type":"integer","format":"datetime","nullable":true},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Redirection Target` has been created","format":"datetime","nullable":true},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Redirection Target` has been updated","format":"datetime","nullable":true},"state":{"title":"state","type":"string"}}},"93e74a89_UserAccessorInvitationtoaccessamailbox":{"title":"User Access or Invitation to access a mailbox","type":"object","properties":{"user_access":{"$ref":"#\/components\/schemas\/93e74a89_UserAccess","schema":[]},"invitation":{"$ref":"#\/components\/schemas\/93e74a89_Invitationtoaccessamailbox","schema":[]}}},"93e74a89_Invitationtoaccessamailbox":{"title":"Invitation to access a mailbox","required":["can_access_logs","can_change_password","can_configure_mail_folders","can_manage_aliases","can_manage_auto_reply","can_manage_filters","can_manage_redirections","can_manage_rules","can_manage_security","can_manage_signatures","can_restore_emails","expired_at","key","permissions","sent_to","short_url","signature_template_id"],"type":"object","properties":{"short_url":{"title":"short_url","type":"string","description":"The invitation url","example":"https:\/\/example.com"},"key":{"title":"key","type":"string"},"sent_to":{"title":"sent_to","type":"string","example":"Invitation recipient email address"},"expired_at":{"title":"expired_at","type":"integer","description":"The expiration date of the invitation","format":"timestamp"},"signature_template_id":{"title":"signature_template_id","type":"string"},"creator":{"$ref":"#\/components\/schemas\/93e74a89_User","schema":[]},"permissions":{"title":"permissions","type":"object","properties":{"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_access_logs":{"title":"can_access_logs","type":"boolean"}}}}},"93e74a89_DeviceAccess":{"title":"Device Access","required":["can_delete","can_regenerate","created_at","id","last_connection","mailbox","mailbox_idn","mailbox_name","protocols","service_mail_id","status"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Device Access`","example":123456},"device":{"$ref":"#\/components\/schemas\/93e74a89_Device","schema":[]},"protocols":{"title":"protocols","enum":["imap","pop3","pop3-imap"],"type":"string","description":"Specifies the protocol of the access. By default, all protocol choices include smtp protocol.<note>imap<\/strong>: The protocol is imap.<\/note><note>pop3<\/strong>: The protocol is pop3.<\/note><note>pop3-imap<\/strong>: The protocol is imap and pop3.<\/note>","example":"imap"},"last_connection":{"title":"last_connection","type":"integer","format":"datetime","nullable":true},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Device Access` has been created","format":"datetime"},"status":{"title":"status","enum":["healthy","leaked","spam"],"type":"string","description":"Specifies the status of the access.<note>healthy<\/strong>: The password is healthy.<\/note><note>leaked<\/strong>: The password was leaked.<\/note><note>spam<\/strong>: The password was sending spam.<\/note>","example":"healthy"},"user_access":{"$ref":"#\/components\/schemas\/93e74a89_User","schema":[]},"creator":{"$ref":"#\/components\/schemas\/93e74a89_User","schema":[]},"mailbox":{"title":"mailbox","type":"object","properties":{"mailbox_name":{"title":"mailbox_name","type":"string"},"mailbox":{"title":"mailbox","type":"string"},"mailbox_idn":{"title":"mailbox_idn","type":"string"},"service_mail_id":{"title":"service_mail_id","type":"integer"}}},"access_rights":{"title":"access_rights","type":"object","properties":{"can_delete":{"title":"can_delete","type":"boolean"},"can_regenerate":{"title":"can_regenerate","type":"boolean"}}}}},"93e74a89_GeneratedPassword":{"title":"Generated Password","required":["password"],"type":"object","properties":{"password":{"title":"password","type":"string"}}},"93e74a89_ServiceMailpreferences":{"title":"Service Mail preferences","required":["authorized_senders","blocked_senders","can_access_logs","can_change_password","can_configure_mail_folders","can_manage_aliases","can_manage_auto_reply","can_manage_filters","can_manage_redirections","can_manage_rules","can_manage_security","can_manage_signatures","can_restore_emails","created_at","default_permissions","external_mail_flag_enabled","promotion_filter_enabled","spam_filter_enabled","updated_at"],"type":"object","properties":{"default_permissions":{"title":"default_permissions","type":"object","properties":{"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_access_logs":{"title":"can_access_logs","type":"boolean"}}},"spam_filter_enabled":{"title":"spam_filter_enabled","type":"boolean"},"promotion_filter_enabled":{"title":"promotion_filter_enabled","type":"boolean"},"external_mail_flag_enabled":{"title":"external_mail_flag_enabled","type":"boolean"},"authorized_senders":{"title":"authorized_senders","type":"array","items":{"type":"string","ref":false,"primitive":false,"collection":false,"one-of":false,"format":null,"optional":false,"title":"authorized_senders","conditional":false,"items":null,"in":null,"deprecated":null}},"blocked_senders":{"title":"blocked_senders","type":"array","items":{"type":"string","ref":false,"primitive":false,"collection":false,"one-of":false,"format":null,"optional":false,"title":"blocked_senders","conditional":false,"items":null,"in":null,"deprecated":null}},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Service Mail preferences` has been created","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Service Mail preferences` has been updated","format":"timestamp"}}},"93e74a89_Mailboxusersandinvitations":{"title":"Mailbox users and invitations","required":["users"],"type":"object","properties":{"users":{"title":"users","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_MailboxUser","schema":[]}},"invitations":{"title":"invitations","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_Invitationtoamailbox","schema":[]}}}},"93e74a89_ServiceMailboxresponder":{"title":"Service Mailbox responder","required":["ended_at","id","is_active","is_model","is_recurrent","is_visible","message","name","recurrent_days","source_model_id","started_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Service Mailbox responder`","example":123456},"name":{"title":"name","type":"string","description":"Name of the resource `Service Mailbox responder`"},"message":{"title":"message","type":"string","description":"Content of the auto reply"},"is_active":{"title":"is_active","type":"boolean","description":"Is the auto reply active"},"recurrent_days":{"$ref":"#\/components\/schemas\/93e74a89_RecurrentDays","schema":[]},"started_at":{"title":"started_at","type":"integer","description":"Timestamp `Service Mailbox responder` has been started","format":"timestamp","nullable":true},"ended_at":{"title":"ended_at","type":"integer","description":"Timestamp `Service Mailbox responder` has ended","format":"timestamp","nullable":true},"reply_from":{"title":"reply_from","type":"string","description":"Email that send the auto reply"},"valid_emails":{"title":"valid_emails","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_ValidEmail","schema":[]},"description":"List of emails validated"},"is_model":{"title":"is_model","type":"boolean"},"is_visible":{"title":"is_visible","type":"boolean","nullable":true},"is_recurrent":{"title":"is_recurrent","type":"boolean"},"reply_from_id":{"title":"reply_from_id","type":"integer","description":"Id of the Email that send the auto reply"},"source_model_id":{"title":"source_model_id","type":"integer","nullable":true},"dont_reply_to":{"title":"dont_reply_to","type":"array","description":"List of emails the auto reply won't respond to","example":"[test@tests.ch]"}}},"93e74a89_Device":{"title":"Device","required":["created_at","device_uid","id","label","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Device`","example":123456},"label":{"title":"label","type":"string"},"type":{"title":"type","enum":["computer","legacy","other","phone","tablet"],"type":"string","description":"Specifies the type of the device.<note>computer<\/strong>: The device is a computer.<\/note><note>legacy<\/strong>: The device'password is a legacy password used by all users before the feature of multiples password.<\/note><note>other<\/strong>: The device is an other type.<\/note><note>phone<\/strong>: The device is a phone.<\/note><note>tablet<\/strong>: The device is a tablet.<\/note>","example":"computer"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Device` has been created","format":"datetime"},"device_uid":{"title":"device_uid","type":"string","nullable":true},"accesses":{"title":"accesses","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_DeviceAccess","schema":[]}},"count_accesses":{"title":"count_accesses","type":"integer"},"last_connection":{"title":"last_connection","type":"integer","format":"datetime","nullable":true},"locked_accesses_count":{"title":"locked_accesses_count","type":"integer"}}},"93e74a89_UserV2":{"title":"UserV2","required":["avatar","display_name","email","first_name","id","is_sso","last_name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `UserV2`","example":123456},"display_name":{"title":"display_name","type":"string","description":"Display name"},"first_name":{"title":"first_name","type":"string","description":"First name"},"last_name":{"title":"last_name","type":"string","description":"Last name"},"email":{"title":"email","type":"string","description":"Email"},"avatar":{"title":"avatar","type":"string","description":"Avatar"},"is_sso":{"title":"is_sso","type":"boolean"}}},"93e74a89_UserAccess":{"title":"User Access","required":["can_access_logs","can_ask_reset_password","can_change_password","can_configure_mail_folders","can_delete","can_manage_aliases","can_manage_auto_reply","can_manage_filters","can_manage_redirections","can_manage_rules","can_manage_security","can_manage_signatures","can_restore_emails","created_at","has_technical_right","has_valid_password","id","is_free","is_limited","is_primary","ksuite_customer_name","last_used_at","mailbox_email","mailbox_id","mailbox_idn","mailbox_name","permissions","permissions_binary","service_mail_id","status","type","user"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `User Access`","example":123456},"user":{"$ref":"#\/components\/schemas\/93e74a89_UserV2","schema":[]},"creator":{"$ref":"#\/components\/schemas\/93e74a89_UserV2","schema":[]},"status":{"title":"status","enum":["healthy","new"],"type":"string","description":"Specifies the status of the access.<note>healthy<\/strong>: The access is healthy.<\/note><note>new<\/strong>: The access is new.<\/note>","example":"healthy"},"last_used_at":{"title":"last_used_at","type":"integer","format":"datetime","nullable":true},"is_primary":{"title":"is_primary","type":"boolean"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `User Access` has been created","format":"datetime"},"access_rights":{"title":"access_rights","type":"object","properties":{"can_delete":{"title":"can_delete","type":"boolean"},"can_ask_reset_password":{"title":"can_ask_reset_password","type":"boolean"}}},"permissions_binary":{"title":"permissions_binary","type":"integer"},"permissions":{"title":"permissions","type":"array","items":{"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_access_logs":{"title":"can_access_logs","type":"boolean"}}},"mailbox":{"title":"mailbox","type":"array","items":{"mailbox_id":{"title":"mailbox_id","type":"integer"},"mailbox_name":{"title":"mailbox_name","type":"string"},"mailbox_email":{"title":"mailbox_email","type":"string"},"mailbox_idn":{"title":"mailbox_idn","type":"string"},"service_mail_id":{"title":"service_mail_id","type":"integer"},"is_free":{"title":"is_free","type":"boolean","description":"Does the resource `User Access` have a free price status?"},"is_limited":{"title":"is_limited","type":"boolean"},"has_technical_right":{"title":"has_technical_right","type":"boolean"}}},"is_ksuite_access":{"title":"is_ksuite_access","type":"boolean"},"ksuite":{"title":"ksuite","type":"array","items":{"type":{"title":"type","type":"boolean","nullable":true},"ksuite_customer_name":{"title":"ksuite_customer_name","type":"string"}},"nullable":true},"has_multi_password":{"title":"has_multi_password","type":"boolean"},"has_valid_password":{"title":"has_valid_password","type":"boolean"},"has_device":{"title":"has_device","type":"boolean"}}},"93e74a89_SubscribeandUnsubscribeMailingListForm":{"title":"Subscribe and Unsubscribe Mailing List Form","required":["subscription","unsubscription"],"type":"object","properties":{"subscription":{"title":"subscription","type":"string","description":"An HTML form for subscribing to the concerned mailing list","example":"<form action=\"link\"\/>\n<input type=\"hidden\" name=\"action\" value=\"add\"\/>\n<input type=\"email\" name=\"email\" required\/>\n<input type=\"submit\" value=\"example\"\/>\n<\/form>"},"unsubscription":{"title":"unsubscription","type":"string","description":"An HTML form for unsubscribing to the concerned mailing list","example":"<form action=\\\"link\\\"\/>\\n<input type=\\\"hidden\\\" name=\\\"action\\\" value=\\\"add\\\"\/>\\n<input type=\\\"email\\\" name=\\\"email\\\" required\/>\\n<input type=\\\"submit\\\" value=\\\"example\\\"\/>\\n<\/form>"}}},"afdc46e4_CalendarEventAttendees":{"title":"Event attendee","required":["address","state"],"type":"object","properties":{"address":{"title":"Email address","type":"string","example":"myemail@ik.me"},"organizer":{"title":"Attendee is organizer or not","type":"boolean"},"state":{"title":"State of the attendee","type":"string","enum":["NEEDS-ACTION","ACCEPTED","DECLINED","TENTATIVE","DELEGATED"]},"name":{"title":"Name","type":"string","maxLength":100}}},"afdc46e4_ConferenceOptions":{"title":"Room settings","required":["subject","start_audio_muted","enable_recording","enable_moderator_video","start_audio_only","lobby_enabled","password_enabled","e2ee_enabled"],"type":"object","properties":{"subject":{"title":"Subject","type":"string"},"start_audio_muted":{"title":"Start with audio muted","type":"boolean"},"enable_recording":{"title":"Enable auto recording","type":"boolean"},"drive_id":{"title":"The unique identifier (ID) of the kDrive","description":"Required if enable_recording is true","type":"integer"},"enable_moderator_video":{"title":"Enable video for moderator","type":"boolean"},"start_audio_only":{"title":"Start with audio only","type":"boolean"},"lobby_enabled":{"title":"Enable lobby","type":"boolean"},"password_enabled":{"title":"Enable password","type":"boolean"},"password":{"title":"Password","description":"Required if password_enabled is true (never displayed)","type":"string"},"e2ee_enabled":{"title":"Enable end to end encryption","type":"boolean"}}},"afdc46e4_ConferenceOptionsReturn":{"title":"Room settings","required":["subject","start_audio_muted","enable_recording","enable_moderator_video","start_audio_only","lobby_enabled","password_enabled","e2ee_enabled"],"type":"object","properties":{"subject":{"title":"Subject","type":"string"},"start_audio_muted":{"title":"Start with audio muted","type":"boolean"},"enable_recording":{"title":"Enable auto recording","type":"boolean"},"drive_id":{"title":"The unique identifier (ID) of the kDrive","description":"Required if enable_recording is true","type":"integer"},"enable_moderator_video":{"title":"Enable video for moderator","type":"boolean"},"start_audio_only":{"title":"Start with audio only","type":"boolean"},"lobby_enabled":{"title":"Enable lobby","type":"boolean"},"password_enabled":{"title":"Enable password","type":"boolean"},"e2ee_enabled":{"title":"Enable end to end encryption","type":"boolean"}}},"38cb7293_UserNotifyProps":{"type":"object","properties":{"email":{"type":"string","description":"Set to \"true\" to enable email notifications, \"false\" to disable. Defaults to \"true\"."},"push":{"type":"string","description":"Set to \"all\" to receive push notifications for all activity, \"mention\" for mentions and direct messages only, and \"none\" to disable. Defaults to \"mention\"."},"desktop":{"type":"string","description":"Set to \"all\" to receive desktop notifications for all activity, \"mention\" for mentions and direct messages only, and \"none\" to disable. Defaults to \"all\"."},"desktop_sound":{"type":"string","description":"Set to \"true\" to enable sound on desktop notifications, \"false\" to disable. Defaults to \"true\"."},"mention_keys":{"type":"string","description":"A comma-separated list of words to count as mentions. Defaults to username and @username."},"channel":{"type":"string","description":"Set to \"true\" to enable channel-wide notifications (@channel, @all, etc.), \"false\" to disable. Defaults to \"true\"."},"first_name":{"type":"string","description":"Set to \"true\" to enable mentions for first name. Defaults to \"true\" if a first name is set, \"false\" otherwise."}}},"38cb7293_Timezone":{"type":"object","properties":{"useAutomaticTimezone":{"type":"boolean","description":"Set to \"true\" to use the browser\/system timezone, \"false\" to set manually. Defaults to \"true\"."},"manualTimezone":{"type":"string","description":"Value when setting manually the timezone, i.e. \"Europe\/Berlin\"."},"automaticTimezone":{"type":"string","description":"This value is set automatically when the \"useAutomaticTimezone\" is set to \"true\"."}}},"38cb7293_ChannelNotifyProps":{"type":"object","properties":{"email":{"type":"string","description":"Set to \"true\" to enable email notifications, \"false\" to disable, or \"default\" to use the global user notification setting."},"push":{"type":"string","description":"Set to \"all\" to receive push notifications for all activity, \"mention\" for mentions and direct messages only, \"none\" to disable, or \"default\" to use the global user notification setting."},"desktop":{"type":"string","description":"Set to \"all\" to receive desktop notifications for all activity, \"mention\" for mentions and direct messages only, \"none\" to disable, or \"default\" to use the global user notification setting."},"mark_unread":{"type":"string","description":"Set to \"all\" to mark the channel unread for any new message, \"mention\" to mark unread for new mentions only. Defaults to \"all\"."}}},"38cb7293_ChannelMember":{"type":"object","properties":{"channel_id":{"type":"string"},"user_id":{"type":"string"},"roles":{"type":"string"},"last_viewed_at":{"description":"The time in milliseconds the channel was last viewed by the user","type":"integer","format":"int64"},"msg_count":{"type":"integer"},"mention_count":{"type":"integer"},"notify_props":{"$ref":"#\/components\/schemas\/38cb7293_ChannelNotifyProps"},"last_update_at":{"description":"The time in milliseconds the channel member was last updated","type":"integer","format":"int64"}}},"38cb7293_Channel":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a channel was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a channel was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a channel was deleted","type":"integer","format":"int64"},"team_id":{"type":"string"},"type":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"},"header":{"type":"string"},"purpose":{"type":"string"},"last_post_at":{"description":"The time in milliseconds of the last post of a channel","type":"integer"},"total_msg_count":{"type":"integer"},"creator_id":{"type":"string"}}},"38cb7293_ChannelWithTeamData":{"allOf":[{"$ref":"#\/components\/schemas\/38cb7293_Channel"},{"type":"object","properties":{"team_display_name":{"type":"string","description":"The display name of the team to which this channel belongs."},"team_name":{"type":"string","description":"The name of the team to which this channel belongs."},"team_update_at":{"type":"integer","description":"The time at which the team to which this channel belongs was last updated."},"policy_id":{"type":"string","description":"The data retention policy to which this team has been assigned. If no such policy exists, or the caller does not have the `sysconsole_read_compliance_data_retention` permission, this field will be null."}}}]},"38cb7293_PostMetadata":{"type":"object","description":"Additional information used to display a post.","properties":{"embeds":{"type":"array","description":"Information about content embedded in the post including OpenGraph previews, image link previews, and message attachments. This field will be null if the post does not contain embedded content.\n","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of content that is embedded in this point.","enum":["image","message_attachment","opengraph","link"]},"url":{"type":"string","description":"The URL of the embedded content, if one exists."},"data":{"type":"object","description":"Any additional information about the embedded content. Only used at this time to store OpenGraph metadata.\nThis field will be null for non-OpenGraph embeds.\n"}}}},"emojis":{"type":"array","description":"The custom emojis that appear in this point or have been used in reactions to this post. This field will be null if the post does not contain custom emojis.\n","items":{"$ref":"#\/components\/schemas\/38cb7293_Emoji"}},"files":{"type":"array","description":"The FileInfo objects for any files attached to the post. This field will be null if the post does not have any file attachments.\n","items":{"$ref":"#\/components\/schemas\/38cb7293_FileInfo"}},"images":{"type":"object","description":"An object mapping the URL of an external image to an object containing the dimensions of that image. This field will be null if the post or its embedded content does not reference any external images.\n","items":{"type":"object","properties":{"height":{"type":"integer"},"width":{"type":"integer"}}}},"reactions":{"type":"array","description":"Any reactions made to this point. This field will be null if no reactions have been made to this post.\n","items":{"$ref":"#\/components\/schemas\/38cb7293_Reaction"}}}},"38cb7293_FileInfo":{"type":"object","properties":{"id":{"description":"The unique identifier for this file","type":"string"},"user_id":{"description":"The ID of the user that uploaded this file","type":"string"},"post_id":{"description":"If this file is attached to a post, the ID of that post","type":"string"},"create_at":{"description":"The time in milliseconds a file was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a file was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a file was deleted","type":"integer","format":"int64"},"name":{"description":"The name of the file","type":"string"},"extension":{"description":"The extension at the end of the file name","type":"string"},"size":{"description":"The size of the file in bytes","type":"integer"},"mime_type":{"description":"The MIME type of the file","type":"string"},"width":{"description":"If this file is an image, the width of the file","type":"integer"},"height":{"description":"If this file is an image, the height of the file","type":"integer"},"has_preview_image":{"description":"If this file is an image, whether or not it has a preview-sized version","type":"boolean"}}},"38cb7293_Post":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a post was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a post was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a post was deleted","type":"integer","format":"int64"},"edit_at":{"type":"integer","format":"int64"},"user_id":{"type":"string"},"channel_id":{"type":"string"},"root_id":{"type":"string"},"original_id":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"},"props":{"type":"object"},"hashtag":{"type":"string"},"file_ids":{"type":"array","items":{"type":"string"}},"pending_post_id":{"type":"string"},"metadata":{"$ref":"#\/components\/schemas\/38cb7293_PostMetadata"}}},"38cb7293_Emoji":{"type":"object","properties":{"id":{"description":"The ID of the emoji","type":"string"},"creator_id":{"description":"The ID of the user that made the emoji","type":"string"},"name":{"description":"The name of the emoji","type":"string"},"create_at":{"description":"The time in milliseconds the emoji was made","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds the emoji was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds the emoji was deleted","type":"integer","format":"int64"}}},"38cb7293_Reaction":{"type":"object","properties":{"user_id":{"description":"The ID of the user that made this reaction","type":"string"},"post_id":{"description":"The ID of the post to which this reaction was made","type":"string"},"emoji_name":{"description":"The name of the emoji that was used for this reaction","type":"string"},"create_at":{"description":"The time in milliseconds this reaction was made","type":"integer","format":"int64"}}},"38cb7293_TeamMember":{"type":"object","properties":{"team_id":{"description":"The ID of the team this member belongs to.","type":"string"},"user_id":{"description":"The ID of the user this member relates to.","type":"string"},"roles":{"description":"The complete list of roles assigned to this team member, as a space-separated list of role names, including any roles granted implicitly through permissions schemes.","type":"string"},"delete_at":{"description":"The time in milliseconds that this team member was deleted.","type":"integer"},"scheme_user":{"description":"Whether this team member holds the default user role defined by the team's permissions scheme.","type":"boolean"},"scheme_admin":{"description":"Whether this team member holds the default admin role defined by the team's permissions scheme.","type":"boolean"},"explicit_roles":{"description":"The list of roles explicitly assigned to this team member, as a space separated list of role names. This list does *not* include any roles granted implicitly through permissions schemes.","type":"string"}}},"38cb7293_User":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a user was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a user was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a user was deleted","type":"integer","format":"int64"},"username":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"nickname":{"type":"string"},"email":{"type":"string"},"email_verified":{"type":"boolean"},"auth_service":{"type":"string"},"roles":{"type":"string"},"locale":{"type":"string"},"notify_props":{"$ref":"#\/components\/schemas\/38cb7293_UserNotifyProps"},"props":{"type":"object"},"last_password_update":{"type":"integer"},"last_picture_update":{"type":"integer"},"failed_attempts":{"type":"integer"},"mfa_active":{"type":"boolean"},"timezone":{"$ref":"#\/components\/schemas\/38cb7293_Timezone"},"terms_of_service_id":{"description":"ID of accepted terms of service, if any. This field is not present if empty.","type":"string"},"terms_of_service_create_at":{"description":"The time in milliseconds the user accepted the terms of service","type":"integer","format":"int64"}}},"38cb7293_TopReaction":{"type":"object","properties":{"emoji_name":{"description":"The name of the emoji used for this reaction.","type":"string"},"count":{"description":"The number of the times this emoji has been used.","type":"integer","format":"int64"}}},"38cb7293_NewTeamMember":{"type":"object","properties":{"id":{"description":"The user's ID.","type":"string"},"username":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"nickname":{"type":"string"},"position":{"description":"The user's position field value.","type":"string"},"create_at":{"description":"The creation timestamp of the team member record.","type":"integer"}}},"38cb7293_TopChannel":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"},"team_id":{"type":"string"},"message_count":{"description":"The number of messages posted in the channel by users over the given time period (not including messages posted by bots).","type":"string"}}},"38cb7293_InsightUserInformation":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"nickname":{"type":"string"},"username":{"type":"string"},"last_picture_update":{"type":"string"},"create_at":{"type":"integer","format":"int64"}}},"38cb7293_TopThread":{"type":"object","properties":{"post":{"$ref":"#\/components\/schemas\/38cb7293_Post"},"channel_id":{"type":"string"},"channel_display_name":{"type":"string"},"channel_name":{"type":"string"},"Participants":{"type":"array","items":{"type":"string"}},"user_information":{"$ref":"#\/components\/schemas\/38cb7293_InsightUserInformation"}}},"38cb7293_TopDMInsightUserInformation":{"allOf":[{"$ref":"#\/components\/schemas\/38cb7293_InsightUserInformation"},{"type":"object","properties":{"position":{"type":"string"}}}]},"38cb7293_TopDM":{"type":"object","properties":{"post_count":{"type":"integer","format":"int64"},"outgoing_message_count":{"type":"integer","format":"int64"},"second_participant":{"$ref":"#\/components\/schemas\/38cb7293_TopDMInsightUserInformation"}}},"38cb7293_SlackAttachment":{"type":"object","properties":{"Id":{"type":"string"},"Fallback":{"type":"string"},"Color":{"type":"string"},"Pretext":{"type":"string"},"AuthorName":{"type":"string"},"AuthorLink":{"type":"string"},"AuthorIcon":{"type":"string"},"Title":{"type":"string"},"TitleLink":{"type":"string"},"Text":{"type":"string"},"Fields":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_SlackAttachmentField"}},"ImageURL":{"type":"string"},"ThumbURL":{"type":"string"},"Footer":{"type":"string"},"FooterIcon":{"type":"string"},"Timestamp":{"description":"The timestamp of the slack attachment, either type of string or integer","type":"string"}}},"38cb7293_SlackAttachmentField":{"type":"object","properties":{"Title":{"type":"string"},"Value":{"description":"The value of the attachment, set as string but capable with golang interface","type":"string"},"Short":{"type":"boolean"}}},"38cb7293_ChannelModeratedRoles":{"type":"object","properties":{"guests":{"$ref":"#\/components\/schemas\/38cb7293_ChannelModeratedRole"},"members":{"$ref":"#\/components\/schemas\/38cb7293_ChannelModeratedRole"}}},"38cb7293_ChannelModeratedRole":{"type":"object","properties":{"value":{"type":"boolean"},"enabled":{"type":"boolean"}}},"38cb7293_ChannelModeratedRolesPatch":{"type":"object","properties":{"guests":{"type":"boolean"},"members":{"type":"boolean"}}},"38cb7293_SidebarCategoryWithChannels":{"description":"User's sidebar category with it's channels","type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"team_id":{"type":"string"},"display_name":{"type":"string"},"type":{"type":"string","enum":["channels","custom","direct_messages","favorites"]},"channel_ids":{"type":"array","items":{"type":"string"}}}},"38cb7293_Group":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"source":{"type":"string"},"remote_id":{"type":"string"},"create_at":{"type":"integer","format":"int64"},"update_at":{"type":"integer","format":"int64"},"delete_at":{"type":"integer","format":"int64"},"has_syncables":{"type":"boolean"}}},"38cb7293_GroupWithSchemeAdmin":{"description":"group augmented with scheme admin information","type":"object","properties":{"group":{"$ref":"#\/components\/schemas\/38cb7293_Group"},"scheme_admin":{"type":"boolean"}}},"38cb7293_UserThread":{"description":"a thread that user is following","type":"object","properties":{"id":{"type":"string","description":"ID of the post that is this thread's root"},"reply_count":{"type":"integer","description":"number of replies in this thread"},"last_reply_at":{"type":"integer","format":"int64","description":"timestamp of the last post to this thread"},"last_viewed_at":{"type":"integer","format":"int64","description":"timestamp of the last time the user viewed this thread"},"participants":{"type":"array","description":"list of users participating in this thread. only includes IDs unless 'extended' was set to 'true'","items":{"$ref":"#\/components\/schemas\/38cb7293_Post"}},"post":{"$ref":"#\/components\/schemas\/38cb7293_Post"}}},"3e081f3c_Audio":{"properties":{"id":{"type":"string","title":"Id"}},"type":"object","required":["id"],"title":"Audio"},"3e081f3c_ChatCompletionContentPartTextParam":{"properties":{"text":{"type":"string","title":"Text"},"type":{"type":"string","const":"text","title":"Type"}},"type":"object","required":["text","type"],"title":"ChatCompletionContentPartTextParam"},"3e081f3c_ChatCompletionContentPartRefusalParam":{"properties":{"refusal":{"type":"string","title":"Refusal"},"type":{"type":"string","const":"refusal","title":"Type"}},"type":"object","required":["refusal","type"],"title":"ChatCompletionContentPartRefusalParam"},"3e081f3c_FunctionCall":{"properties":{"arguments":{"type":"string","title":"Arguments"},"name":{"type":"string","title":"Name"}},"type":"object","required":["arguments","name"],"title":"FunctionCall"},"3e081f3c_ChatCompletionMessageToolCallParam":{"properties":{"id":{"type":"string","title":"Id"},"function":{"$ref":"#\/components\/schemas\/3e081f3c_Function"},"type":{"type":"string","const":"function","title":"Type"}},"type":"object","required":["id","function","type"],"title":"ChatCompletionMessageToolCallParam"},"3e081f3c_AudioURL":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"AudioURL"},"3e081f3c_ImageURL":{"properties":{"url":{"type":"string","title":"Url"},"detail":{"type":"string","enum":["auto","low","high"],"title":"Detail"}},"type":"object","required":["url"],"title":"ImageURL"},"3e081f3c_InputAudio":{"properties":{"data":{"type":"string","title":"Data"},"format":{"type":"string","enum":["wav","mp3"],"title":"Format"}},"type":"object","required":["data","format"],"title":"InputAudio"},"3e081f3c_VideoURL":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"VideoURL"},"3e081f3c_Function":{"properties":{"arguments":{"type":"string","title":"Arguments"},"name":{"type":"string","title":"Name"}},"type":"object","required":["arguments","name"],"title":"Function"},"3e081f3c_ChatCompletionNamedFunction":{"properties":{"name":{"type":"string","title":"Name"}},"additionalProperties":true,"type":"object","required":["name"],"title":"ChatCompletionNamedFunction"},"3e081f3c_ChatCompletionDeveloperMessageParam":{"properties":{"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartTextParam"},"type":"array"}],"title":"Content"},"role":{"type":"string","const":"developer","title":"Role"},"name":{"type":"string","title":"Name"}},"type":"object","required":["content","role"],"title":"ChatCompletionDeveloperMessageParam"},"3e081f3c_ChatCompletionSystemMessageParam":{"properties":{"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartTextParam"},"type":"array"}],"title":"Content"},"role":{"type":"string","const":"system","title":"Role"},"name":{"type":"string","title":"Name"}},"type":"object","required":["content","role"],"title":"ChatCompletionSystemMessageParam"},"3e081f3c_ChatCompletionUserMessageParam":{"properties":{"content":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartTextParam"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartImageParam"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartInputAudioParam"},{"$ref":"#\/components\/schemas\/3e081f3c_File"}]},"type":"array"}],"title":"Content"},"role":{"type":"string","const":"user","title":"Role"},"name":{"type":"string","title":"Name"}},"type":"object","required":["content","role"],"title":"ChatCompletionUserMessageParam"},"3e081f3c_ChatCompletionAssistantMessageParam":{"properties":{"role":{"type":"string","const":"assistant","title":"Role"},"audio":{"anyOf":[{"$ref":"#\/components\/schemas\/3e081f3c_Audio"},{"type":"null"}]},"content":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartTextParam"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartRefusalParam"}]},"type":"array"},{"type":"null"}],"title":"Content"},"function_call":{"anyOf":[{"$ref":"#\/components\/schemas\/3e081f3c_FunctionCall"},{"type":"null"}]},"name":{"type":"string","title":"Name"},"refusal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refusal"},"tool_calls":{"items":{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionMessageToolCallParam"},"type":"array","title":"Tool Calls"}},"type":"object","required":["role"],"title":"ChatCompletionAssistantMessageParam"},"3e081f3c_ChatCompletionToolMessageParam":{"properties":{"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartTextParam"},"type":"array"}],"title":"Content"},"role":{"type":"string","const":"tool","title":"Role"},"tool_call_id":{"type":"string","title":"Tool Call Id"}},"type":"object","required":["content","role","tool_call_id"],"title":"ChatCompletionToolMessageParam"},"3e081f3c_ChatCompletionFunctionMessageParam":{"properties":{"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"name":{"type":"string","title":"Name"},"role":{"type":"string","const":"function","title":"Role"}},"type":"object","required":["content","name","role"],"title":"ChatCompletionFunctionMessageParam"},"3e081f3c_CustomChatCompletionMessageParam":{"properties":{"role":{"type":"string","title":"Role"},"content":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartTextParam"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartImageParam"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartInputAudioParam"},{"$ref":"#\/components\/schemas\/3e081f3c_File"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartAudioParam"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartVideoParam"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartRefusalParam"},{"$ref":"#\/components\/schemas\/3e081f3c_CustomChatCompletionContentSimpleImageParam"},{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionContentPartImageEmbedsParam"},{"$ref":"#\/components\/schemas\/3e081f3c_CustomChatCompletionContentSimpleAudioParam"},{"$ref":"#\/components\/schemas\/3e081f3c_CustomChatCompletionContentSimpleVideoParam"},{"type":"string"}]},"type":"array"}],"title":"Content"},"name":{"type":"string","title":"Name"},"tool_call_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Call Id"},"tool_calls":{"anyOf":[{"items":{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionMessageToolCallParam"},"type":"array"},{"type":"null"}],"title":"Tool Calls"}},"type":"object","required":["role"],"title":"CustomChatCompletionMessageParam","description":"Enables custom roles in the Chat Completion API."},"3e081f3c_ResponseFormat":{"properties":{"type":{"type":"string","enum":["text","json_object","json_schema"],"title":"Type"},"json_schema":{"anyOf":[{"$ref":"#\/components\/schemas\/3e081f3c_JsonSchemaResponseFormat"},{"type":"null"}]}},"additionalProperties":true,"type":"object","required":["type"],"title":"ResponseFormat"},"3e081f3c_StructuralTagResponseFormat":{"properties":{"type":{"type":"string","const":"structural_tag","title":"Type"},"structures":{"items":{"$ref":"#\/components\/schemas\/3e081f3c_StructuralTag"},"type":"array","title":"Structures"},"triggers":{"items":{"type":"string"},"type":"array","title":"Triggers"}},"additionalProperties":true,"type":"object","required":["type","structures","triggers"],"title":"StructuralTagResponseFormat"},"3e081f3c_StreamOptions":{"properties":{"include_usage":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Usage","default":true},"continuous_usage_stats":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Continuous Usage Stats","default":false}},"additionalProperties":true,"type":"object","title":"StreamOptions"},"3e081f3c_ChatCompletionToolsParam":{"properties":{"type":{"type":"string","const":"function","title":"Type","default":"function"},"function":{"$ref":"#\/components\/schemas\/3e081f3c_FunctionDefinition"}},"additionalProperties":true,"type":"object","required":["function"],"title":"ChatCompletionToolsParam"},"3e081f3c_ChatCompletionNamedToolChoiceParam":{"properties":{"function":{"$ref":"#\/components\/schemas\/3e081f3c_ChatCompletionNamedFunction"},"type":{"type":"string","const":"function","title":"Type","default":"function"}},"additionalProperties":true,"type":"object","required":["function"],"title":"ChatCompletionNamedToolChoiceParam"},"3e081f3c_BaseModel":{"properties":[],"type":"object","title":"BaseModel"},"3e081f3c_LogitsProcessorConstructor":{"properties":{"qualname":{"type":"string","title":"Qualname"},"args":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Args"},"kwargs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Kwargs"}},"type":"object","required":["qualname"],"title":"LogitsProcessorConstructor"},"3e081f3c_FunctionDefinition":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"parameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameters"}},"additionalProperties":true,"type":"object","required":["name"],"title":"FunctionDefinition"},"3e081f3c_ChatCompletionContentPartImageParam":{"properties":{"image_url":{"$ref":"#\/components\/schemas\/3e081f3c_ImageURL"},"type":{"type":"string","const":"image_url","title":"Type"}},"type":"object","required":["image_url","type"],"title":"ChatCompletionContentPartImageParam"},"3e081f3c_ChatCompletionContentPartInputAudioParam":{"properties":{"input_audio":{"$ref":"#\/components\/schemas\/3e081f3c_InputAudio"},"type":{"type":"string","const":"input_audio","title":"Type"}},"type":"object","required":["input_audio","type"],"title":"ChatCompletionContentPartInputAudioParam"},"3e081f3c_File":{"properties":{"file":{"$ref":"#\/components\/schemas\/3e081f3c_FileFile"},"type":{"type":"string","const":"file","title":"Type"}},"type":"object","required":["file","type"],"title":"File"},"3e081f3c_ChatCompletionContentPartAudioParam":{"properties":{"audio_url":{"$ref":"#\/components\/schemas\/3e081f3c_AudioURL"},"type":{"type":"string","const":"audio_url","title":"Type"}},"type":"object","required":["audio_url","type"],"title":"ChatCompletionContentPartAudioParam"},"3e081f3c_ChatCompletionContentPartVideoParam":{"properties":{"video_url":{"$ref":"#\/components\/schemas\/3e081f3c_VideoURL"},"type":{"type":"string","const":"video_url","title":"Type"}},"type":"object","required":["video_url","type"],"title":"ChatCompletionContentPartVideoParam"},"3e081f3c_CustomChatCompletionContentSimpleImageParam":{"properties":{"image_url":{"type":"string","title":"Image Url"}},"type":"object","required":["image_url"],"title":"CustomChatCompletionContentSimpleImageParam","description":"A simpler version of the param that only accepts a plain image_url.\nThis is supported by OpenAI API, although it is not documented.\n\nExample:\n{\n \"image_url\": \"https:\/\/example.com\/image.jpg\"\n}"},"3e081f3c_ChatCompletionContentPartImageEmbedsParam":{"properties":{"image_embeds":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}],"title":"Image Embeds"},"type":{"type":"string","const":"image_embeds","title":"Type"}},"type":"object","required":["image_embeds","type"],"title":"ChatCompletionContentPartImageEmbedsParam"},"3e081f3c_CustomChatCompletionContentSimpleAudioParam":{"properties":{"audio_url":{"type":"string","title":"Audio Url"}},"type":"object","required":["audio_url"],"title":"CustomChatCompletionContentSimpleAudioParam","description":"A simpler version of the param that only accepts a plain audio_url.\n\nExample:\n{\n \"audio_url\": \"https:\/\/example.com\/audio.mp3\"\n}"},"3e081f3c_CustomChatCompletionContentSimpleVideoParam":{"properties":{"video_url":{"type":"string","title":"Video Url"}},"type":"object","required":["video_url"],"title":"CustomChatCompletionContentSimpleVideoParam","description":"A simpler version of the param that only accepts a plain audio_url.\n\nExample:\n{\n \"video_url\": \"https:\/\/example.com\/video.mp4\"\n}"},"3e081f3c_FileFile":{"properties":{"file_data":{"type":"string","title":"File Data"},"file_id":{"type":"string","title":"File Id"},"filename":{"type":"string","title":"Filename"}},"type":"object","title":"FileFile"},"3e081f3c_ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"3e081f3c_JsonSchemaResponseFormat":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Schema"},"strict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Strict"}},"additionalProperties":true,"type":"object","required":["name"],"title":"JsonSchemaResponseFormat"},"3e081f3c_StructuralTag":{"properties":{"begin":{"type":"string","title":"Begin"},"schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Schema"},"end":{"type":"string","title":"End"}},"additionalProperties":true,"type":"object","required":["begin","end"],"title":"StructuralTag"},"e40582f5_Api_Country":{"description":"Country","type":"object","properties":{"id":{"format":"string","description":"ISO 3166-1 alpha-2","type":"string","example":"maria"},"alpha3":{"format":"string","description":"ISO 3166-1 alpha-3","type":"string","example":"maria"},"name":{"format":"string","type":"string","example":"maria"},"official_state_name":{"format":"string","type":"string","example":"maria"}}},"e40582f5_Api_DemoGroup":{"description":"DemoGroup","type":"object","properties":{"id":{"format":"int32","type":"number","example":42},"iDemo":{"format":"int32","description":"Liaison avec la conf de la d\u00e9mo","type":"number","example":42},"iGroupe":{"format":"string","type":"string","example":"maria"},"iService":{"format":"string","type":"string","example":"maria"},"iItem":{"format":"string","type":"string","example":"maria"},"iSubItem":{"format":"string","type":"string","example":"maria"},"bDesactived":{"format":"string","type":"string","example":"maria"},"bIgnoreUse":{"format":"string","type":"string","example":"maria"},"dCreated":{"format":"string","description":"Date de cr\u00e9ation de la d\u00e9mo","type":"string","example":"maria"},"dValidite":{"format":"string","description":"Date de but\u00e9e de validit\u00e9. A cette date on d\u00e9sactive l'item puis X jours apr\u00e8s on le r\u00e9silie","type":"string","example":"maria"},"dResilied":{"format":"string","description":"Date ou la d\u00e9sactivation d'une d\u00e9mo est intervenue.","type":"string","example":"maria"},"dLimited":{"format":"string","description":"Date ou la limitation d'une d\u00e9mo est intervenue.","type":"string","example":"maria"},"dConverted":{"format":"string","description":"Date ou la d\u00e9mo a \u00e9t\u00e9 convertie en produit classique.","type":"string","example":"maria"},"iMailSent":{"format":"int32","description":"Liste de flag pour les mails d\u00e9j\u00e0 envoy\u00e9","type":"number","example":42},"account":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Account"}}}},"e40582f5_ip":{"type":"string","example":"127.0.0.1","properties":null},"e40582f5_Api_Language":{"description":"Language","type":"object","properties":{"id":{"format":"string","description":"ISO 639-1","type":"string","example":"maria"},"name":{"format":"string","type":"string","example":"maria"},"endonym":{"format":"string","type":"string","example":"maria"}}},"e40582f5_Api_Logo":{"description":"Logo","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"uuid":{"format":"string","type":"string","example":"maria"},"channel_id":{"format":"int32","type":"number","example":42},"mode":{"description":"","type":"string","items":{"type":"string"},"enum":["OVERLAY","EMBED"],"example":"OVERLAY","format":"string"},"position":{"description":"","type":"string","items":{"type":"string"},"enum":["TOP_LEFT","TOP_MIDDLE","TOP_RIGHT","CENTER_LEFT","CENTER_MIDDLE","CENTER_RIGHT","BOTTOM_LEFT","BOTTOM_MIDDLE","BOTTOM_RIGHT"],"example":"TOP_LEFT","format":"string"},"margin":{"format":"int32","type":"number","example":42},"size":{"format":"int32","description":"Integer value 1-100","type":"number","example":42},"data":{"format":"string","type":"string","example":"maria"},"width":{"format":"int32","type":"number","example":42},"height":{"format":"int32","type":"number","example":42},"mimetype":{"format":"string","type":"string","example":"maria"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"channel":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Channel"}},"medias":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Media"}},"overlayLogos":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_OverlayLogo"}},"uuidSequence":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_UuidSequence","type":"object"}}},"e40582f5_Api_Product":{"description":"Product","type":"object","properties":{"id":{"format":"int32","type":"number","example":42},"auto_empty_trash":{"format":"string","type":"string","example":"maria"},"channel_name":{"format":"string","type":"string","example":"maria"},"channel_description":{"format":"string","type":"string","example":"maria"},"player":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Player"},"statistic_ignored_ip":{"type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_ip"}},"ftp_prefix":{"format":"string","type":"string","example":"maria"},"pack":{"format":"string","type":"string"},"medias_count":{"format":"int32","type":"integer","example":42},"medias_uploaded":{"format":"int32","type":"number","example":42},"medias_uploaded_last_hour":{"format":"int32","type":"number","example":42},"parameters":{"description":"","type":"array","items":{"type":"string"}},"rights":{"description":"","type":"array","items":{"type":"string"}},"bill_reference":{"format":"string","type":"string","example":"maria"},"available_quota":{"format":"float","type":"string"},"legacy_product_id":{"format":"int32","type":"number","example":42},"suspended_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"created_at":{"format":"datetime","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"customer_name":{"format":"string","type":"string","example":"maria"},"expired_at":{"format":"datetime","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"internal_name":{"format":"string","type":"string","example":"maria"},"service_id":{"format":"int32","type":"number","example":42},"slug":{"format":"string","type":"string","example":"maria"},"special":{"format":"string","type":"bool","enum":[true,false],"example":true},"version":{"format":"int32","type":"number","example":42},"tags":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Tag"}},"deleted_at":{"type":"datetime","example":"2021-09-15T14:23:41+00:00"}}},"e40582f5_Api_Tag":{"description":"Tag","type":"object","properties":{"id":{"format":"int32","type":"number","example":42},"name":{"format":"string","type":"string","example":"maria"},"color":{"format":"int32","type":"number","example":42},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"}}},"e40582f5_Api_User":{"description":"User","type":"object","properties":{"iGlobalUserCode":{"format":"string","type":"string","example":"maria"},"sLogin":{"format":"string","type":"string","example":"maria"},"sEmail":{"format":"string","type":"string","example":"maria"},"sFirstname":{"format":"string","type":"string","example":"maria"},"sLastname":{"format":"string","type":"string","example":"maria"},"sPassword":{"format":"string","type":"string","example":"maria"},"sCryptKey":{"format":"string","type":"string","example":"maria"},"iStatus":{"format":"string","type":"string","example":"maria"},"dValidationDate":{"format":"datetime","description":"Date \u00e0 laquelle le compte utilisateur a \u00e9t\u00e9 valid\u00e9 (par lui m\u00eame suite \u00e0 invitation par exemple)","type":"string","example":"2021-02-23T19:15:00+00:00"},"bInfomaniak":{"format":"int32","description":"Flag pour indiquer si staff Infomaniak","type":"number","example":42},"setStaffDepartement":{"format":"string","type":"string","example":"maria"},"dDeleted":{"format":"datetime","type":"string","example":"2021-02-23T19:15:00+00:00"},"sOTPAuthSecret":{"format":"string","type":"string","example":"maria"},"sHashPassword":{"format":"string","type":"string","example":"maria"},"setDeletedAction":{"format":"string","type":"string","example":"maria"},"bOTPAuth":{"format":"string","type":"string","example":"maria"},"dLastLogin":{"format":"datetime","type":"string","example":"2021-02-23T19:15:00+00:00"},"dLastLoginAdmin":{"format":"datetime","type":"string","example":"2021-02-23T19:15:00+00:00"},"setCreatedAction":{"format":"string","type":"string","example":"maria"},"bInvalidEmail":{"format":"string","type":"string","example":"maria"},"sOTPAuthPendingSecret":{"format":"string","type":"string","example":"maria"},"sAvatarUrl":{"format":"string","type":"string","example":"maria"},"dCreation":{"format":"string","type":"string","example":"maria"},"dSecurityAssistant":{"format":"string","type":"string","example":"maria"},"bSMSAuth":{"format":"string","type":"string","example":"maria"},"sSMSPhone":{"format":"string","type":"string","example":"maria"},"dResetPassword":{"format":"string","type":"string","example":"maria"},"bYubikeyAuth":{"format":"string","type":"string","example":"maria"},"sYubikeyId":{"format":"string","type":"string","example":"maria"},"bDoubleAuth":{"format":"string","type":"string","example":"maria"},"sDoubleAuthMethod":{"format":"string","type":"string","example":"maria"},"bApplicationAuth":{"format":"string","type":"string","example":"maria"},"sPasswordStatus":{"format":"string","type":"string","example":"maria"},"dDatePasswordStatusChanged":{"format":"string","type":"string","example":"maria"},"accessGrants":{"description":"","type":"array","items":{"type":"AccessGrant"}},"accessTokens":{"description":"","type":"array","items":{"type":"AccessToken"}},"accounts":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Account"}},"addresses":{"description":"","type":"array","items":{"type":"Address"}},"answer":{"format":"string","type":"SecretAnswer"},"applications":{"description":"","type":"array","items":{"type":"Application"}},"authDevices":{"description":"","type":"array","items":{"type":"UserAuthDevice"}},"contactAddresses":{"description":"","type":"array","items":{"type":"Address"}},"emails":{"description":"","type":"array","items":{"type":"Email"}},"admin_last_used_at":{"format":"datetime","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"avatar_url":{"format":"string","type":""},"b_invalid_email":{"format":"string","type":""},"created_action":{"format":"string","type":""},"created_at":{"format":"datetime","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"current_account":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_Account","type":"object"},"d_security_assistant":{"format":"string","type":""},"deleted_by_id":{"format":"int32","type":"number","example":42},"deleted_by_ip":{"type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_ip"}},"email":{"format":"string","type":""},"firstname":{"format":"string","type":""},"id":{"format":"string","type":""},"invalid_email":{"format":"string","type":""},"last_used_at":{"format":"datetime","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"lastname":{"format":"string","type":""},"login":{"format":"string","type":""},"name":{"format":"string","type":""},"otp_enabled":{"format":"string","type":""},"otpauth_secret":{"format":"string","type":""},"phone":{"format":"string","type":""},"remember_token":{"format":"string","type":""},"staff":{"format":"string","type":""},"status":{"format":"string","type":""},"validated_at":{"format":"datetime","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"mailboxes":{"description":"","type":"array","items":{"type":"Mailbox"}},"oldPasswords":{"description":"","type":"array","items":{"type":"OldPassword"}},"phones":{"description":"","type":"array","items":{"type":"Phone"}},"preference":{"format":"string","type":"Preference"},"rememberTokens":{"description":"","type":"array","items":{"type":"RememberToken"}},"rescueCodes":{"description":"","type":"array","items":{"type":"RescueCode"}},"rights":{"description":"","type":"array","items":{"type":"Right"}},"roles":{"description":"","type":"array","items":{"type":"Role"}},"serviceRights":{"description":"","type":"array","items":{"type":"ServiceRight"}},"password":{"format":"string"},"s_email":{"format":"string"},"s_remember_token":{"format":"string"},"teams":{"description":"","type":"array","items":{"type":"Team"}},"userPasswords":{"description":"","type":"array","items":{"type":"UserPassword"}},"validateEmailTokens":{"description":"","type":"array","items":{"type":"ValidateEmailToken"}}}},"e40582f5_Api_AlertHitLog":{"description":"AlertHitLog","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"datetime":{"format":"string","type":"string","example":"maria"},"state":{"format":"string","type":"string","example":"maria"},"result":{"format":"string","example":true,"type":"bool","enum":[true,false]},"response":{"format":"string","type":"string","example":"maria"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"}}},"e40582f5_Api_Preview":{"description":"Preview","type":"object","properties":{"audio":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"},"audio_raw":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"},"video":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"}}},"e40582f5_Api_Sample":{"description":"Sample","type":"object","properties":{"audio":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"},"video":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"}}},"e40582f5_Api_Link":{"description":"Link","type":"object","properties":{"url":{"format":"string","type":"string","example":"https:\/\/infomaniak.com"},"mimetype":{"format":"string","type":"string","example":"maria"},"size":{"format":"int32","type":"number","example":42},"size_human_readable":{"format":"string","type":"string","example":"maria"}}},"e40582f5_Api_MediaJournalLog":{"description":"MediaJournalLog","type":"object","properties":{"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"media":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Media"}}}},"e40582f5_Api_Channel":{"description":"Channel","type":"object","properties":{"id":{"format":"string","type":"string","example":"maria"},"name":{"format":"string","type":"string","example":"maria"},"description":{"format":"string","type":"string","example":"maria"},"statistic_ignored_ip":{"type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_ip"}},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"auto_empty_trash":{"format":"string","type":"string","example":"maria"},"journal":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_MediaJournalLog"}}}},"e40582f5_Api_DataUrl":{"type":"object","description":"dataUrl","properties":{"data":{"type":"string","example":"b64encodedData"},"mimetype":{"type":"string","example":"image\/png"},"encoding":{"type":"string","example":"encoding"}}},"e40582f5_Api_Account":{"description":"Account","type":"object","properties":{"iCodeGroupes":{"format":"string","type":"string","example":"maria"},"sGroupesNom":{"format":"string","type":"string","example":"maria"},"eTypeGroup":{"format":"string","type":"string","example":"maria"},"sTVA":{"format":"string","description":"Num\u00e9ro de TVA","type":"string","example":"maria"},"sPhone":{"format":"string","type":"string","example":"maria"},"sFax":{"format":"string","type":"string","example":"maria"},"sWebsite":{"format":"string","type":"string","example":"maria"},"bPartner":{"format":"string","type":"string","example":"maria"},"bContreAffaireAllowed":{"format":"string","type":"string","example":"maria"},"bExportGIT":{"format":"int32","description":"Exporter les factures et paiements vers GIT","type":"number","example":42},"bAlwaysOn":{"format":"int32","type":"number","example":42},"bDisableServiceOnUnpaid":{"format":"string","type":"string","example":"maria"},"bUseRenouvellement":{"format":"string","type":"string","example":"maria"},"bBetaTesteur":{"format":"string","type":"string","example":"maria"},"bExonerationTVA":{"format":"string","type":"string","example":"maria"},"fExonerationTVALimitTTC":{"format":"string","type":"string","example":"maria"},"iCountryCode":{"format":"int32","description":"Code pays PAR DEFAUT des nouveaux users","type":"number","example":42},"iLanguageCode":{"format":"int32","description":"Code langue par d\u00e9faut du group","type":"number","example":42},"iTimezoneCode":{"format":"int32","description":"timezone par d\u00e9faut du groupe","type":"number","example":42},"iDefautEcheanceFacture":{"format":"int32","description":"Ech\u00e9ance par d\u00e9faut pour les factures du groupe en nombre de jours","type":"number","example":42},"bUniqueReference":{"format":"string","type":"string","example":"maria"},"bPerte":{"format":"int32","description":"Poss\u00e8de au moins un fact. pass\u00e9e en perte","type":"number","example":42},"dDateCreation":{"format":"string","type":"string","example":"maria"},"bDeleted":{"format":"string","type":"string","example":"maria"},"dDeletedDate":{"format":"datetime","type":"string","example":"2021-02-23T19:15:00+00:00"},"sIPCreation":{"format":"string","type":"string","example":"maria"},"iBannerCampagne":{"format":"int32","description":"stocker si groupe a \u00e9t\u00e9 cr\u00e9\u00e9 apr\u00e8s click sur banni\u00e8re campagne","type":"number","example":42},"idAffiliation":{"format":"string","type":"string","example":"maria"},"iStatutDoublon":{"format":"int32","description":"Etat du traitement si compte en doublon","type":"number","example":42},"dDoublon":{"format":"string","description":"Date \u00e0 laquelle le statut a \u00e9t\u00e9 chang\u00e9","type":"string","example":"maria"},"sUniqueReference":{"format":"string","description":"R\u00e9f\u00e9rence unique du groupe que le client doit renseigner lors d'un paiement par IBAN","type":"string","example":"maria"},"CGUs":{"description":"","type":"array","items":{"type":"CGUAgreement"}},"addresses":{"description":"","type":"array","items":{"type":"Address"}},"billingAddresses":{"description":"","type":"array","items":{"type":"Address"}},"country":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Country"}},"customizationUrl":{"format":"string","type":"AccountCustomizationUrl"},"demoGroups":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_DemoGroup"}},"beta":{"format":"string","type":""},"country_id":{"format":"string","type":""},"created_at":{"format":"datetime","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_by_id":{"format":"int32","type":"number","example":42},"deleted_by_ip":{"type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_ip"}},"fax":{"format":"string","type":""},"id":{"format":"string","type":""},"language_id":{"format":"string","type":""},"legal_entity_type":{"format":"string","type":""},"name":{"format":"string","type":""},"partner":{"format":"string","type":""},"phone":{"format":"string","type":""},"s_phone":{"format":"string","type":""},"timezone_id":{"format":"string","type":""},"tva":{"format":"string","type":""},"type":{"format":"string","type":""},"website":{"format":"string","type":""},"invitations":{"description":"","type":"array","items":{"type":"AccountInvitation"}},"invoices":{"description":"","type":"array","items":{"type":"Invoice"}},"language":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Language"}},"logo":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_Logo","type":"object"},"logs":{"description":"","type":"array","items":{"type":"Log"}},"premiumSupport":{"description":"","type":"array","items":{"type":"PremiumSupport"}},"products":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Product"}},"roles":{"description":"","type":"array","items":{"type":"Role"}},"services":{"description":"","type":"array","items":{"type":"Service"}},"tags":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Tag"}},"teams":{"description":"","type":"array","items":{"type":"Team"}},"timezone":{"description":"","type":"array","items":{"type":"Timezone"}},"users":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_User"}}}},"e40582f5_Api_Media":{"description":"Media","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"name":{"format":"string","type":""},"description":{"format":"string","type":"string","example":"maria"},"validated":{"format":"string","example":true,"type":"bool","enum":[true,false]},"published":{"format":"string","example":true,"type":"bool","enum":[true,false]},"streams":{"type":"array","enum":["audio","video"],"example":"[audio, video]"},"shot_boundaries":{"type":"array","example":"[1, 2,10]"},"duration":{"type":"seconds","description":"duration in seconds","example":"276.62"},"collected_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"published_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"discarded_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"manifests":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_media_manifests"},"source":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"},"state":{"type":"number","example":192},"preview":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Preview"},"sample":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Sample"},"thumbnail":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"},"poster":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"},"encodings":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Encoding"}},"progress":{"type":"number","description":"%","example":50},"playbacks":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_media_playbacks"},"annotations":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Annotation"}},"category":{"type":"string","example":"moto"},"chapters":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Chapter"}},"folder":{"type":"string","example":"1jhvl2uqa5v8a"},"country_restricted":{"format":"string","type":""},"ip_restricted":{"format":"string","type":""},"key_restricted":{"format":"string","type":""},"path":{"format":"string","type":""},"journal":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_MediaJournalLog"}},"language":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Language"}},"logos":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Logo"}},"scenes":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_Thumbnail","type":"object"},"shares":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Share"}},"subtitles":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Subtitle"}},"tags":{"type":"array"},"thumbstrip":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_Thumbnail","type":"object"},"upload":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_Upload","type":"object"}},"name":{"example":"nom du media"}},"e40582f5_Api_EncodingPreset":{"description":"EncodingPreset","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"name":{"format":"string","type":"string","example":"maria"},"type":{"description":"","type":"string","items":{"type":"string"},"enum":["PLAYBACK","STORAGE"],"example":"PLAYBACK","format":"string"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"template":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_encoding_preset_template"}}},"e40582f5_Api_EncodingStream":{"description":"EncodingStream","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"video_bitrate":{"format":"int32","description":"In bps","type":"number","example":42},"video_width":{"format":"int32","type":"number","example":42},"video_height":{"format":"int32","type":"number","example":42},"audio_bitrate":{"format":"int32","description":"In bps","type":"number","example":42},"audio_sampling":{"format":"int32","description":"In Hz","type":"number","example":42},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"encoding":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Encoding"}}}},"e40582f5_encoding_preset_template":{"description":"encoding preset","type":"object","properties":{"container":{"type":"number","example":2},"audio_codec":{"type":"number","example":1},"audio_channel":{"type":"number","example":2},"streams":{"type":"array","items":{"type":"object","properties":{"audio_bitrate":{"type":"number","example":64000},"audio_sampling":{"type":"number","example":48000}}}}}},"e40582f5_Api_Encoding":{"description":"Encoding","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"container":{"description":"","type":"string","items":{"type":"string"},"enum":["FLV","M4A","MKV","MP4","WEBM","MP3","COPY","AAC"],"example":"FLV","format":"string"},"name":{"format":"string","type":"string","example":"maria"},"copy":{"format":"string","example":true,"type":"bool","enum":[true,false]},"video_codec":{"description":"","type":"string","items":{"type":"string"},"enum":["H264","HEVC","THEORA","VP8","VP9","COPY","H263"],"example":"H264","format":"string"},"video_aspect":{"description":"","type":"string","items":{"type":"string"},"enum":["LETTERBOX","STRETCH","FILL","KEEP_RATIO","COPY"],"example":"LETTERBOX","format":"string"},"video_fps":{"format":"float","type":"string"},"audio_codec":{"description":"","type":"string","items":{"type":"string"},"enum":["AAC","HE_AAC","FLAC","MP3","VORBIS","COPY","OPUS"],"example":"AAC","format":"string"},"audio_channel":{"description":"","type":"string","items":{"type":"string"},"enum":["MONO_1_0","STEREO_2_0","STEREO_2_1","SURROUND_4_1","SURROUND_5_1","SURROUND_6_1","SURROUND_7_1"],"example":"MONO_1_0","format":"string"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"owned":{"format":"string","type":"bool","enum":[true,false],"example":true},"preset":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_EncodingPreset"}},"streams":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_EncodingStream"}}}},"e40582f5_Api_Player":{"description":"Player","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"default":{"format":"string","type":"bool","enum":[true,false],"example":true},"name":{"format":"string","type":"string","example":"maria"},"description":{"format":"string","type":"string","example":"maria"},"show_controls":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_progression":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_audio":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_duration":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_fullscreen":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_default_logo":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_speed":{"format":"string","type":"bool","enum":[true,false],"example":true},"default_speed":{"format":"float","type":"number","example":1},"is360":{"format":"int32","type":"number","example":42},"encoding_change_enabled":{"format":"int32","type":"number","example":42},"encoding_limit":{"format":"int32","type":"number","example":42},"chromecast":{"format":"string","type":"bool","enum":[true,false],"example":true},"force_media_ratio":{"format":"string","type":"bool","enum":[true,false],"example":true},"auto_start":{"format":"string","type":"bool","enum":[true,false],"example":true},"audio_volume":{"format":"int32","type":"number","example":42},"show_replay":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_loop":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_related":{"format":"int32","type":"number","example":42},"play_related":{"format":"int32","type":"number","example":42},"related_type":{"description":"","type":"string","items":{"type":"string"},"enum":["SIMILAR_TAGS","LAST_UPLOADED","SAME_FOLDER","MOST_VIEWED"],"example":"SIMILAR_TAGS","format":"string"},"width":{"format":"int32","type":"number","example":42},"height":{"format":"int32","type":"number","example":42},"controlbar_color":{"$ref":"#\/components\/schemas\/e40582f5_color","type":"object"},"control_color":{"$ref":"#\/components\/schemas\/e40582f5_color","type":"object"},"control_active_color":{"$ref":"#\/components\/schemas\/e40582f5_color","type":"object"},"logo_image":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_DataUrl"},"logo_anchor":{"description":"","type":"string","items":{"type":"string"},"enum":["TOP_LEFT","TOP_RIGHT","BOTTOM_LEFT","BOTTOM_RIGHT","CENTER"],"example":"TOP_LEFT","format":"string"},"logo_margin_vertical":{"format":"int32","type":"number","example":42},"logo_margin_horizontal":{"format":"int32","type":"number","example":42},"logo_percentage":{"format":"int32","type":"number","example":42},"show_media_info":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_media_thumbnail":{"format":"string","type":"bool","enum":[true,false],"example":true},"media_thumbnail_anchor":{"description":"","type":"string","items":{"type":"string"},"enum":["TOP","LEFT"],"example":"TOP","format":"string"},"auto_hide_controls":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_viewers":{"format":"string","type":"bool","enum":[true,false],"example":true},"show_viewers_after":{"format":"int32","type":"number","example":42},"show_viewers_only_after":{"format":"string","type":"bool","enum":[true,false],"example":true},"time_before_hide_cb":{"format":"int32","type":"number","example":42},"enable_facebook":{"format":"string","type":"bool","enum":[true,false],"example":true},"facebook_back_link":{"format":"string","type":"string","example":"maria"},"facebook_player_embed":{"format":"string","type":"bool","enum":[true,false],"example":true},"enable_twitter":{"format":"string","type":"bool","enum":[true,false],"example":true},"twitter_via":{"format":"string","type":"string","example":"maria"},"twitter_back_link":{"format":"string","type":"string","example":"maria"},"twitter_related":{"format":"string","type":"string"},"enable_embed_code":{"format":"string","type":"bool","enum":[true,false],"example":true},"preload_image":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_DataUrl"},"interrupt_image":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_DataUrl"},"geoip_image":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_DataUrl"},"restrict_image":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_DataUrl"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"is_channel_default":{"format":"string","type":"bool","enum":[true,false],"example":true},"ads":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Ad"}},"owned":{"type":"bool","example":true},"shares":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Share"}}}},"e40582f5_Api_OverlayLogo":{"description":"OverlayLogo","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"uuid":{"format":"string","type":"string","example":"maria"},"media_id":{"format":"int32","type":"number","example":42},"logo_id":{"format":"int32","type":"number","example":42},"index":{"format":"int32","type":"number","example":42},"progress":{"format":"float","type":"string"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"activities":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_MediaActivity"}},"link":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_Link","type":"object"},"logo":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Logo"}},"media":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Media"}},"uuidSequence":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_UuidSequence","type":"object"}}},"e40582f5_Api_UuidSequence":{"description":"UuidSequence","type":"object","properties":{"uuid":{"format":"string","type":"string","example":"maria"},"model_type":{"format":"string","type":"string","example":"maria"},"model_id":{"format":"int32","type":"number","example":42},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"model":{"$ref":"#\/components\/schemas\/e40582f5_Api_UuidSequence","type":"object"},"uuidSequence":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_UuidSequence","type":"object"},"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"}}},"e40582f5_media_manifests":{"description":"manifest","type":"object","properties":{"json":{"type":"object","properties":{"url":{"type":"string","example":"https:\/\/api.vod2.infomaniak.com\/res\/media\/1jhvl2uqa5v8a.json"},"mimetype":{"type":"string","example":"application\/json"},"data":{"type":"object","properties":{"format":{"type":"string","example":"JSON"}}}}},"xml":{"type":"object","properties":{"url":{"type":"string","example":"https:\/\/api.vod2.infomaniak.com\/res\/media\/1jhvl2uqa5v8a.xml"},"mimetype":{"type":"string","example":"application\/xml"},"data":{"type":"object","properties":{"format":{"type":"string","example":"XML"}}}}},"v1xml":{"type":"object","properties":{"url":{"type":"string","example":"https:\/\/api.vod2.infomaniak.com\/res\/media\/1jhvl2uqa5v8a.v1xml"},"mimetype":{"type":"string","example":"application\/xml"},"data":{"type":"object","properties":{"format":{"type":"string","example":"XML (v1 compatibility)"}}}}},"yaml":{"type":"object","properties":{"url":{"type":"string","example":"https:\/\/api.vod2.infomaniak.com\/res\/media\/1jhvl2uqa5v8a.yaml"},"mimetype":{"type":"string","example":"text\/yaml"},"data":{"type":"object","properties":{"format":{"type":"string","example":"YAML"}}}}},"yml":{"type":"object","properties":{"url":{"type":"string","example":"https:\/\/api.vod2.infomaniak.com\/res\/media\/1jhvl2uqa5v8a.yml"},"mimetype":{"type":"string","example":"text\/yaml"}," data":{"type":"object","properties":{"format":{"type":"string","example":"YAML"}}}}}}},"e40582f5_media_playbacks":{"description":"playbacks","type":"object","properties":{"encodingId":{"type":"object","properties":{"strategy":{"type":"object","properties":{"url":{"type":"string","example":"https:\/\/api.vod2.infomaniak.com\/res\/media\/1jhvl2uqa5v8a.yml"},"mimetype":{"type":"string","example":"video\/mp4"}," data":{"type":"object","properties":{"encoding":{"type":"string","example":"Copy source"},"strategy":{"type":"string","example":"Progressive download (Best available)"},"key":{"type":"string","example":"null"}}}}}}}}},"e40582f5_Api_Annotation":{"description":"Annotation","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"body":{"format":"string","type":"string","example":"maria"},"published":{"format":"string","example":true,"type":"bool","enum":[true,false]},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"from":{"format":"float","type":"string"},"to":{"format":"float","type":"string"}}},"e40582f5_Api_Chapter":{"description":"Chapter","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"timestamp":{"format":"float","type":"string"},"name":{"format":"string","type":"string","example":"maria"},"description":{"format":"string","type":"string","example":"maria"},"published":{"format":"string","type":"bool","enum":[true,false],"example":true},"image":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_DataUrl"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"index":{"format":"int32","type":"number","example":42}}},"e40582f5_Api_Thumbnail":{"description":"Thumbnail","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"link":{"$ref":"#\/components\/schemas\/e40582f5_Api_Link","type":"object"}}},"e40582f5_Api_Share":{"description":"Share","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"target_type":{"format":"string","type":"string","example":"maria"},"target_id":{"format":"string","type":"string","example":"maria"},"comment":{"format":"string","type":"string","example":"maria"},"timestamp":{"format":"string","type":"string","example":"maria"},"validity":{"format":"int32","description":"In seconds","type":"number","example":42},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"links":{"description":"","type":"array","items":{"type":"string"}},"player":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Player"},"manifests":{"format":"string","type":"string","example":"maria"},"target":{"$ref":"#\/components\/schemas\/e40582f5_Api_Share","type":"object"},"encoding":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Encoding"}},"valid_until":{"format":"string","type":"Carbon"}}},"e40582f5_Api_Subtitle":{"description":"Subtitle","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"lines":{"format":"string","type":"string"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"name":{"format":"string","type":"string","example":"maria"},"published":{"format":"string","type":"bool","enum":[true,false],"example":true},"default":{"format":"string","type":"bool","enum":[true,false],"example":true},"link":{"description":"","type":"array","items":{"type":"string"}},"language":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Language"}}}},"e40582f5_Api_Upload":{"description":"Upload","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"index":{"type":"number","example":0},"progress":{"type":"number","example":50,"description":"percentage"},"url":{"example":"https:\/\/infomaniak.ch\/url.mp4"},"ready_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"meta":{"format":"string","description":"","$ref":"#\/components\/schemas\/e40582f5_Api_UploadMeta","type":"object"}}},"e40582f5_Api_MediaActivity":{"description":"MediaActivity","type":"object","properties":{"cause":{"description":"","type":"string","items":{"type":"string"},"enum":["ELOQUENT_CREATED","ELOQUENT_RESTORED","ELOQUENT_REMOVED","ELOQUENT_UNREMOVED","ELOQUENT_DELETED","UPLOAD_INITIALIZING","UPLOAD_PULLING","UPLOAD_PULLED","UPLOAD_PUSHING","UPLOAD_PUSHED","UPLOAD_FAILED","AUDIO_SAMPLE_GENERATED","AUDIO_SAMPLE_GENERATING","AUDIO_WAVEFORM_GENERATED","AUDIO_WAVEFORM_GENERATING","SCENES_GENERATED","SCENES_GENERATING","THUMBNAIL_GENERATION_FAILED","THUMBSTRIP_GENERATED","THUMBSTRIP_GENERATING","VIDEO_PREVIEW_GENERATED","VIDEO_PREVIEW_GENERATING","VIDEO_SAMPLE_GENERATED","VIDEO_SAMPLE_GENERATING","VIDEO_THUMBNAIL_GENERATED","VIDEO_THUMBNAIL_GENERATING","ENCODING","VIDEO_POSTER_GENERATED","VIDEO_POSTER_GENERATING","FILE_STORING","FILE_STORED","ENCODING_QUEUED","ENCODING_STARTED","ENCODING_FINISHED","ENCODING_FAILED"],"example":"ELOQUENT_CREATED","format":"string"},"message":{"format":"string","type":"string","example":"maria"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"context":{"format":"string","type":"string","example":"maria"},"actor":{"$ref":"#\/components\/schemas\/e40582f5_Api_MediaActivity","type":"object"},"media":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Media"}}}},"e40582f5_color":{"type":"string","example":"#FF0077","properties":null},"e40582f5_Api_Ad":{"description":"Ad","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"url":{"format":"string","type":"string","example":"https:\/\/infomaniak.com"},"mimetype":{"format":"string","type":"string","example":"maria"},"href":{"format":"string","type":"string","example":"maria"},"type":{"description":"","type":"string","items":{"type":"string"},"enum":["PRE_ROLL","MID_ROLL","PST_ROLL"],"example":"PRE_ROLL","format":"string"},"offset":{"format":"string","type":"string","example":"maria"},"tracking_id":{"format":"string","type":"string","example":"maria"}}},"e40582f5_Api_PlaylistItem":{"description":"PlaylistItem","type":"object","properties":{"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"},"position":{"format":"int32","type":"number","example":42},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"type":{"format":"string","type":"string","example":"maria"},"model":{"$ref":"#\/components\/schemas\/e40582f5_Api_PlaylistItem","type":"object"}}},"e40582f5_Api_UploadMeta":{"description":"UploadMeta","type":"object","properties":{"nb_streams":{"format":"int32","type":"number","example":42},"nb_programs":{"format":"int32","type":"number","example":42},"format_name":{"format":"string","type":"string","example":"maria"},"format_long_name":{"format":"string","type":"string","example":"maria"},"start_time":{"format":"string","type":"timestamp","example":"maria"},"duration":{"format":"string","type":"string","example":"maria"},"size":{"format":"int32","type":"number","example":42},"bit_rate":{"format":"int32","description":"In bps","type":"number","example":42},"probe_score":{"format":"int32","type":"number","example":42},"tags":{"format":"string","type":"string"},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"display_aspect_ratio":{"format":"string","type":""},"display_aspect_ratio_source":{"format":"string","type":""},"height":{"format":"string","type":""},"sample_aspect_ratio":{"format":"string","type":""},"sample_aspect_ratio_source":{"format":"string","type":""},"width":{"format":"string","type":""}}},"e40582f5_Download_Link":{"description":"Link","type":"object","properties":{"url":{"format":"string","type":"string","example":"https:\/\/infomaniak.com"},"mimetype":{"format":"string","type":"string","example":"maria"},"size":{"format":"int32","type":"number","example":42},"size_human_readable":{"format":"string","type":"string","example":"maria"}}},"e40582f5_Api_BrowsableVirtualFile":{"description":"BrowsableVirtualFile","type":"object","properties":{"name":{"format":"string","type":""},"description":{"format":"string","type":"string","example":"maria"},"validated":{"format":"string","type":"bool","enum":[true,false],"example":true},"published":{"format":"string","type":"bool","enum":[true,false],"example":true},"streams":{"type":"array","enum":["audio","video"],"example":"[audio, video]"},"duration":{"type":"seconds","description":"duration in seconds","example":"276.62"},"size":{"type":"number","example":2300000},"created_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"updated_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"deleted_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"discarded_at":{"format":"string","example":"2021-09-15T14:23:41+00:00","type":"datetime"},"folders_count":{"format":"int32","type":"integer","example":42},"files_count":{"format":"int32","type":"integer","example":42},"path":{"format":"string","type":"","example":"\/foldera\/folderb\/file"},"preview":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Preview"},"sample":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Sample"},"thumbnail":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_Api_Link"},"state":{"format":"int32","type":"number","example":42},"progress":{"type":"number","description":"%","example":50},"playlists_attached_count":{"type":"number","example":2},"tags":{"type":"array"},"type":{"format":"string","type":"string","example":"maria"},"id":{"format":"uuid","type":"string","example":"1jhvl2uqa5v8a"}}},"e40582f5_shortFolder":{"description":"folder","type":"object","properties":{"id":{"type":"string","example":"1jhvl2uqae5sa"},"name":{"type":"string","example":"foldername"},"description":{"type":"string","example":"folder description"},"validated":{"type":"bool","example":true},"published":{"type":"bool","example":true},"auto_validate":{"type":"bool","example":true},"auto_publish":{"type":"bool","example":true},"restricted":{"type":"bool","example":false},"key":{"type":"string"},"allowed_ip":{"type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_ip"}},"disallowed_ip":{"type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_ip"}},"allowed_country":{"type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Country"}},"disallowed_country":{"type":"array","items":{"$ref":"#\/components\/schemas\/e40582f5_Api_Country"}},"discarded":{"type":"string"},"created_at":{"type":"datetime","example":"2022-01-18T08:59:20+00:00"},"updated_at":{"type":"datetime","example":"2022-01-18T08:59:20+00:00"},"discarded_at":{"type":"datetime","example":"2022-01-18T08:59:20+00:00"},"deleted_at":{"type":"datetime","example":"2022-01-18T08:59:20+00:00"},"image":{"type":"string"},"media_count":{"type":"int","example":2},"media_duration":{"type":"float","example":12.16}}},"e40582f5_shortUpload":{"description":"upload","type":"object","properties":{"id":{"type":"string","example":"1jhvl2uqae5sa"},"index":{"type":"int","example":0},"progress":{"type":"int","example":50},"url":{"type":"string","example":"https:\/\/infomaniak.ch\/url.mp4"},"created_at":{"type":"datetime","example":"2022-01-18T08:59:20+00:00"},"ready_at":{"type":"datetime","example":"2022-01-18T08:59:20+00:00"}}},"e40582f5_shortMedia":{"description":"Media","type":"object","properties":{"id":{"type":"string","example":"1jhvl2uqae5sa"},"name":{"type":"string","example":"video name"},"description":{"type":"string","example":"video description"},"validated":{"type":"bool","example":true},"published":{"type":"bool","example":true},"streams":{"type":"array","example":"[audio,video]"},"shot_boundaries":{"type":"array","example":"[]"},"key_restricted":{"type":"bool","example":false},"ip_restricted":{"type":"bool","example":false},"country_restricted":{"type":"bool","example":false},"state":{"type":"int","example":4},"created_at":{"type":"datetime","example":"2022-01-18T08:59:20+00:00"},"updated_at":{"type":"datetime","example":"2022-01-18T08:59:20+00:00"},"folder":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_shortFolder"},"upload":{"type":"object","$ref":"#\/components\/schemas\/e40582f5_shortUpload"}}},"506dc7b6_Tag":{"title":"Tag","required":["color","id","name"],"type":"object","properties":{"id":{"title":"id","type":"integer","description":"The unique identifier of the Tag","example":1234},"name":{"title":"name","type":"string","description":"The name of the Tag","example":"My tag name"},"color":{"title":"color","type":"integer","example":4},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource Tag","example":2}}},"506dc7b6_ProductUser":{"title":"ProductUser","required":["rights","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer","description":"The identifier of the `user` resource related to ProductUser","example":1},"rights":{"title":"rights","type":"string"}}},"506dc7b6_ProductAdminUser":{"title":"ProductAdminUser","required":["display_name","email","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer","description":"The identifier of the `user` resource related to ProductAdminUser","example":1},"email":{"title":"email","type":"string","description":"Email"},"display_name":{"title":"display_name","type":"string","description":"Display name"}}},"506dc7b6_Relation":{"title":"Relation","required":["id"],"type":"object","properties":{"id":{"title":"id","type":"string","description":"The unique identifier of the Relation","example":"1jhvl2upzafkt"},"name":{"title":"name","type":"string","description":"The name of the Relation","example":"my product"},"created_at":{"title":"created_at","type":"integer","description":"The date and time when the Relation was created","format":"datetime","example":2022}}},"506dc7b6_Channelparameters":{"title":"Channel parameters","type":"object","properties":{"quota":{"title":"quota","type":"integer","description":"The allocated storage quota in bytes for the Channel parameters","example":1000000000000},"invoice_periodicity":{"title":"invoice_periodicity","type":"integer","description":"The frequency at which invoices are generated, such as monthly or annually","example":12},"max_audio_bitrate":{"title":"max_audio_bitrate","type":"integer","description":"The maximum allowed audio bitrate allowed for the Channel parameters"},"max_video_bitrate":{"title":"max_video_bitrate","type":"integer","description":"The maximum allowed video bitrate allowed for the Channel parameters"},"max_imports":{"title":"max_imports","type":"integer","description":"The maximum number of imports allowed for the Channel parameters","example":5},"debug_encode":{"title":"debug_encode","type":"boolean","description":"A flag indicating whether debug mode is enabled for encoding processes","example":true},"os_swift_template":{"title":"os_swift_template","type":"string","description":"The template used for OpenStack Swift integration","example":"media"},"replace_no_checks":{"title":"replace_no_checks","type":"boolean"},"v1_compat":{"title":"v1_compat","type":"boolean","description":"A flag indicating compatibility with version 1 of the service","example":true},"v1_compat_callback":{"title":"v1_compat_callback","type":"boolean","description":"A flag indicating compatibility with version 1 of callback functions"},"v1_compat_ftp":{"title":"v1_compat_ftp","type":"integer","description":"A flag indicating compatibility with version 1 of FTP services"},"v1_compat_soap_api":{"title":"v1_compat_soap_api","type":"boolean","description":"A flag indicating compatibility with version 1 of the SOAP API","example":true},"extract_audio":{"title":"extract_audio","type":"boolean"},"features":{"title":"features","type":"array"},"linked_services":{"title":"linked_services","type":"array"}}},"506dc7b6_Mediathumbnailslinks":{"title":"Media thumbnails links","type":"object","properties":{"image":{"title":"image","type":"string","description":"The image associated with Media thumbnails links","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"audio_preview":{"title":"audio_preview","type":"string","description":"Waveform image","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"audio_waveform":{"title":"audio_waveform","type":"string","description":"Waveform binary data","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"audio_sample":{"title":"audio_sample","type":"string","description":"Audio file containing an excerpt of the media (audio only)","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"video_preview":{"title":"video_preview","type":"string","description":"10x10 spritemap of the media","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"video_sample":{"title":"video_sample","type":"string","description":"`1xN` low res spritemap of the media containing an image per second","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"thumbstrip":{"title":"thumbstrip","type":"string","description":"10x300 medium res spritemap of the media containing an image per second","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"scenes":{"title":"scenes","type":"string","description":"10x300 medium res spritemap of the media containing an image for each scene change","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"poster":{"title":"poster","type":"string","description":"High res thumbnail image, may be used for user integration","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg"},"timeline":{"title":"timeline","type":"string","example":"https:\/\/api.infomaniak.com\/2\/vod\/thumbnails\/1jhvl2uqbqx6x.jpg?tl&width=140&height=100"}}},"506dc7b6_Label":{"title":"Label","required":["id","name","options"],"type":"object","properties":{"id":{"title":"id","type":"integer","description":"The unique identifier of the Label","example":1},"name":{"title":"name","type":"string","description":"The name of the Label","example":"my product"},"options":{"$ref":"#\/components\/schemas\/506dc7b6_LabelConfiguration"},"type":{"title":"type","type":"string","description":"The type of Label","example":"file"}}},"506dc7b6_LabelConfiguration":{"title":"Label Configuration","required":["color"],"type":"object","properties":{"color":{"title":"color","type":"string"},"media":{"title":"media","type":"array","description":"The media unique identifier"}}},"506dc7b6_FileExcerpt":{"title":"File Excerpt","required":["id","type"],"type":"object","properties":{"id":{"title":"id","type":"string","description":"The unique identifier of the File Excerpt","example":"1jhvl2upzafkt"},"type":{"title":"type","enum":["file","folder"],"type":"array","items":{"type":"string","title":"type","description":"<note>folder<\/strong>: Folder model<\/note><note>file<\/strong>: File model<\/note>"},"description":"<note>folder<\/strong>: Folder model<\/note><note>file<\/strong>: File model<\/note>","example":"folder"},"name":{"title":"name","type":"string","description":"The name of the File Excerpt","example":"my product"},"streams":{"title":"streams","enum":["audio","video"],"type":"array","items":{"type":"string","title":"streams","description":"File Excerpt streams (only applies to media)<note>audio<\/strong>: Media has an audio stream<\/note><note>video<\/strong>: Media has a video stream<\/note>"},"description":"File Excerpt streams (only applies to media)<note>audio<\/strong>: Media has an audio stream<\/note><note>video<\/strong>: Media has a video stream<\/note>","example":"audio"},"children":{"title":"children","type":"array","items":{"$ref":"#\/components\/schemas\/506dc7b6_FileExcerpt"},"description":"The children of the File Excerpt"}}},"506dc7b6_User":{"title":"User","required":["active","channel_id","id","password","username"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the User","example":"1jhvl2upzafkt"},"channel_id":{"title":"channel_id","type":"integer","description":"The identifier of the `channel` resource related to User","example":11608},"home_folder":{"$ref":"#\/components\/schemas\/506dc7b6_Relation"},"home_path":{"title":"home_path","type":"string","description":"The home path associated with the User"},"username":{"title":"username","type":"string","description":"The username of the User"},"password":{"title":"password","type":"string","description":"The password of the User","example":"1337Passw0rdZ!"},"permissions":{"title":"permissions","enum":["appe","chmod","cwd","dele","list","mfmt","mkd","retr","rnfr","stor"],"type":"array","items":{"type":"string","title":"permissions","description":"User permissions<note>cwd<\/strong>: Change Working Directory (navigate to a different directory)<\/note><note>list<\/strong>: List files and directories in the current directory<\/note><note>retr<\/strong>: Retrieve (download) a file from the server<\/note><note>appe<\/strong>: Append data to an existing file on the server<\/note><note>dele<\/strong>: Delete a file on the server<\/note><note>rnfr<\/strong>: Rename From (specify the original name when renaming a file)<\/note><note>mkd<\/strong>: Make Directory (create a new directory)<\/note><note>stor<\/strong>: Store (upload) a file to the server<\/note><note>chmod<\/strong>: Change the permissions of a file or directory<\/note><note>mfmt<\/strong>: Modify the modification time of a file<\/note>"},"description":"User permissions<note>cwd<\/strong>: Change Working Directory (navigate to a different directory)<\/note><note>list<\/strong>: List files and directories in the current directory<\/note><note>retr<\/strong>: Retrieve (download) a file from the server<\/note><note>appe<\/strong>: Append data to an existing file on the server<\/note><note>dele<\/strong>: Delete a file on the server<\/note><note>rnfr<\/strong>: Rename From (specify the original name when renaming a file)<\/note><note>mkd<\/strong>: Make Directory (create a new directory)<\/note><note>stor<\/strong>: Store (upload) a file to the server<\/note><note>chmod<\/strong>: Change the permissions of a file or directory<\/note><note>mfmt<\/strong>: Modify the modification time of a file<\/note>","example":"cwd"},"description":{"title":"description","type":"string","description":"The description of the User","example":"Wow, such a nice User !"},"active":{"title":"active","type":"string","description":"Indicates whether the User is active","example":"true"},"msg_login":{"title":"msg_login","type":"string","description":"The login message for the User"},"msg_quit":{"title":"msg_quit","type":"string","description":"The quit message for the User"},"created_at":{"title":"created_at","type":"integer","description":"The date and time when the User was created","format":"timestamp","example":2022},"updated_at":{"title":"updated_at","type":"integer","description":"The date and time when the User was updated","format":"timestamp","example":2022}}},"506dc7b6_Ad":{"title":"Ad","required":["id","type","url"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the Ad","example":"1jhvl2upzafkt"},"url":{"title":"url","type":"string","description":"The URL of Ad","example":"https:\/\/pubads.g.doubleclick.net\/gampad\/ads?sz=640x480&iu=\/KUhi612123\/external\/single_ad_samples"},"type":{"title":"type","enum":["mid_roll","pre_roll","pst_roll"],"type":"array","items":{"type":"string","title":"type","description":"The type of Ad<note>pre_roll<\/strong>: Advertisement displayed before the main content<\/note><note>mid_roll<\/strong>: Advertisement displayed during the main content<\/note><note>pst_roll<\/strong>: Advertisement displayed after the main content<\/note>"},"description":"The type of Ad<note>pre_roll<\/strong>: Advertisement displayed before the main content<\/note><note>mid_roll<\/strong>: Advertisement displayed during the main content<\/note><note>pst_roll<\/strong>: Advertisement displayed after the main content<\/note>","example":"pre_roll"},"offset":{"title":"offset","type":"string","description":"The offset after which the Ad gets loaded","example":"00:00:15"},"skip_after":{"title":"skip_after","type":"number","description":"The time in seconds after which the Ad can be skipped","example":3},"tracking_url":{"title":"tracking_url","type":"string","description":"The tracking url of the Ad","example":"https:\/\/infomaniak.com"},"href":{"title":"href","type":"string","example":"https:\/\/infomaniak.com\/"}}},"506dc7b6_Logo":{"title":"Logo","required":["created_at","height","id","margin_x","margin_y","mimetype","mode","position","size","updated_at","url","width"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the Logo","example":"1jhvl2upzafkt"},"mode":{"title":"mode","enum":["embed","overlay"],"type":"array","items":{"type":"string","title":"mode","description":"The Logo mode<note>overlay<\/strong>: The logo is added on top of the video by a player configuration<\/note><note>embed<\/strong>: The logo is directly encoded in the video<\/note>"},"description":"The Logo mode<note>overlay<\/strong>: The logo is added on top of the video by a player configuration<\/note><note>embed<\/strong>: The logo is directly encoded in the video<\/note>","example":"overlay"},"position":{"title":"position","enum":["bottom_left","bottom_middle","bottom_right","center_left","center_middle","center_right","top_left","top_middle","top_right"],"type":"array","items":{"type":"string","title":"position","description":"The anchor of the Logo<note>top_left<\/strong>: Positioned at the top left corner<\/note><note>top_middle<\/strong>: Positioned at the top middle<\/note><note>top_right<\/strong>: Positioned at the top right corner<\/note><note>center_left<\/strong>: Positioned at the center left<\/note><note>center_middle<\/strong>: Positioned at the center middle<\/note><note>center_right<\/strong>: Positioned at the center right<\/note><note>bottom_left<\/strong>: Positioned at the bottom left corner<\/note><note>bottom_middle<\/strong>: Positioned at the bottom middle<\/note><note>bottom_right<\/strong>: Positioned at the bottom right corner<\/note>"},"description":"The anchor of the Logo<note>top_left<\/strong>: Positioned at the top left corner<\/note><note>top_middle<\/strong>: Positioned at the top middle<\/note><note>top_right<\/strong>: Positioned at the top right corner<\/note><note>center_left<\/strong>: Positioned at the center left<\/note><note>center_middle<\/strong>: Positioned at the center middle<\/note><note>center_right<\/strong>: Positioned at the center right<\/note><note>bottom_left<\/strong>: Positioned at the bottom left corner<\/note><note>bottom_middle<\/strong>: Positioned at the bottom middle<\/note><note>bottom_right<\/strong>: Positioned at the bottom right corner<\/note>","example":"top_left"},"size":{"title":"size","type":"integer","description":"The size percentage of the Logo","example":40},"url":{"title":"url","type":"string","description":"The URL of Logo","example":"https:\/\/api.infomaniak.com\/2\/vod\/res\/logos\/1jhvl2uqbqx6x.jpg"},"width":{"title":"width","type":"integer","description":"The width of Logo","example":673},"height":{"title":"height","type":"integer","description":"The height of Logo","example":785},"margin_x":{"title":"margin_x","type":"integer","description":"The margin on the x-axis of the Logo","example":10},"margin_y":{"title":"margin_y","type":"integer","description":"The margin on the y-axis of the Logo","example":10},"mimetype":{"title":"mimetype","type":"string","description":"The MIME type of Logo","example":"image\/png"},"created_at":{"title":"created_at","type":"integer","description":"The date and time when the Logo was created","format":"timestamp","example":2022},"updated_at":{"title":"updated_at","type":"integer","description":"The date and time when the Logo was updated","format":"timestamp","example":2022}}},"506dc7b6_Encoding":{"title":"Encoding","required":["copy","created_at","id","is_generic","name","updated_at"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the Encoding","example":"1jhvl2upzafkt"},"is_generic":{"title":"is_generic","type":"boolean","description":"Indicates whether the Encoding is shared","example":true},"configured_folders":{"title":"configured_folders","type":"string","description":"Folders configured with this Encoding","example":"3"},"container":{"title":"container","enum":["aac","copy","flv","m4a","mkv","mp3","mp4","webm"],"type":"array","items":{"type":"string","title":"container","description":"The Encoding container<note>flv<\/strong>: Adobe Flash Video container format<\/note><note>m4a<\/strong>: MPEG-4 Audio container format<\/note><note>mkv<\/strong>: Matroska Multimedia container format<\/note><note>mp4<\/strong>: MPEG-4 Multimedia container format<\/note><note>webm<\/strong>: WebM Multimedia container format<\/note><note>mp3<\/strong>: MPEG-1 or MPEG-2 Audio Layer III audio container<\/note><note>copy<\/strong>: Uncompressed, lossless container format<\/note><note>aac<\/strong>: Advanced Audio Coding container format<\/note>"},"description":"The Encoding container<note>flv<\/strong>: Adobe Flash Video container format<\/note><note>m4a<\/strong>: MPEG-4 Audio container format<\/note><note>mkv<\/strong>: Matroska Multimedia container format<\/note><note>mp4<\/strong>: MPEG-4 Multimedia container format<\/note><note>webm<\/strong>: WebM Multimedia container format<\/note><note>mp3<\/strong>: MPEG-1 or MPEG-2 Audio Layer III audio container<\/note><note>copy<\/strong>: Uncompressed, lossless container format<\/note><note>aac<\/strong>: Advanced Audio Coding container format<\/note>","example":"flv"},"name":{"title":"name","type":"string","description":"The name of the Encoding","example":"mp4 1080p"},"copy":{"title":"copy","type":"boolean","description":"Indicates whether the Encoding is a pure copy","example":true},"video_codec":{"title":"video_codec","enum":["copy","h263","h264","hevc","theora","vp8","vp9"],"type":"array","items":{"type":"string","title":"video_codec","description":"The video codec<note>h264<\/strong>: Efficient video compression standard<\/note><note>hevc<\/strong>: High-efficiency video coding technology<\/note><note>theora<\/strong>: Open-source video compression format<\/note><note>vp8<\/strong>: Google's video compression standard<\/note><note>vp9<\/strong>: High-quality video compression codec<\/note><note>copy<\/strong>: Uncompressed, lossless video codec<\/note><note>h263<\/strong>: Video compression standard for low bitrates<\/note>"},"description":"The video codec<note>h264<\/strong>: Efficient video compression standard<\/note><note>hevc<\/strong>: High-efficiency video coding technology<\/note><note>theora<\/strong>: Open-source video compression format<\/note><note>vp8<\/strong>: Google's video compression standard<\/note><note>vp9<\/strong>: High-quality video compression codec<\/note><note>copy<\/strong>: Uncompressed, lossless video codec<\/note><note>h263<\/strong>: Video compression standard for low bitrates<\/note>","example":"h264"},"video_aspect":{"title":"video_aspect","enum":["copy","fill","keep_ratio","letterbox","stretch"],"type":"array","items":{"type":"string","title":"video_aspect","description":"The audio aspect<note>letterbox<\/strong>: Preserves aspect ratio with black bars<\/note><note>stretch<\/strong>: Stretches content to fill screen<\/note><note>fill<\/strong>: Expands content to fit screen<\/note><note>keep_ratio<\/strong>: Maintains original aspect ratio<\/note><note>copy<\/strong>: Matches aspect ratio of the source<\/note>"},"description":"The audio aspect<note>letterbox<\/strong>: Preserves aspect ratio with black bars<\/note><note>stretch<\/strong>: Stretches content to fill screen<\/note><note>fill<\/strong>: Expands content to fit screen<\/note><note>keep_ratio<\/strong>: Maintains original aspect ratio<\/note><note>copy<\/strong>: Matches aspect ratio of the source<\/note>","example":"letterbox"},"video_fps":{"title":"video_fps","type":"number","description":"The video frames per second of the Encoding","example":12},"audio_codec":{"title":"audio_codec","enum":["aac","copy","flac","he_aac","mp3","opus","vorbis"],"type":"array","items":{"type":"string","title":"audio_codec","description":"The audio codec<note>aac<\/strong>: Advanced Audio Coding<\/note><note>he_aac<\/strong>: High-Efficiency Advanced Audio Coding<\/note><note>flac<\/strong>: Free Lossless Audio Codec<\/note><note>mp3<\/strong>: MPEG-1 Audio Layer III<\/note><note>vorbis<\/strong>: Open-source audio compression format<\/note><note>copy<\/strong>: Uncompressed, lossless audio codec<\/note><note>opus<\/strong>: Versatile audio codec<\/note>"},"description":"The audio codec<note>aac<\/strong>: Advanced Audio Coding<\/note><note>he_aac<\/strong>: High-Efficiency Advanced Audio Coding<\/note><note>flac<\/strong>: Free Lossless Audio Codec<\/note><note>mp3<\/strong>: MPEG-1 Audio Layer III<\/note><note>vorbis<\/strong>: Open-source audio compression format<\/note><note>copy<\/strong>: Uncompressed, lossless audio codec<\/note><note>opus<\/strong>: Versatile audio codec<\/note>","example":"aac"},"audio_channel":{"title":"audio_channel","enum":["mono_1_0","stereo_2_0","stereo_2_1","surround_4_1","surround_5_1","surround_6_1","surround_7_1"],"type":"array","items":{"type":"string","title":"audio_channel","description":"The audio channel<note>mono_1_0<\/strong>: Single-channel audio<\/note><note>stereo_2_0<\/strong>: Two-channel audio<\/note><note>stereo_2_1<\/strong>: Two-channel audio with subwoofer<\/note><note>surround_4_1<\/strong>: Four-channel audio with subwoofer<\/note><note>surround_5_1<\/strong>: Six-channel audio (5 speakers + subwoofer)<\/note><note>surround_6_1<\/strong>: Seven-channel audio (6 speakers + subwoofer)<\/note><note>surround_7_1<\/strong>: Eight-channel audio (7 speakers + subwoofer)<\/note>"},"description":"The audio channel<note>mono_1_0<\/strong>: Single-channel audio<\/note><note>stereo_2_0<\/strong>: Two-channel audio<\/note><note>stereo_2_1<\/strong>: Two-channel audio with subwoofer<\/note><note>surround_4_1<\/strong>: Four-channel audio with subwoofer<\/note><note>surround_5_1<\/strong>: Six-channel audio (5 speakers + subwoofer)<\/note><note>surround_6_1<\/strong>: Seven-channel audio (6 speakers + subwoofer)<\/note><note>surround_7_1<\/strong>: Eight-channel audio (7 speakers + subwoofer)<\/note>","example":"mono_1_0"},"streams":{"title":"streams","type":"array","items":{"$ref":"#\/components\/schemas\/506dc7b6_Stream"},"description":"The streams associated with Encoding"},"created_at":{"title":"created_at","type":"integer","description":"The date and time when the Encoding was created","format":"timestamp","example":2022},"updated_at":{"title":"updated_at","type":"integer","description":"The date and time when the Encoding was updated","format":"timestamp","example":2022}}},"506dc7b6_Stream":{"title":"Stream","required":["id"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the Stream","example":"1jhvl2upzafkt"},"video_bitrate":{"title":"video_bitrate","type":"integer","description":"The video bitrate of the Stream stream"},"video_width":{"title":"video_width","type":"integer","description":"The video width of the Stream stream"},"video_height":{"title":"video_height","type":"integer","description":"The video height of the Stream stream"},"audio_bitrate":{"title":"audio_bitrate","type":"integer","description":"The audio bitrate of the Stream stream"},"audio_sampling":{"title":"audio_sampling","type":"integer","description":"The audio sampling rate of the Stream stream"}}},"506dc7b6_Subtitle":{"title":"Subtitle","required":["default","id","lang","name","source"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the Subtitle","example":"1jhvl2upzafkt"},"name":{"title":"name","type":"string","description":"The name of the Subtitle","example":"my product"},"lang":{"title":"lang","type":"string","description":"The language of the Subtitle","example":"fr"},"default":{"title":"default","type":"string","description":"Indicates whether the Subtitle is set as default"},"source":{"title":"source","type":"string","description":"The source of the Subtitle","example":"https:\/\/play.vod2.infomaniak.com\/hls\/1jhvl2uqbr5v0\/1jhvl2uqbjke0\/1jhvl2uqbr5v0.mp4"}}},"506dc7b6_VideoEncodingCodec":{"title":"Video Encoding Codec","required":["description","fps_max","fps_min","name","resolution_max","resolution_min","supported_by_player","value"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"The name of the Video Encoding Codec","example":"H.264 (MPEG-4 AVC)"},"value":{"title":"value","type":"string","description":"The value associated with the Video Encoding Codec","example":"h264"},"description":{"title":"description","type":"string","description":"The description of the Video Encoding Codec","example":"Wow, such a nice Video Encoding Codec !"},"supported_by_player":{"title":"supported_by_player","type":"boolean","description":"Indicates whether the Video Encoding Codec is supported by the player","example":true},"bitrate_min":{"title":"bitrate_min","type":"integer","description":"The minimum bitrate supported by the Video Encoding Codec","example":42000000},"bitrate_max":{"title":"bitrate_max","type":"integer","description":"The maximum bitrate supported by the Video Encoding Codec","example":50000},"resolution_min":{"$ref":"#\/components\/schemas\/506dc7b6_Resolution"},"resolution_max":{"$ref":"#\/components\/schemas\/506dc7b6_Resolution"},"fps_min":{"title":"fps_min","type":"number","description":"The minimum frames per second (FPS) supported by the Video Encoding Codec","example":5},"fps_max":{"title":"fps_max","type":"number","description":"The maximum frames per second (FPS) supported by the Video Encoding Codec","example":120}}},"506dc7b6_AudioEncodingCodec":{"title":"Audio Encoding Codec","required":["description","name","samplings","supported_by_player","value"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"The name of the Audio Encoding Codec","example":"AAC (Advanced Audio Coding)"},"value":{"title":"value","type":"string","description":"The value associated with the Audio Encoding Codec","example":"aac"},"description":{"title":"description","type":"string","description":"The codec description","example":"Advanced Audio Coding"},"supported_by_player":{"title":"supported_by_player","type":"boolean","description":"Indicates whether the Audio Encoding Codec is supported by the player","example":true},"bitrate_min":{"title":"bitrate_min","type":"integer","description":"The minimum bitrate supported by the Audio Encoding Codec","example":42000000},"bitrate_max":{"title":"bitrate_max","type":"integer","description":"The maximum bitrate supported by the Audio Encoding Codec","example":50000},"samplings":{"title":"samplings","type":"array","items":{"type":"integer","title":"samplings","description":"The samplings supported by the Audio Encoding Codec"},"description":"The samplings supported by the Audio Encoding Codec"}}},"506dc7b6_EncodingContainer":{"title":"Encoding Container","required":["audio","name","supported_codecs","value","video"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"The name of the Encoding Container","example":"Matroska (.mkv)"},"value":{"title":"value","type":"string","description":"The value associated with the Encoding Container","example":"mkv"},"audio":{"title":"audio","type":"boolean","description":"Can contain audio streams ?","example":true},"video":{"title":"video","type":"boolean","description":"Can contain video streams ?","example":true},"supported_codecs":{"title":"supported_codecs","enum":["aac","copy","flac","h263","h264","he_aac","hevc","mp3","theora","vorbis","vp8","vp9"],"type":"array","items":{"type":"string","title":"supported_codecs"},"example":"[aac, copy]"}}},"506dc7b6_Resolution":{"title":"Resolution","required":["height","width"],"type":"object","properties":{"width":{"title":"width","type":"number","description":"The width of Resolution","example":673},"height":{"title":"height","type":"number","description":"The height of Resolution","example":785}}},"506dc7b6_Playlistsettings":{"title":"Playlist settings","type":"object","properties":{"mode":{"title":"mode","enum":["live","merge","split"],"type":"array","items":{"type":"string","title":"mode","description":"Playlist settings mode (changes progressbar behaviour)<note>merge<\/strong>: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media<\/note><note>split<\/strong>: Each media will be played individually: the progress-bar will be independent for each media<\/note><note>live<\/strong>: The playlist will act as a live streaming: no scrubbing will be allowed<\/note>"},"description":"Playlist settings mode (changes progressbar behaviour)<note>merge<\/strong>: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media<\/note><note>split<\/strong>: Each media will be played individually: the progress-bar will be independent for each media<\/note><note>live<\/strong>: The playlist will act as a live streaming: no scrubbing will be allowed<\/note>","example":"merge"},"show_media_thumbnail":{"title":"show_media_thumbnail","type":"boolean","description":"Indicates whether media thumbnail should be shown for the Playlist settings","example":true},"show_media_info":{"title":"show_media_info","type":"boolean","description":"Indicates whether media information should be shown for the Playlist settings","example":true},"nav_position":{"title":"nav_position","enum":["above","below"],"type":"array","items":{"type":"string","title":"nav_position","description":"Playlist settings nav position<note>above<\/strong>: Controls are placed above the playlist<\/note><note>below<\/strong>: Controls are placed below the playlist<\/note>"},"description":"Playlist settings nav position<note>above<\/strong>: Controls are placed above the playlist<\/note><note>below<\/strong>: Controls are placed below the playlist<\/note>","example":"above"},"chapter_style":{"title":"chapter_style","enum":["dark","light"],"type":"array","items":{"type":"string","title":"chapter_style","description":"Playlist settings chapter style<note>dark<\/strong>: Darker colors<\/note><note>light<\/strong>: Lighter colors<\/note>"},"description":"Playlist settings chapter style<note>dark<\/strong>: Darker colors<\/note><note>light<\/strong>: Lighter colors<\/note>","example":"dark"}}},"506dc7b6_Player":{"title":"Player","required":["ads_category","airplay","audio_volume","auto_hide_controls","auto_start","chromecast","control_active_color","control_color","controlbar_color","default_speed","enable_embed_code","enable_facebook","enable_linkedin","enable_twitter","enable_whatsapp","encoding_change_enabled","encoding_limit","force_media_ratio","force_subtitles_activated","has_logo","height","is360","logo_anchor","logo_margin_horizontal","logo_margin_vertical","logo_percentage","name","preferred_playback_strategy_activated","show_audio","show_controls","show_default_logo","show_download","show_duration","show_fullscreen","show_loop","show_media_info","show_media_thumbnail","show_progression","show_replay","show_speed","show_viewers","show_viewers_after","show_viewers_only_after","skip_intro_activated","theme","theme_activated","time_before_hide_cb","time_skip_mode","twitter_related","width"],"type":"object","properties":{"ads_category":{"title":"ads_category","type":"string"},"audio_volume":{"title":"audio_volume","type":"integer","description":"The volume of the audio for the Player","example":100},"auto_hide_controls":{"title":"auto_hide_controls","type":"boolean","description":"Indicates whether controls should automatically hide for the Player","example":true},"auto_start":{"title":"auto_start","type":"boolean","description":"Indicates whether media should start automatically for the Player","example":true},"chromecast":{"title":"chromecast","type":"boolean","description":"Indicates whether Chromecast is enabled for the Player"},"airplay":{"title":"airplay","type":"boolean"},"control_active_color":{"title":"control_active_color","type":"string","description":"The active color of the Player controls","example":"#ffffff"},"control_color":{"title":"control_color","type":"string","description":"The color of the Player controls","example":"#ffffff"},"controlbar_color":{"title":"controlbar_color","type":"string","description":"The color of the Player control bar","example":"#ffffff"},"default_speed":{"title":"default_speed","type":"number","description":"The default speed of playback for the Player"},"enable_embed_code":{"title":"enable_embed_code","type":"boolean","description":"Indicates whether embed code is enabled for the Player","example":true},"enable_facebook":{"title":"enable_facebook","type":"boolean","description":"Indicates whether Facebook sharing is enabled for the Player","example":true},"enable_twitter":{"title":"enable_twitter","type":"boolean","description":"Indicates whether Twitter sharing is enabled for the Player","example":true},"enable_whatsapp":{"title":"enable_whatsapp","type":"boolean"},"enable_linkedin":{"title":"enable_linkedin","type":"boolean"},"encoding_change_enabled":{"title":"encoding_change_enabled","type":"boolean","description":"Indicates whether encoding change is enabled for the Player"},"encoding_limit":{"title":"encoding_limit","type":"boolean","description":"The encoding limit for the Player"},"facebook_back_link":{"title":"facebook_back_link","type":"string","description":"The back link for Facebook sharing associated with the Player","example":"https:\/\/example.com"},"force_media_ratio":{"title":"force_media_ratio","type":"boolean","description":"Indicates whether media ratio is enforced for the Player"},"height":{"title":"height","type":"integer","description":"The height of Player","example":785},"has_logo":{"title":"has_logo","type":"boolean"},"is360":{"title":"is360","type":"boolean","description":"Indicates whether the Player supports 360-degree videos","example":true},"time_skip_mode":{"title":"time_skip_mode","type":"string"},"logo_anchor":{"title":"logo_anchor","type":"string","description":"The anchor position of the Player logo","example":"top_right"},"force_subtitles_activated":{"title":"force_subtitles_activated","type":"boolean"},"force_subtitles_type":{"title":"force_subtitles_type","type":"string"},"logo_margin_horizontal":{"title":"logo_margin_horizontal","type":"integer","description":"The horizontal margin of the Player logo","example":10},"logo_margin_vertical":{"title":"logo_margin_vertical","type":"integer","description":"The vertical margin of the Player logo","example":10},"logo_percentage":{"title":"logo_percentage","type":"integer","description":"The size percentage of the Player logo","example":100},"media_thumbnail_anchor":{"title":"media_thumbnail_anchor","type":"string","description":"The anchor position of the Player thumbnail","example":"top"},"player_end_screen_type":{"title":"player_end_screen_type","type":"string","description":"The selected kind of player ending screen","example":"pause_and_replay"},"preferred_playback_strategy_activated":{"title":"preferred_playback_strategy_activated","type":"boolean"},"preferred_playback_strategy":{"title":"preferred_playback_strategy","type":"string","description":"The preferred playback strategy for the Player: may not be satisfied","example":"hls"},"show_audio":{"title":"show_audio","type":"boolean","description":"Indicates whether audio controls should be shown for the Player","example":true},"show_controls":{"title":"show_controls","type":"boolean","description":"Indicates whether controls should be shown for the Player","example":true},"show_download":{"title":"show_download","type":"boolean"},"show_default_logo":{"title":"show_default_logo","type":"boolean","description":"Indicates whether the default logo should be shown for the Player","example":true},"show_duration":{"title":"show_duration","type":"boolean","description":"Indicates whether the duration should be shown for the Player","example":true},"show_fullscreen":{"title":"show_fullscreen","type":"boolean","description":"Indicates whether fullscreen controls should be shown for the Player","example":true},"show_loop":{"title":"show_loop","type":"boolean","description":"Indicates whether loop controls should be shown for the Player","example":true},"show_media_info":{"title":"show_media_info","type":"boolean","description":"Indicates whether media information should be shown for the Player","example":true},"show_media_thumbnail":{"title":"show_media_thumbnail","type":"boolean","description":"Indicates whether media thumbnail should be shown for the Player","example":true},"show_progression":{"title":"show_progression","type":"boolean","description":"Indicates whether progression controls should be shown for the Player","example":true},"suggestions":{"title":"suggestions","type":"string","description":"a list media sources to play at the end of current media"},"show_replay":{"title":"show_replay","type":"boolean","description":"Indicates whether replay controls should be shown for the Player","example":true},"show_speed":{"title":"show_speed","type":"boolean","description":"Indicates whether speed controls should be shown for the Player","example":true},"show_viewers":{"title":"show_viewers","type":"boolean","description":"Indicates whether viewers count should be shown for the Player","example":true},"show_viewers_after":{"title":"show_viewers_after","type":"boolean","description":"The time after which viewers count should be shown for the Player","example":true},"show_viewers_only_after":{"title":"show_viewers_only_after","type":"boolean","description":"The time only after which viewers count should be shown for the Player","example":true},"skip_intro_activated":{"title":"skip_intro_activated","type":"boolean"},"skip_intro_to":{"title":"skip_intro_to","type":"integer","description":"Number of seconds to reach once the \"skip intro\" button is pressed, nothing will appear if value is 0","example":30},"time_before_hide_cb":{"title":"time_before_hide_cb","type":"integer","description":"The time before controls should be hidden for the Player","example":10},"twitter_back_link":{"title":"twitter_back_link","type":"string","description":"The back link for Twitter sharing associated with the Player","example":"@infomaniak"},"twitter_related":{"title":"twitter_related","type":"array","description":"The related Twitter account associated with the Player","example":"[\"infomaniak\"]"},"twitter_via":{"title":"twitter_via","type":"string","description":"The Twitter via associated with the Player","example":"infomaniak"},"width":{"title":"width","type":"integer","description":"The width of Player","example":673},"theme":{"title":"theme","type":"string","description":"The theme for the Player","example":"Treso"},"theme_activated":{"title":"theme_activated","type":"boolean"},"name":{"title":"name","type":"string","description":"The name of the Player","example":"my product"},"not_before":{"title":"not_before","type":"integer","example":15},"logo_image":{"title":"logo_image","type":"string","description":"The logo image associated with the Player","example":"https:\/\/api.infomaniak.com\/2\/vod\/res\/players\/1jhvl2uqblphl.logo.png"},"preload_image":{"title":"preload_image","type":"string","description":"Preload image link","example":"\/2\/vod\/players\/1jhvl2uqblphl.preload.png"},"interrupt_image":{"title":"interrupt_image","type":"string","description":"Interrupt image link","example":"\/2\/vod\/players\/1jhvl2uqblphl.interrupt.png"},"geoip_image":{"title":"geoip_image","type":"string","description":"Geoip image link","example":"\/2\/vod\/players\/1jhvl2uqblphl.geoip.png"},"restrict_image":{"title":"restrict_image","type":"string","description":"Restrict image link","example":"\/2\/vod\/players\/1jhvl2uqblphl.restrict.png"},"ads":{"title":"ads","type":"array","items":{"$ref":"#\/components\/schemas\/506dc7b6_Ad"},"description":"The ads associated with the Player"}}},"506dc7b6_Playersettings":{"title":"Player settings","type":"object","properties":{"width":{"title":"width","type":"integer","description":"The width of Player settings","example":673},"height":{"title":"height","type":"integer","description":"The height of Player settings","example":785},"auto_start":{"title":"auto_start","type":"boolean","description":"Indicates whether media should start automatically for the Player settings","example":true},"show_loop":{"title":"show_loop","type":"boolean","description":"Indicates whether loop controls should be shown for the Player settings","example":true},"preload_image":{"title":"preload_image","type":"string","description":"Preload image link","example":"\/2\/vod\/players\/1jhvl2uqblphl.preload.png"},"force_media_ratio":{"title":"force_media_ratio","type":"string","description":"Indicates whether media ratio is enforced for the Player settings"},"show_progression":{"title":"show_progression","type":"string","description":"Indicates whether progression controls should be shown for the Player settings","example":"true"}}},"506dc7b6_Stream_9339d051":{"title":"Stream","required":["copy","created_at","id","is_generic","name","streams","updated_at"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the Stream","example":"1jhvl2upzafkt"},"is_generic":{"title":"is_generic","type":"boolean","description":"Indicates whether the Stream is shared","example":true},"configured_folders":{"title":"configured_folders","type":"string","description":"Folders configured with this Stream","example":"3"},"container":{"title":"container","enum":["aac","copy","flv","m4a","mkv","mp3","mp4","webm"],"type":"array","items":{"type":"string","title":"container","description":"The Stream container<note>flv<\/strong>: Adobe Flash Video container format<\/note><note>m4a<\/strong>: MPEG-4 Audio container format<\/note><note>mkv<\/strong>: Matroska Multimedia container format<\/note><note>mp4<\/strong>: MPEG-4 Multimedia container format<\/note><note>webm<\/strong>: WebM Multimedia container format<\/note><note>mp3<\/strong>: MPEG-1 or MPEG-2 Audio Layer III audio container<\/note><note>copy<\/strong>: Uncompressed, lossless container format<\/note><note>aac<\/strong>: Advanced Audio Coding container format<\/note>"},"description":"The Stream container<note>flv<\/strong>: Adobe Flash Video container format<\/note><note>m4a<\/strong>: MPEG-4 Audio container format<\/note><note>mkv<\/strong>: Matroska Multimedia container format<\/note><note>mp4<\/strong>: MPEG-4 Multimedia container format<\/note><note>webm<\/strong>: WebM Multimedia container format<\/note><note>mp3<\/strong>: MPEG-1 or MPEG-2 Audio Layer III audio container<\/note><note>copy<\/strong>: Uncompressed, lossless container format<\/note><note>aac<\/strong>: Advanced Audio Coding container format<\/note>","example":"flv"},"name":{"title":"name","type":"string","description":"The name of the Stream","example":"mp4 1080p"},"copy":{"title":"copy","type":"boolean","description":"Indicates whether the Stream is a pure copy","example":true},"video_codec":{"title":"video_codec","enum":["copy","h263","h264","hevc","theora","vp8","vp9"],"type":"array","items":{"type":"string","title":"video_codec","description":"The video codec<note>h264<\/strong>: Efficient video compression standard<\/note><note>hevc<\/strong>: High-efficiency video coding technology<\/note><note>theora<\/strong>: Open-source video compression format<\/note><note>vp8<\/strong>: Google's video compression standard<\/note><note>vp9<\/strong>: High-quality video compression codec<\/note><note>copy<\/strong>: Uncompressed, lossless video codec<\/note><note>h263<\/strong>: Video compression standard for low bitrates<\/note>"},"description":"The video codec<note>h264<\/strong>: Efficient video compression standard<\/note><note>hevc<\/strong>: High-efficiency video coding technology<\/note><note>theora<\/strong>: Open-source video compression format<\/note><note>vp8<\/strong>: Google's video compression standard<\/note><note>vp9<\/strong>: High-quality video compression codec<\/note><note>copy<\/strong>: Uncompressed, lossless video codec<\/note><note>h263<\/strong>: Video compression standard for low bitrates<\/note>","example":"h264"},"video_aspect":{"title":"video_aspect","enum":["copy","fill","keep_ratio","letterbox","stretch"],"type":"array","items":{"type":"string","title":"video_aspect","description":"The audio aspect<note>letterbox<\/strong>: Preserves aspect ratio with black bars<\/note><note>stretch<\/strong>: Stretches content to fill screen<\/note><note>fill<\/strong>: Expands content to fit screen<\/note><note>keep_ratio<\/strong>: Maintains original aspect ratio<\/note><note>copy<\/strong>: Matches aspect ratio of the source<\/note>"},"description":"The audio aspect<note>letterbox<\/strong>: Preserves aspect ratio with black bars<\/note><note>stretch<\/strong>: Stretches content to fill screen<\/note><note>fill<\/strong>: Expands content to fit screen<\/note><note>keep_ratio<\/strong>: Maintains original aspect ratio<\/note><note>copy<\/strong>: Matches aspect ratio of the source<\/note>","example":"letterbox"},"video_fps":{"title":"video_fps","type":"number","description":"The video frames per second of the Stream","example":12},"audio_codec":{"title":"audio_codec","enum":["aac","copy","flac","he_aac","mp3","opus","vorbis"],"type":"array","items":{"type":"string","title":"audio_codec","description":"The audio codec<note>aac<\/strong>: Advanced Audio Coding<\/note><note>he_aac<\/strong>: High-Efficiency Advanced Audio Coding<\/note><note>flac<\/strong>: Free Lossless Audio Codec<\/note><note>mp3<\/strong>: MPEG-1 Audio Layer III<\/note><note>vorbis<\/strong>: Open-source audio compression format<\/note><note>copy<\/strong>: Uncompressed, lossless audio codec<\/note><note>opus<\/strong>: Versatile audio codec<\/note>"},"description":"The audio codec<note>aac<\/strong>: Advanced Audio Coding<\/note><note>he_aac<\/strong>: High-Efficiency Advanced Audio Coding<\/note><note>flac<\/strong>: Free Lossless Audio Codec<\/note><note>mp3<\/strong>: MPEG-1 Audio Layer III<\/note><note>vorbis<\/strong>: Open-source audio compression format<\/note><note>copy<\/strong>: Uncompressed, lossless audio codec<\/note><note>opus<\/strong>: Versatile audio codec<\/note>","example":"aac"},"audio_channel":{"title":"audio_channel","enum":["mono_1_0","stereo_2_0","stereo_2_1","surround_4_1","surround_5_1","surround_6_1","surround_7_1"],"type":"array","items":{"type":"string","title":"audio_channel","description":"The audio channel<note>mono_1_0<\/strong>: Single-channel audio<\/note><note>stereo_2_0<\/strong>: Two-channel audio<\/note><note>stereo_2_1<\/strong>: Two-channel audio with subwoofer<\/note><note>surround_4_1<\/strong>: Four-channel audio with subwoofer<\/note><note>surround_5_1<\/strong>: Six-channel audio (5 speakers + subwoofer)<\/note><note>surround_6_1<\/strong>: Seven-channel audio (6 speakers + subwoofer)<\/note><note>surround_7_1<\/strong>: Eight-channel audio (7 speakers + subwoofer)<\/note>"},"description":"The audio channel<note>mono_1_0<\/strong>: Single-channel audio<\/note><note>stereo_2_0<\/strong>: Two-channel audio<\/note><note>stereo_2_1<\/strong>: Two-channel audio with subwoofer<\/note><note>surround_4_1<\/strong>: Four-channel audio with subwoofer<\/note><note>surround_5_1<\/strong>: Six-channel audio (5 speakers + subwoofer)<\/note><note>surround_6_1<\/strong>: Seven-channel audio (6 speakers + subwoofer)<\/note><note>surround_7_1<\/strong>: Eight-channel audio (7 speakers + subwoofer)<\/note>","example":"mono_1_0"},"streams":{"title":"streams","type":"array","items":{"$ref":"#\/components\/schemas\/506dc7b6_Stream_3370c276"},"description":"The streams associated with Stream"},"created_at":{"title":"created_at","type":"integer","description":"The date and time when the Stream was created","format":"timestamp","example":2022},"updated_at":{"title":"updated_at","type":"integer","description":"The date and time when the Stream was updated","format":"timestamp","example":2022}}},"506dc7b6_Stream_3370c276":{"title":"Stream","required":["id"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the Stream","example":"1jhvl2upzafkt"},"video_bitrate":{"title":"video_bitrate","type":"integer","description":"The video bitrate of the Stream stream"},"video_width":{"title":"video_width","type":"integer","description":"The video width of the Stream stream"},"video_height":{"title":"video_height","type":"integer","description":"The video height of the Stream stream"},"audio_bitrate":{"title":"audio_bitrate","type":"integer","description":"The audio bitrate of the Stream stream"},"audio_sampling":{"title":"audio_sampling","type":"integer","description":"The audio sampling rate of the Stream stream"},"source":{"title":"source","type":"string","description":"The source of the Stream","example":"https:\/\/play.vod2.infomaniak.com\/hls\/1jhvl2uqbr5v0\/1jhvl2uqbjke0\/1jhvl2uqbr5v0.mp4"}}},"506dc7b6_Playlist":{"title":"Playlist","required":["chapter_style","mode","name","nav_position","prepend","show_controls","show_media_info","show_media_thumbnail","sort","type"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"The name of the Playlist","example":"my product"},"description":{"title":"description","type":"string","description":"The description of the Playlist","example":"Wow, such a nice Playlist !"},"type":{"title":"type","enum":["dynamic","static"],"type":"object","oneOf":[{"title":"string","type":"string"},{"title":"string[]"}],"description":"Playlist type<note>static<\/strong>: Allows only media to be added to the playlist<\/note><note>dynamic<\/strong>: Add a folder to the playlist: all subsequent media added\/removed will be synced to the playlist<\/note>","example":"static"},"mode":{"title":"mode","enum":["live","merge","split"],"type":"object","oneOf":[{"title":"string","type":"string"},{"title":"string[]"}],"description":"Playlist mode (changes progressbar behaviour)<note>merge<\/strong>: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media<\/note><note>split<\/strong>: Each media will be played individually: the progress-bar will be independent for each media<\/note><note>live<\/strong>: The playlist will act as a live streaming: no scrubbing will be allowed<\/note>","example":"merge"},"sort":{"title":"sort","enum":["auto","created_asc","created_desc","duration_asc","duration_desc","manual","name_asc","name_desc","random","views_asc","views_desc"],"type":"object","oneOf":[{"title":"string","type":"string"},{"title":"string[]"}],"description":"Playlist order criterion<note>auto<\/strong>: Sorted automatically<\/note><note>created_asc<\/strong>: By creation date in ascending order<\/note><note>created_desc<\/strong>: By creation date in descending order<\/note><note>name_asc<\/strong>: By name in ascending order<\/note><note>name_desc<\/strong>: By name in descending order<\/note><note>duration_asc<\/strong>: By duration in ascending order<\/note><note>duration_desc<\/strong>: By duration in descending order<\/note><note>views_asc<\/strong>: By views in ascending order<\/note><note>views_desc<\/strong>: By views in descending order<\/note><note>random<\/strong>: Randomly sorted<\/note><note>manual<\/strong>: Manually sorted<\/note>","example":"auto"},"image":{"title":"image","type":"string","description":"The playlist image link","example":"\/2\/vod\/playlists\/1jhvl2uqfw8ue.jpe"},"prepend":{"title":"prepend","type":"boolean","description":"Prepend media instead of appending them","example":true},"auto_add_media_by_name":{"title":"auto_add_media_by_name","type":"array","description":"When a new media with name containing one of the configured values is uploaded, automatically add it to the playlist","example":"[\"holidays\", \"sea\"]"},"auto_add_media_by_description":{"title":"auto_add_media_by_description","type":"array","description":"When a new media with description containing one of the configured values is uploaded, automatically add it to the playlist","example":"[\"holidays\", \"sea\"]"},"show_media_thumbnail":{"title":"show_media_thumbnail","type":"boolean","description":"Show media thumbnail","example":true},"show_media_info":{"title":"show_media_info","type":"boolean","description":"Show media info","example":true},"nav_position":{"title":"nav_position","enum":["above","below"],"type":"object","oneOf":[{"title":"string","type":"string"},{"title":"string[]"}],"description":"Playlist nav position<note>above<\/strong>: Controls are placed above the playlist<\/note><note>below<\/strong>: Controls are placed below the playlist<\/note>","example":"above"},"chapter_style":{"title":"chapter_style","enum":["dark","light"],"type":"object","oneOf":[{"title":"string","type":"string"},{"title":"string[]"}],"description":"Playlist chapter style<note>dark<\/strong>: Darker colors<\/note><note>light<\/strong>: Lighter colors<\/note>","example":"dark"},"show_controls":{"title":"show_controls","type":"boolean","description":"Indicates whether controls should be shown for the Playlist","example":true}}},"506dc7b6_Media":{"title":"Media","required":["duration","id","title"],"type":"object","properties":{"next_media_offset":{"title":"next_media_offset","type":"number"},"skip_intro_offset":{"title":"skip_intro_offset","type":"number"},"id":{"title":"id","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"The unique identifier of the Media","example":"1jhvl2upzafkt"},"title":{"title":"title","type":"string","description":"The title of the Media","example":"Burn Butcher Burn !"},"duration":{"title":"duration","type":"string","description":"The duration of the Media","example":"00:04:52.62"},"single":{"title":"single","type":"string"},"source":{"title":"source","type":"string","description":"The media playback link.<br\/><note>May return 403 error if protected.<\/note>","example":"https:\/\/play.vod2.infomaniak.com\/hls\/1jhvl2uqbr5v0\/1jhvl2uqbjke0\/1jhvl2uqbr5v0.mp4"},"description":{"title":"description","type":"string","description":"The description of the Media","example":"Wow, such a nice Media !"},"thumbnails":{"$ref":"#\/components\/schemas\/506dc7b6_Mediathumbnailslinks"},"subtitles":{"title":"subtitles","type":"array","items":{"$ref":"#\/components\/schemas\/506dc7b6_Subtitle"},"description":"Media subtitles list (if available)"},"chapters":{"title":"chapters","type":"string","description":"Chapters or segments within the Media","example":"https:\/\/api.infomaniak.com\/2\/vod\/res\/media\/1jhvl2uqbr57z\/chapters.vtt"},"side_data_list":{"title":"side_data_list","type":"array","items":{"type":"string","title":"side_data_list"}},"suggestions":{"title":"suggestions","type":"string","description":"a list media sources to play at the end of current media"}}},"78d6c681_Group":{"title":"Group","required":["id","name","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Group`"},"name":{"title":"name","type":"string","description":"Name of the resource `Group`"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Group` has been updated","format":"timestamp"},"subscribed_count":{"title":"subscribed_count","type":"string"},"statistics":{"title":"statistics","required":["click_rate","open_rate"],"type":"object","properties":{"open_rate":{"title":"open_rate","type":"number","description":"value between 0-100"},"click_rate":{"title":"click_rate","type":"number","description":"value between 0-100"}}},"domain":{"title":"Unique identifier","type":"string","description":"Unique identifier of the `Domain` to request"}}},"78d6c681_Source":{"title":"Source","required":["created_at","id","ip","sourceable_id","sourceable_type","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Source`"},"sourceable_type":{"title":"sourceable_type","type":"string"},"sourceable_id":{"title":"sourceable_id","type":"integer"},"type":{"title":"type","type":"integer"},"ip":{"title":"ip","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Source` has been created","format":"timestamp"}}},"78d6c681_Field":{"title":"Field","required":["id","key","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Field`"},"name":{"title":"name","type":"string","description":"Name of the resource `Field`"},"key":{"title":"key","type":"string"},"value":{"title":"value","type":"string"}}},"a57c9d69_Liveressource":{"title":"Live ressource","required":["application_instance","bytes_in","bytes_in_rate","bytes_out","bytes_out_rate","server_name","total_connections"],"type":"object","properties":{"server_name":{"title":"server_name","type":"string"},"application_instance":{"title":"application_instance","type":"string"},"bytes_in":{"title":"bytes_in","type":"integer"},"bytes_out":{"title":"bytes_out","type":"integer"},"bytes_in_rate":{"title":"bytes_in_rate","type":"integer"},"bytes_out_rate":{"title":"bytes_out_rate","type":"integer"},"total_connections":{"title":"total_connections","type":"integer"}}},"a57c9d69_Fieldresource":{"title":"Field resource","required":["from","to","value"],"type":"object","properties":{"value":{"title":"value","type":"number","description":"the current monthly consumption (Byte)"},"from":{"title":"from","type":"integer","description":"Timestamp `Field resource` from","format":"datetime"},"to":{"title":"to","type":"integer","description":"Timestamp `Field resource` to","format":"datetime"}}},"a57c9d69_stream":{"title":"stream","required":["audio_bitrate","audio_codec","channel","created_at","frame_rate","instant_connection","interrupted","interrupted_at","keyframe_rate","language","original_stream_id","pass","published","recording_config_id","rendered","resolution","restrictions_id","stream_id","transcoding_option_id","url","username","video_bitrate"],"type":"object","properties":{"stream_id":{"title":"stream_id","type":"string","description":"Unique identifier of the `stream` that is related to the resource `stream`"},"original_stream_id":{"title":"original_stream_id","type":"string"},"rendered":{"title":"rendered","type":"boolean"},"transcoding_option_id":{"title":"transcoding_option_id","type":"integer","description":"Unique identifier of the `Option transcoding` that is related to the resource `stream`"},"url":{"title":"url","type":"string"},"audio_bitrate":{"title":"audio_bitrate","type":"integer"},"video_bitrate":{"title":"video_bitrate","type":"integer"},"language":{"title":"language","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `stream` has been created","format":"datetime"},"interrupted_at":{"title":"interrupted_at","type":"integer","description":"Timestamp `stream` has been interrupted","format":"datetime"},"restrictions_id":{"title":"restrictions_id","type":"integer","description":"Unique identifier of the `restriction` that is related to the resource `stream`"},"published":{"title":"published","type":"boolean"},"resolution":{"title":"resolution","type":"integer"},"recording_config_id":{"title":"recording_config_id","type":"integer","description":"Unique identifier of the `recording config` that is related to the resource `stream`"},"username":{"title":"username","type":"string"},"pass":{"title":"pass","type":"string"},"interrupted":{"title":"interrupted","type":"boolean"},"audio_codec":{"title":"audio_codec","type":"string"},"frame_rate":{"title":"frame_rate","type":"string"},"keyframe_rate":{"title":"keyframe_rate","type":"integer"},"instant_connection":{"title":"instant_connection","type":"integer"},"channel":{"$ref":"#\/components\/schemas\/a57c9d69_Channel"}}},"a57c9d69_ViewersRestrictions":{"title":"ViewersRestrictions","required":["access_country","allow_domain","authorize_country","exception_ip","forbidden_ip","player_token","restrictions_id","shared_key"],"type":"object","properties":{"restrictions_id":{"title":"restrictions_id","type":"integer","description":"Unique identifier of the `restriction` that is related to the resource `ViewersRestrictions`"},"access_country":{"title":"access_country","type":"string"},"allow_domain":{"title":"allow_domain","type":"string"},"exception_ip":{"title":"exception_ip","type":"string"},"forbidden_ip":{"title":"forbidden_ip","type":"string"},"shared_key":{"title":"shared_key","type":"string"},"authorize_country":{"title":"authorize_country","type":"boolean"},"player_token":{"title":"player_token","type":"string"}}},"a57c9d69_Machine":{"title":"Machine","required":["ip","name","pool_id","type","url","url_domain"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of the resource `Machine`"},"ip":{"title":"ip","type":"string"},"url":{"title":"url","type":"string"},"type":{"title":"type","enum":["edge","load-balancer","master","recorder","time-shifter","transcoder"],"type":"string","description":"Type of server"},"pool_id":{"title":"pool_id","enum":["1","2"],"type":"integer"},"url_domain":{"title":"url_domain","type":"string"}}},"a57c9d69_Player":{"title":"Player","required":["ads_enabled","ads_url","allow_full_screen","auto_hide_controls","auto_start","buffer","chromecast","control_active_color","control_color","controlbar_color","countdown","countdown_days","countdown_hours","countdown_minutes","countdown_seconds","countdown_txt","created_at","description","enable_embed_code","enable_facebook","enable_twitter","extract_preload_img","facebook_back_link","facebook_player_embed","geo_ip_img","height","interrupt_img","is360","logo_anchor","logo_img","logo_margin_left","logo_margin_top","logo_percentage","name","player_id","preload_img","ratio","restrict_img","show_controls","show_controls_during_ads","show_logo","show_viewers","show_viewers_after","show_viewers_only_after","sound_enabled","sound_percentage","stereo_projection360","time_before_hide_cb","title","twitter_back_link","twitter_related","twitter_via","updated_at","use_geo_ip_img","use_interrupt_img","use_preload_img","use_restrict_img","width"],"type":"object","properties":{"player_id":{"title":"player_id","type":"integer","description":"Unique identifier of the `player` that is related to the resource `Player`"},"name":{"title":"name","type":"string","description":"Name of the ressource `Player` visible by final customer","example":"MyRadioPlayer"},"title":{"title":"title","type":"string","description":"Name of the video stream"},"description":{"title":"description","type":"string","description":"Description of the stream"},"buffer":{"title":"buffer","type":"string","description":"Buffer memory enables the reduction of video interruptions if yours viewers connections become unstable by preloading"},"auto_start":{"title":"auto_start","type":"boolean","description":"Start the video automatically (does not function on Android and iOS)"},"allow_full_screen":{"title":"allow_full_screen","type":"boolean","description":"Authorise full-screen mode"},"is360":{"title":"is360","type":"boolean","description":"This option is required to display your 360 video streaming"},"show_controls":{"title":"show_controls","type":"boolean","description":"Display the playback bar"},"auto_hide_controls":{"title":"auto_hide_controls","type":"boolean","description":"Hide the playback bar after a few seconds"},"time_before_hide_cb":{"title":"time_before_hide_cb","type":"integer"},"show_viewers":{"title":"show_viewers","type":"boolean","description":"Display the number of viewers"},"show_viewers_after":{"title":"show_viewers_after","type":"integer","description":"Display from the following number after {number} viewers"},"ratio":{"title":"ratio","type":"string","description":"Ratio of the player"},"width":{"title":"width","type":"integer","description":"The width used for render the `Player` (px)","example":1280},"height":{"title":"height","type":"integer","description":"The height used for render the `Player` (px)","example":720},"show_logo":{"title":"show_logo","type":"boolean","description":"Is the logo Infomaniak enabled?","example":true},"logo_img":{"title":"logo_img","type":"string","description":"The logo url of the `Player`","example":"https:\/\/static.infomaniak.ch\/configvideo\/video-streaming-v2\/private\/{channel}\/players\/{player}\/logo.png"},"logo_anchor":{"title":"logo_anchor","enum":["bottom left","bottom right","top left","top right"],"type":"string","description":"is the position of logo"},"logo_percentage":{"title":"logo_percentage","type":"integer","description":"The logo size in `Player`","example":50},"logo_margin_top":{"title":"logo_margin_top","type":"integer","description":"The margin top log in `Player`","example":50},"logo_margin_left":{"title":"logo_margin_left","type":"integer","description":"The margin left log in `Player`","example":50},"control_color":{"title":"control_color","type":"string","description":"The background color used in the `Player`","example":"#FFFFFF"},"controlbar_color":{"title":"controlbar_color","type":"string","description":"The button color used in the `Player`","example":"#000000"},"control_active_color":{"title":"control_active_color","type":"string","description":"The secondary color color used in the `Player`","example":"#0098FF"},"extract_preload_img":{"title":"extract_preload_img","type":"boolean"},"use_preload_img":{"title":"use_preload_img","type":"boolean","description":"This image is displayed before the video is played.","example":true},"preload_img":{"title":"preload_img","type":"string"},"use_geo_ip_img":{"title":"use_geo_ip_img","type":"boolean"},"geo_ip_img":{"title":"geo_ip_img","type":"string"},"use_interrupt_img":{"title":"use_interrupt_img","type":"boolean"},"interrupt_img":{"title":"interrupt_img","type":"string","description":"This image is displayed if the viewer is not authorised to view the broadcast (IP, domain, unique hash code, etc.)","example":"https:\/\/static.infomaniak.ch\/configvideo\/video-streaming-v2\/private\/{channel}\/players\/{player}\/interrupted.png"},"use_restrict_img":{"title":"use_restrict_img","type":"boolean","description":"This image is displayed if the viewer is located in an unauthorised geographic","example":true},"restrict_img":{"title":"restrict_img","type":"string","description":"This image is displayed if the viewer is not authorised to view the broadcast (IP, domain, unique hash code, etc.)","example":"https:\/\/static.infomaniak.ch\/configvideo\/video-streaming-v2\/private\/{channel}\/players\/{player}\/unauthorized.png"},"countdown":{"title":"countdown","type":"boolean","description":"Is the countdown enabled?"},"countdown_txt":{"title":"countdown_txt","type":"string","description":"Description of the countdown of the `Player` visible by final customer"},"countdown_days":{"title":"countdown_days","type":"string","description":"countdown days"},"countdown_hours":{"title":"countdown_hours","type":"string","description":"hours days"},"countdown_minutes":{"title":"countdown_minutes","type":"string","description":"countdown minutes"},"countdown_seconds":{"title":"countdown_seconds","type":"string","description":"countdown seconde"},"enable_embed_code":{"title":"enable_embed_code","type":"boolean","description":"Authorise other users to intergrate your live event on their sites"},"enable_facebook":{"title":"enable_facebook","type":"boolean","description":"Is the facebook embed link visible?","example":true},"facebook_back_link":{"title":"facebook_back_link","type":"string","description":"The Twitter backlink used to facebook embed","example":"my-lovely-stream.ch"},"facebook_player_embed":{"title":"facebook_player_embed","type":"boolean"},"enable_twitter":{"title":"enable_twitter","type":"boolean","description":"Is the Twitter embed link visible?","example":true},"twitter_via":{"title":"twitter_via","type":"string","example":"MyAccount"},"twitter_back_link":{"title":"twitter_back_link","type":"string","description":"The Twitter backlink used to twitter embed","example":"my-lovely-stream.ch"},"twitter_related":{"title":"twitter_related","type":"string","description":"The Twitter hashtag used to Twitter embed","example":"infomaniak video live"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Player` has been created","format":"datetime"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Player` has been updated","format":"datetime"},"ads_enabled":{"title":"ads_enabled","type":"boolean","description":"Is the ads enabled?","example":true},"show_controls_during_ads":{"title":"show_controls_during_ads","type":"boolean","description":"Display the playback bar during the ads"},"sound_enabled":{"title":"sound_enabled","type":"boolean","description":"Is the sound enabled?","example":true},"sound_percentage":{"title":"sound_percentage","type":"integer","description":"The volume used in the `Player`","example":50},"show_viewers_only_after":{"title":"show_viewers_only_after","type":"boolean"},"chromecast":{"title":"chromecast","type":"boolean","description":"you need to use a player that supports https in order for chromecast to work correctly"},"stereo_projection360":{"title":"stereo_projection360","type":"string"},"ads_url":{"title":"ads_url","type":"string","description":"The ads url"},"interrupted":{"title":"interrupted","type":"boolean","description":"There is an event currently interrupting the live;"},"channel":{"$ref":"#\/components\/schemas\/a57c9d69_Channel"},"integrations":{"title":"integrations","type":"array","items":{"$ref":"#\/components\/schemas\/a57c9d69_Integrationsressource"},"description":"List all the raw integrations supported for the given channel."},"countdown_stops_at":{"title":"countdown_stops_at","type":"string"},"thumbnail_url":{"title":"thumbnail_url","type":"string"},"restrictions":{"title":"restrictions","type":"string"},"ads":{"title":"ads","type":"string"}}},"a57c9d69_Channel":{"title":"Channel","required":["blocked","blocked_at","channel_id","created_at","customer_name","deleted","deleted_at","free","id","is_pulled","maintained","maintained_at","name","parent_id","real_type","remember_to_config","service_id","source_type","type","unique_id","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Unique identifier of the resource `Channel`","example":"1"},"unique_id":{"title":"unique_id","type":"integer","description":"Unique identifier of the resource `Channel`"},"channel_id":{"title":"channel_id","type":"integer","description":"Unique identifier of the `channel` that is related to the resource `Channel`","example":69001},"name":{"title":"name","type":"string","description":"Name of the resource `Channel`"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Channel` has been created","format":"datetime"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Channel` has been updated","format":"datetime"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `Channel` has been deleted","format":"datetime"},"deleted":{"title":"deleted","type":"boolean","description":"Boolean `Channel` has been deleted"},"type":{"title":"type","enum":["abr","mono"],"type":"string"},"source_type":{"title":"source_type","enum":["camip","encoder","maniak","mobile","webcam"],"type":"string"},"remember_to_config":{"title":"remember_to_config","type":"boolean"},"free":{"title":"free","type":"boolean"},"blocked":{"title":"blocked","type":"boolean"},"maintained":{"title":"maintained","type":"boolean"},"blocked_at":{"title":"blocked_at","type":"integer","format":"datetime"},"maintained_at":{"title":"maintained_at","type":"integer","format":"datetime"},"is_pulled":{"title":"is_pulled","type":"boolean"},"service_id":{"title":"service_id","type":"integer","description":"Unique identifier of the `service` that is related to the resource `Channel`"},"customer_name":{"title":"customer_name","type":"string","description":"Customer name of the resource `Channel`"},"parent_id":{"title":"parent_id","type":"integer"},"tags":{"title":"tags","type":"string"},"rights":{"title":"rights","type":"string"},"live":{"$ref":"#\/components\/schemas\/a57c9d69_Liveressource"},"real_type":{"title":"real_type","type":"string"},"status":{"title":"status","type":"array","description":"Status of the resource `Channel`"},"consumption":{"$ref":"#\/components\/schemas\/a57c9d69_Fieldresource"},"recording_status":{"title":"recording_status","type":"string"},"options_orders":{"title":"options_orders","type":"string"},"options":{"title":"options","type":"array"},"default_options":{"title":"default_options","type":"array"},"streams":{"title":"streams","type":"array","items":{"$ref":"#\/components\/schemas\/a57c9d69_stream"}},"restriction":{"$ref":"#\/components\/schemas\/a57c9d69_ViewersRestrictions"},"machines":{"title":"machines","type":"array","items":{"$ref":"#\/components\/schemas\/a57c9d69_Machine"}},"players":{"title":"players","type":"array","items":{"$ref":"#\/components\/schemas\/a57c9d69_Player"}},"order":{"title":"order","type":"string"},"account":{"title":"account","type":"string"},"pool":{"title":"pool","type":"string"}}},"a57c9d69_Integrationsressource":{"title":"Integrations ressource","required":["constant_url","dvr_available","dvr_enabled","stream_id","type","url"],"type":"object","properties":{"type":{"title":"type","type":"string","example":"hls"},"url":{"title":"url","type":"string","example":"https:\/\/maniak_tv.vedge.infomaniak.com\/livecast\/ik:maniak_tv\/manifest.f4m"},"constant_url":{"title":"constant_url","type":"boolean"},"stream_id":{"title":"stream_id","type":"string","description":"Unique identifier of the `stream` that is related to the resource `Integrations ressource`","example":"maniak_tv"},"dvr_available":{"title":"dvr_available","type":"boolean"},"dvr_enabled":{"title":"dvr_enabled","type":"boolean"}}},"a57c9d69_Pack":{"title":"Pack","required":["available_space_vod","hide","id","max_auditors","name","order_info"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Pack`","example":1},"name":{"title":"name","type":"string","description":"Name of the resource `Pack`","example":"Pro"},"order_info":{"title":"order_info","type":"integer"},"available_space_vod":{"title":"available_space_vod","type":"integer","description":"The archive storage space, is in GB","example":100},"max_auditors":{"title":"max_auditors","type":"integer","description":"The max 'auditors' available."},"hide":{"title":"hide","type":"boolean","description":"Pack available"},"details":{"title":"details","type":"string"}}},"a57c9d69_Periodicity":{"title":"Periodicity","required":["id","unite","value"],"type":"object","properties":{"id":{"title":"Unique identifier","enum":["1","2"],"type":"integer","description":"Unique identifier of the resource `Periodicity`","example":1},"unite":{"title":"unite","type":"integer"},"value":{"title":"value","enum":["MONTH","YEAR"],"type":"string","description":"The `PackPrice` time range","example":"MONTH"}}},"a57c9d69_VodProduct":{"title":"VodProduct","required":["name","vod_id"],"type":"object","properties":{"vod_id":{"title":"vod_id","type":"integer","description":"Unique identifier of the `vodProduct` that is related to the resource `VodProduct`","example":1980},"name":{"title":"name","type":"string","description":"Name of the resource `VodProduct`"}}},"a57c9d69_Account":{"title":"Account","required":["beta","created_at","id","language_id","legal_entity_type","locale","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Account`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Account`","example":"Secret Organization"},"legal_entity_type":{"title":"legal_entity_type","enum":["company","individual","public_body","restrict"],"type":"string","example":"company"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Account` has been created","format":"timestamp","example":1294959600},"addresses":{"title":"addresses","type":"array","items":{"$ref":"#\/components\/schemas\/a57c9d69_Accountaddress"}},"timezone":{"title":"timezone","type":"string","example":"Europe\/Zurich"},"website":{"title":"website","type":"string","example":"https:\/\/www.infomaniak.com"},"phone":{"title":"phone","type":"string","example":"+41790000000"},"fax":{"title":"fax","type":"string","example":"+41220000000"},"language":{"title":"language","type":"string"},"locale":{"title":"locale","type":"string","description":"Represents a language identifier and a region identifier","example":"fr_FR"},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `Account`","example":1},"logo":{"title":"logo","type":"string","example":"https:\/\/www.infomaniak.com\/img\/common\/logo-infomaniak.svg"},"order":{"title":"order","required":["blocked_order_id","in_process","waiting_payment"],"type":"object","properties":{"waiting_payment":{"title":"waiting_payment","type":"integer","example":1},"in_process":{"title":"in_process","type":"integer"},"blocked_order_id":{"title":"blocked_order_id","type":"array"}}},"beta":{"title":"beta","type":"boolean","example":true},"type":{"title":"type","type":"string","example":"owner"},"billing":{"title":"billing","type":"boolean","example":true},"mailing":{"title":"mailing","type":"boolean","example":true},"billing_mailing":{"title":"billing_mailing","type":"boolean","example":true},"workspace_only":{"title":"workspace_only","type":"boolean","example":true},"no_access":{"title":"no_access","type":"boolean","example":true},"is_blocked":{"title":"is_blocked","type":"boolean","example":true},"blocked_at":{"title":"blocked_at","type":"integer","format":"timestamp"},"vat_number":{"title":"vat_number","type":"string"},"field1":{"title":"field1","type":"string"},"field2":{"title":"field2","type":"string"},"tags":{"title":"tags","type":"array","items":{"$ref":"#\/components\/schemas\/a57c9d69_Tag"}},"services_already_demo":{"title":"services_already_demo","type":"array"},"customization_url":{"title":"customization_url","type":"object"},"nb_invitations":{"title":"nb_invitations","type":"integer","example":2},"nb_users":{"title":"nb_users","type":"integer","example":2}}},"a57c9d69_Accountaddress":{"title":"Account address","required":["city","country","created_at","id","street","street2","type","zip"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Account address`","example":1234},"street":{"title":"street","type":"string","example":"Rue Eug\u00e8ne-Marziano 25"},"street2":{"title":"street2","type":"string"},"zip":{"title":"zip","type":"string","example":"1227"},"city":{"title":"city","type":"string","example":"Gen\u00e8ve"},"type":{"title":"type","type":"string","example":"professional"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Account address` has been created","format":"timestamp","example":1558601584},"country":{"$ref":"#\/components\/schemas\/a57c9d69_Geolocationressource"},"for_invoice":{"title":"for_invoice","type":"boolean"}}},"a57c9d69_Tag":{"title":"Tag","required":["color","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Tag`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Tag`","example":"My tag name"},"color":{"title":"color","type":"integer","example":4},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource `Tag`","example":2}}},"a57c9d69_Geolocationressource":{"title":"Geolocation ressource","required":["from","locations","to"],"type":"object","properties":{"locations":{"title":"locations","type":"array"},"from":{"title":"from","type":"integer","description":"Timestamp `Geolocation ressource` from","format":"datetime"},"to":{"title":"to","type":"integer","description":"Timestamp `Geolocation ressource` to","format":"datetime"}}},"a57c9d69_Record":{"title":"Record","required":["auto","deleted_at","diffused_at","diffusion_ended_at","diffusion_ends_at","end","file_path","fragment_duration","fragment_number","instant","name","record_id","record_type","state","stream_id"],"type":"object","properties":{"record_id":{"title":"record_id","type":"integer"},"stream_id":{"title":"stream_id","type":"string","description":"Unique identifier of the `stream` that is related to the resource `Record`"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `Record` has been deleted","format":"datetime"},"diffused_at":{"title":"diffused_at","type":"integer","format":"datetime"},"diffusion_ends_at":{"title":"diffusion_ends_at","type":"integer","format":"datetime"},"diffusion_ended_at":{"title":"diffusion_ended_at","type":"integer","format":"datetime"},"name":{"title":"name","type":"string","description":"Name of the resource `Record`"},"file_path":{"title":"file_path","type":"string"},"state":{"title":"state","type":"integer"},"fragment_duration":{"title":"fragment_duration","type":"integer"},"fragment_number":{"title":"fragment_number","type":"integer"},"end":{"title":"end","type":"string"},"auto":{"title":"auto","type":"string"},"instant":{"title":"instant","type":"string"},"record_type":{"title":"record_type","type":"string"},"storage_machine":{"title":"storage_machine","type":"string"}}},"a57c9d69_EncoderPreset":{"title":"EncoderPreset","required":["audio_bitrate","audio_codec","crop_bottom","crop_left","crop_right","crop_top","enabled","encoder_preset_id","encoding_implementation","fit_mode","gpu_id","height","key_frame_interval","name","profile","stream_id","template_id","video_bitrate","video_codec","width"],"type":"object","properties":{"encoder_preset_id":{"title":"encoder_preset_id","type":"integer"},"stream_id":{"title":"stream_id","type":"string","description":"Unique identifier of the `stream` that is related to the resource `EncoderPreset`"},"template_id":{"title":"template_id","type":"integer"},"name":{"title":"name","type":"string","description":"Name of the resource `EncoderPreset`"},"enabled":{"title":"enabled","type":"boolean"},"video_bitrate":{"title":"video_bitrate","type":"integer"},"audio_bitrate":{"title":"audio_bitrate","type":"integer"},"video_codec":{"title":"video_codec","type":"string"},"audio_codec":{"title":"audio_codec","type":"string"},"encoding_implementation":{"title":"encoding_implementation","type":"string"},"gpu_id":{"title":"gpu_id","type":"integer"},"profile":{"title":"profile","type":"string"},"key_frame_interval":{"title":"key_frame_interval","type":"integer"},"fit_mode":{"title":"fit_mode","type":"string"},"width":{"title":"width","type":"integer"},"height":{"title":"height","type":"integer"},"crop_top":{"title":"crop_top","type":"integer"},"crop_bottom":{"title":"crop_bottom","type":"integer"},"crop_left":{"title":"crop_left","type":"integer"},"crop_right":{"title":"crop_right","type":"integer"}}},"daf7713c_Tag":{"title":"Tag","required":["color","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Tag`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Tag`","example":"My tag name"},"color":{"title":"color","type":"integer","example":4},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource `Tag`","example":2}}},"daf7713c_Right":{"title":"Right","type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"statistic":{"title":"statistic","type":"boolean"},"check":{"title":"check","type":"boolean"},"sale":{"title":"sale","type":"boolean"}}},"daf7713c_Productstatus":{"title":"Product status","required":["activated_at","activated_by","infomaniak","locked","maintenance","superuser","technical"],"type":"object","properties":{"maintenance":{"title":"maintenance","type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"superuser":{"title":"superuser","type":"boolean"},"infomaniak":{"title":"infomaniak","type":"boolean"}}},"locked":{"title":"locked","type":"object","properties":{"superuser":{"title":"superuser","type":"boolean"},"infomaniak":{"title":"infomaniak","type":"boolean"}},"description":"True if the slot is locked","example":"false"},"activated_by":{"title":"activated_by","type":"array"},"activated_at":{"title":"activated_at","type":"integer","format":"timestamp"}}},"daf7713c_ProductUser":{"title":"ProductUser","required":["rights","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer"},"rights":{"$ref":"#\/components\/schemas\/daf7713c_Right","schema":[]}}},"daf7713c_SwissBackupPrice":{"title":"Swiss Backup Price","required":["amount","amount_excl_vat","currency","type","unit"],"type":"object","properties":{"type":{"title":"type","type":"string","description":"Type of the resource `Swiss Backup Price`","example":"slot"},"unit":{"title":"unit","type":"integer","example":1},"currency":{"title":"currency","type":"integer","example":1},"amount":{"title":"amount","type":"string","description":"Amount incl. VAT","example":"2.000"},"amount_excl_vat":{"title":"amount_excl_vat","type":"string","description":"Amount excl. VAT","example":"1.860"}}},"daf7713c_SwissBackupDiscount":{"title":"Swiss Backup Discount","required":["label","periodicity","value"],"type":"object","properties":{"label":{"title":"label","type":"string","example":"2_years"},"periodicity":{"title":"periodicity","type":"integer","description":"Commitment period (in years)","example":2},"value":{"title":"value","type":"integer","example":20}}},"8183272b_ClusterConfig":{"title":"ClusterConfig","required":["created_at","id","updated_at","version"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `ClusterConfig`","example":1},"version":{"title":"version","type":"string"},"content_master":{"title":"content_master","type":"string","description":"The config's content for the master","example":"AnXmlConfig"},"content_edge":{"title":"content_edge","type":"string","description":"The config's content for the edges","example":"AnXmlConfig"},"clusters":{"title":"clusters","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Cluster"},"description":"The cluster that are using this configuration"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `ClusterConfig` has been created","format":"timestamp","example":1526917460},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `ClusterConfig` has been updated","format":"timestamp","example":1745004319},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `ClusterConfig` has been deleted","format":"timestamp","example":1438844169}}},"8183272b_Station":{"title":"Station","required":["cluster_name","cluster_type","created_at","deleted_at","id","is_daily_restart","is_enabled","is_send_logs","log_login","log_path","log_server","name","thumbnail","time_daily_restart","timezone_daily_restart","updated_at","uuid"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Station`","example":1},"uuid":{"title":"uuid","type":"string","description":"Universally unique identifier of the resource `Station`","example":"b3ff3bf9-c390-4dfe-9341-5e3a5e408bc2"},"name":{"title":"name","type":"string","description":"Name of the resource `Station`","example":"MyStation"},"subdomain":{"title":"subdomain","type":"string","description":"The subdomain of the station","example":"mysubdomain"},"thumbnail":{"title":"thumbnail","type":"string","description":"The url to the thumbnail of the `Station`","example":"https:\/\/storage.infomaniak.com\/my-thumbnail.png"},"is_daily_restart":{"title":"is_daily_restart","type":"boolean","description":"Is the daily restart enabled?","example":true},"time_daily_restart":{"title":"time_daily_restart","type":"string","description":"The time use for daily restart","example":"15:03"},"timezone_daily_restart":{"title":"timezone_daily_restart","type":"string","description":"The timezone to use for daily restart","example":"Europe\/Zurich"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Is the resource `Station` enabled?","example":true},"is_send_logs":{"title":"is_send_logs","type":"boolean","description":"Is the logs sending enabled?","example":true},"log_server":{"title":"log_server","type":"string","description":"The server name to connect to the log server","example":"my-log-server.ch"},"log_login":{"title":"log_login","type":"string","description":"The login to connect to the log server","example":"MyLogin"},"log_path":{"title":"log_path","type":"string","description":"The path where the log is store","example":"my_log_folder"},"listeners":{"title":"listeners","type":"integer","description":"The number of currently listeners listen all `Stream`","example":152},"monthly_consumption":{"title":"monthly_consumption","type":"integer","description":"The current monthly consumption (Byte)","example":1856473697},"slipping_consumption":{"title":"slipping_consumption","type":"integer","description":"The current monthly slipping consumption (Byte)","example":1856473697},"count_streams_up":{"title":"count_streams_up","type":"integer","description":"The current count of streams online","example":3},"count_active_deal":{"title":"count_active_deal","type":"integer","description":"count streams with deals for the station","example":1},"certified_by":{"title":"certified_by","enum":["acpm","indes","mediapulse"],"type":"object","oneOf":[{"title":"array","type":"array"},{"title":"string[]"}],"description":"Station certified by<note>acpm<\/strong>: Certified by ACPM<\/note><note>mediapulse<\/strong>: Certified by Mediapulse<\/note><note>indes<\/strong>: Certified like ACPM for the independents<\/note>","example":"acpm"},"certified_at":{"title":"certified_at","type":"integer","description":"Last updating date of a certification organisation","format":"timestamp"},"cluster_name":{"title":"cluster_name","type":"string","description":"The name of the `Cluster`","example":"plain"},"cluster_type":{"title":"cluster_type","type":"string","description":"The type of the `Cluster`","example":"plain"},"stats":{"title":"stats","type":"array"},"cluster_migrations":{"title":"cluster_migrations","type":"string","description":"the migrations of the station"},"metadata":{"title":"metadata","type":"array","description":"List last metadata"},"masters":{"title":"masters","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Master"},"description":"List of master servers"},"edges":{"title":"edges","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Edge"},"description":"List of edge servers"},"autodj":{"$ref":"#\/components\/schemas\/8183272b_AutoDJ"},"is_autodj_live":{"title":"is_autodj_live","type":"boolean","description":"Is the `AutoDJ` is in live ?","example":true},"stream_stats":{"title":"stream_stats","type":"string"},"streams":{"title":"streams","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Stream"}},"hls_stream":{"$ref":"#\/components\/schemas\/8183272b_HlsStream"},"players":{"title":"players","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Player"}},"options":{"title":"options","type":"string"},"radio_product":{"title":"radio_product","type":"string","description":"the station's product"},"account":{"title":"account","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Station` has been created","format":"timestamp","example":1526917460},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Station` has been updated","format":"timestamp","example":1745004319},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `Station` has been deleted","format":"timestamp","example":1438844169}}},"8183272b_Edge":{"title":"Edge","required":["created_at","deleted_at","id","ip","is_enabled","updated_at","url"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Edge`","example":1},"url":{"title":"url","type":"string","description":"The url of `Edge` server","example":"https:\/\/icecast.infomaniak.ch"},"ip":{"title":"ip","type":"string","description":"The ip of `Edge` server","example":"127.0.0.1"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Is the resource `Edge` enabled?","example":true},"is_up":{"title":"is_up","type":"boolean","description":"Is the edge up ?","example":true},"cluster":{"$ref":"#\/components\/schemas\/8183272b_Cluster"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Edge` has been created","format":"timestamp","example":1526917460},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Edge` has been updated","format":"timestamp","example":1745004319},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `Edge` has been deleted","format":"timestamp","example":1438844169}}},"8183272b_Master":{"title":"Master","required":["created_at","deleted_at","id","ip","is_enabled","is_service","updated_at","url"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Master`","example":1},"url":{"title":"url","type":"string","description":"The url of `Master` server","example":"master.infomaniak.com"},"ip":{"title":"ip","type":"string","description":"The ip of `Master` server","example":"127.0.0.1"},"is_service":{"title":"is_service","type":"boolean","description":"Is the master of service ?","example":true},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Is the master enabled ?","example":true},"is_up":{"title":"is_up","type":"string","description":"Is the master up ?","example":"true"},"cluster":{"$ref":"#\/components\/schemas\/8183272b_Cluster"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Master` has been created","format":"timestamp","example":1526917460},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Master` has been updated","format":"timestamp","example":1745004319},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `Master` has been deleted","format":"timestamp","example":1438844169}}},"8183272b_Cluster":{"title":"Cluster","required":["id","name","version"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Cluster`","example":1},"name":{"title":"name","type":"string","description":"The name of the ressource `Cluster`","example":"MyCluster"},"master_dns_prefix":{"title":"master_dns_prefix","type":"string","description":"master dns prefixes"},"edge_dns_prefix":{"title":"edge_dns_prefix","type":"string","description":"edge dns prefixes"},"counter":{"title":"counter","type":"integer","description":"cluster counter per pool","example":1},"version":{"title":"version","type":"string","description":"the clusterConfig's version","example":"1.3"},"config_urls":{"title":"config_urls","type":"array","description":"The urls for the used configurations"},"config":{"$ref":"#\/components\/schemas\/8183272b_ClusterConfig"},"stations":{"title":"stations","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Station"},"description":"The stations on the cluster"},"edges":{"title":"edges","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Edge"}},"masters":{"title":"masters","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Master"}},"pool":{"title":"pool","type":"string"}}},"8183272b_AutoDJ":{"title":"AutoDJ","required":["calendar_id","config","created_at","id","updated_at","vod_default_folder_id","vod_fill_mixtape_id","vod_fill_mixtape_type","vod_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Unique identifier of the resource `AutoDJ`","example":"1"},"calendar_id":{"title":"calendar_id","type":"integer","nullable":true},"vod_id":{"title":"vod_id","type":"integer","nullable":true},"vod_default_folder_id":{"title":"vod_default_folder_id","type":"string","nullable":true},"vod_fill_mixtape_id":{"title":"vod_fill_mixtape_id","type":"string","nullable":true},"vod_fill_mixtape_type":{"title":"vod_fill_mixtape_type","type":"string","description":"The type of fill mixtape","nullable":true,"example":"playlist"},"config":{"title":"config","type":"string"},"playlist":{"title":"playlist","type":"array"},"station":{"$ref":"#\/components\/schemas\/8183272b_Station"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `AutoDJ` has been created","format":"timestamp","example":1526917460},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `AutoDJ` has been updated","format":"timestamp","example":1745004319},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `AutoDJ` has been deleted","format":"datetime","example":1438844169}}},"8183272b_Stream":{"title":"Stream","required":["bitrate","codec","country_list","created_at","fallback_id","hash_key","id","introduction_file_url","ip_exclude_list","ip_include_list","is_active_relay","is_allow_country","is_enabled","is_fallback","is_hash_restriction","is_source","is_transcoding","mountpoint","relay_mountpoint","relay_port","relay_server","server_address","updated_at","url","uuid"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Stream`","example":1},"uuid":{"title":"uuid","type":"string","description":"Universally unique identifier of the resource `Stream`","example":"b3ff3bf9-c390-4dfe-9341-5e3a5e408bc2"},"mountpoint":{"title":"mountpoint","type":"string","description":"The mountpoint to access to the `Stream`","example":"\/my-mountpoint.mp3"},"codec":{"title":"codec","enum":["1","2"],"type":"integer","description":"The codec used in the `Stream`","example":1},"bitrate":{"title":"bitrate","type":"integer","description":"The bitrate used in the `Stream`","example":128},"url":{"title":"url","type":"string","description":"The public url to listen the `Stream`","example":"my-radio.infomaniak.com\/my-mounpoint.mp3"},"introduction_file_url":{"title":"introduction_file_url","type":"string","description":"The audio file used before the `Stream` begin","example":"1250.mp3"},"has_active_deal":{"title":"has_active_deal","type":"boolean","description":"Does the stream have an active deal ?"},"server_address":{"title":"server_address","type":"string","description":"The server address to connect encoder","example":"my-radio.infomaniak.com"},"is_active_relay":{"title":"is_active_relay","type":"boolean","description":"Is relay `Stream` enabled?","example":true},"relay_server":{"title":"relay_server","type":"string","description":"The server domain for the relay","example":"my-radio.ch"},"relay_port":{"title":"relay_port","type":"integer","description":"The server port for the relay","example":80},"relay_mountpoint":{"title":"relay_mountpoint","type":"string","description":"The server mountpoint for the relay","example":"\/my-mountpoint.mp3"},"is_hash_restriction":{"title":"is_hash_restriction","type":"boolean","description":"Is hash restriction enabled?","example":true},"hash_key":{"title":"hash_key","type":"string","description":"The hash key used for hash protection","example":"my_hash_key"},"ip_include_list":{"title":"ip_include_list","type":"string","description":"The ip list allows to access to the stream"},"ip_exclude_list":{"title":"ip_exclude_list","type":"string","description":"The ip list not allows to access to the stream"},"is_allow_country":{"title":"is_allow_country","type":"boolean","description":"Define if the stream used the restriction rules"},"country_list":{"title":"country_list","type":"string","description":"The country list not allows to access to the stream"},"is_source":{"title":"is_source","type":"boolean","description":"Is the `Stream` used for `HlsStream` or `Transcoding` as source?","example":true},"is_transcoding":{"title":"is_transcoding","type":"boolean","description":"Is the `Stream` a `Transcoding` stream?","example":true},"is_up":{"title":"is_up","type":"boolean","description":"Is the `Stream` is available?","example":true},"listeners":{"title":"listeners","type":"integer","description":"The number of currently listeners on `Stream`","example":152},"is_fallback":{"title":"is_fallback","type":"boolean","description":"Is the `Stream` is a fallback?","example":true},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Is the resource `Stream` enabled?","example":true},"fallback_id":{"title":"fallback_id","type":"integer","description":"The fallback id attached to this `Stream`","example":1},"station_id":{"title":"station_id","type":"integer"},"station":{"$ref":"#\/components\/schemas\/8183272b_Station"},"hls":{"title":"hls","type":"string"},"fallback":{"title":"fallback","type":"string"},"custom_fields":{"title":"custom_fields","type":"string","description":"Is the `Stream` is available?","example":"true"},"account":{"title":"account","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Stream` has been created","format":"timestamp","example":1526917460},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Stream` has been updated","format":"timestamp","example":1745004319},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `Stream` has been deleted","format":"timestamp","example":1438844169}}},"8183272b_HlsStream":{"title":"HlsStream","required":["bitrates","buffer_size","country_list","created_at","domains","fragment_size","hash_key","id","ip_exclude_list","ip_include_list","is_allow_country","is_allow_cut_midroll","is_force","is_hash_restriction","is_metadata_midroll","is_midroll","is_overwrite_midroll","is_preroll","max_time_midroll","midroll_occurrence","name","source_id","updated_at","url","use_stream_configuration","uuid"],"type":"object","properties":{"use_stream_configuration":{"title":"use_stream_configuration","type":"boolean","description":"Used the soundcast stream configuration?","example":true},"is_preroll":{"title":"is_preroll","type":"boolean","description":"Is the preroll enabled?","example":true},"is_midroll":{"title":"is_midroll","type":"boolean","description":"Is the midroll enabled?","example":true},"midroll_occurrence":{"title":"midroll_occurrence","type":"integer","description":"The number of secondes between each midroll","example":30},"is_metadata_midroll":{"title":"is_metadata_midroll","type":"boolean","description":"Is the metadata detection are enabled for midroll?","example":true},"is_overwrite_midroll":{"title":"is_overwrite_midroll","type":"boolean","description":"Is the overwrite mode are enabled for midroll?","example":true},"is_allow_cut_midroll":{"title":"is_allow_cut_midroll","type":"boolean","description":"Is allow to cut midroll?","example":true},"max_time_midroll":{"title":"max_time_midroll","type":"integer","description":"The max time for midroll","example":30},"is_force":{"title":"is_force","type":"boolean","description":"Is the ads are forced?","example":true},"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `HlsStream`","example":1},"uuid":{"title":"uuid","type":"string","description":"Universally unique identifier of the resource `HlsStream`","example":"b3ff3bf9-c390-4dfe-9341-5e3a5e408bc2"},"name":{"title":"name","type":"string","description":"Define unique name used in url","example":"myHls"},"bitrates":{"title":"bitrates","type":"string","description":"The bitrates used in the `HlsStream`","example":"64,96,128"},"buffer_size":{"title":"buffer_size","type":"integer","description":"The size of the buffer in the `HlsStream`","example":25},"fragment_size":{"title":"fragment_size","type":"integer","description":"The size of the fragment in the `HlsStream` use for buffer size","example":25},"is_hash_restriction":{"title":"is_hash_restriction","type":"boolean","description":"Is hash restriction enabled?","example":true},"hash_key":{"title":"hash_key","type":"string","description":"The hash key used for hash protection","example":"my_hash_key"},"ip_include_list":{"title":"ip_include_list","type":"string","description":"The ip list allows to access to the hls stream"},"ip_exclude_list":{"title":"ip_exclude_list","type":"string","description":"The ip list not allows to access to the hls stream"},"is_allow_country":{"title":"is_allow_country","type":"boolean","description":"Define if the hls stream used the restriction rules"},"country_list":{"title":"country_list","type":"string","description":"The country list not allows to access to the hls stream"},"url":{"title":"url","type":"string","description":"The public url for `HlsStream`","example":"my-hls.infomaniak.com\/my-hls\/manifest.m3u8"},"is_up":{"title":"is_up","type":"boolean","description":"Is the `HlsStream` is online?","example":true},"listeners":{"title":"listeners","type":"integer","description":"The number of currently listeners on `HlsStream`","example":152},"domains":{"title":"domains","type":"string","description":"The list of domains allow to access","example":"infomaniak.com,my-radio.ch"},"source_id":{"title":"source_id","type":"integer","description":"The source `Stream` of the `HlsStream`","example":1},"source_stream":{"$ref":"#\/components\/schemas\/8183272b_Stream"},"station":{"$ref":"#\/components\/schemas\/8183272b_Station"},"players":{"title":"players","type":"array","items":{"$ref":"#\/components\/schemas\/8183272b_Player"}},"account":{"title":"account","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `HlsStream` has been created","format":"timestamp","example":1526917460},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `HlsStream` has been updated","format":"timestamp","example":1745004319},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `HlsStream` has been deleted","format":"timestamp","example":1438844169}}},"8183272b_Player":{"title":"Player","required":["background_color","button_color","created_at","display_name","domains","height","history_display","history_hold","id","iframe","is_auto_start","is_cover","is_direct_control","is_embed","is_facebook_embed","is_history_clickable","is_history_time_display","is_hls_buffered","is_listeners","is_listeners_hold","is_logo","is_metadata_display","is_spectrum","is_station_thumbnail","is_twitter_embed","language","listeners_hold","loading","name","restriction","secondary_color","thumbnail","type","unavailable","updated_at","uuid","volume","width"],"type":"object","properties":{"display_name":{"title":"display_name","type":"string","description":"Name of the ressource `Player` visible by final customer","example":"MyRadioPlayer"},"is_metadata_display":{"title":"is_metadata_display","type":"boolean","description":"Is the metadata title and artist displayed?","example":true},"is_logo":{"title":"is_logo","type":"boolean","description":"Is the logo Infomaniak enabled?","example":true},"is_auto_start":{"title":"is_auto_start","type":"boolean","description":"Is the auto start enabled?","example":true},"volume":{"title":"volume","type":"integer","description":"The volume used in the `Player`","example":50},"language":{"title":"language","enum":["de","en","es","fr","it"],"type":"string","description":"The language used in the `Player`","example":"fr"},"height":{"title":"height","type":"number","description":"The height used for render the `Player` (px)","example":144},"width":{"title":"width","type":"number","description":"The width used for render the `Player` (px)","example":505},"button_color":{"title":"button_color","type":"string","description":"The button color used in the `Player`","example":"FFFFFF"},"background_color":{"title":"background_color","type":"string","description":"The background color used in the `Player`","example":"202020"},"secondary_color":{"title":"secondary_color","type":"string","description":"The secondary color used in the `Player`","example":"0098FF"},"thumbnail":{"title":"thumbnail","type":"string","description":"The thumbnail url of the `Player`","example":"https:\/\/storage.infomaniak.com\/player\/my-thumbnail.png"},"is_listeners":{"title":"is_listeners","type":"boolean","description":"Is the listeners informations displayed?","example":true},"is_listeners_hold":{"title":"is_listeners_hold","type":"boolean","description":"Is the listeners hold displayed?","example":true},"listeners_hold":{"title":"listeners_hold","type":"integer","description":"The listeners hold used to display listeners informations","example":100},"is_embed":{"title":"is_embed","type":"boolean","description":"Is embed link visible?","example":true},"is_facebook_embed":{"title":"is_facebook_embed","type":"boolean","description":"Is the Facebook embed link visible?","example":true},"facebook_link":{"title":"facebook_link","type":"string","description":"The Facebook link used to Facebook embed"},"is_twitter_embed":{"title":"is_twitter_embed","type":"boolean","description":"Is the Twitter embed link visible?","example":true},"twitter_account":{"title":"twitter_account","type":"string","description":"The Twitter account used to Twitter embed","example":"MyAccount"},"twitter_backlink":{"title":"twitter_backlink","type":"string","description":"The Twitter backlink used to Twitter embed","example":"my-radio.ch"},"twitter_hashtag":{"title":"twitter_hashtag","type":"string","description":"The Twitter hashtag used to Twitter embed","example":"infomaniak,radio"},"loading":{"title":"loading","type":"string","description":"The url of the loading file used in the player","example":"https:\/\/storage.infomaniak.com\/player\/my-loading.png"},"unavailable":{"title":"unavailable","type":"string","description":"The url of the unavailable file used in the player","example":"https:\/\/storage.infomaniak.com\/player\/my-unavailable.png"},"restriction":{"title":"restriction","type":"string","description":"The url of the restriction file used in the player","example":"https:\/\/storage.infomaniak.com\/player\/my-restriction.png"},"is_cover":{"title":"is_cover","type":"boolean","description":"Is the cover enabled?","example":true},"is_spectrum":{"title":"is_spectrum","type":"boolean","description":"Is the spectrum enabled?","example":true},"is_station_thumbnail":{"title":"is_station_thumbnail","type":"boolean","description":"Is the station thumbnail used?","example":true},"is_hls_buffered":{"title":"is_hls_buffered","type":"boolean","description":"Is the player start at the beginning and buffer hls streams?","example":true},"is_direct_control":{"title":"is_direct_control","type":"boolean","description":"Is the player in direct control mode ?","example":true},"history_display":{"title":"history_display","enum":["none","overlay","split","under"],"type":"string","description":"The history display used in the `Player`","example":"split"},"history_hold":{"title":"history_hold","type":"integer","description":"The max song in the history","example":20},"is_history_time_display":{"title":"is_history_time_display","type":"boolean","description":"Is the history player time will be display ?","example":true},"is_history_clickable":{"title":"is_history_clickable","type":"boolean","description":"Is the history player could be clickable ?","example":true},"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Player`","example":1},"uuid":{"title":"uuid","type":"string","description":"Universally unique identifier of the resource `Player`","example":"b3ff3bf9-c390-4dfe-9341-5e3a5e408bc2"},"name":{"title":"name","type":"string","description":"Name of the resource `Player`","example":"Mayuri"},"type":{"title":"type","enum":["1","2","3","4","5"],"type":"integer","description":"Type of the resource `Player`","example":4},"iframe":{"title":"iframe","type":"string","description":"The iframe to integrate the `Player`","example":"<iframe src=\"my-player.infomaniak.com\" width=\"505.00px\" height=\"144.00px\" style=\"border-width:0\"><\/iframe>"},"stations":{"title":"stations","type":"array"},"domains":{"title":"domains","type":"string","description":"The list of domains allow to access","example":"infomaniak.com,my-radio.ch"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Player` has been created","format":"timestamp","example":1526917460},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Player` has been updated","format":"timestamp","example":1745004319}}},"8183272b_PackPrice":{"title":"PackPrice","required":["currency","id","periodicity","periodicity_id","price_excluding_vat"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `PackPrice`","example":1},"price_excluding_vat":{"title":"price_excluding_vat","type":"number","description":"The `PackPrice` without vat","example":15.2},"currency":{"title":"currency","enum":["CHF","EUR"],"type":"string","description":"The `PackPrice` currency","example":"CHF"},"periodicity":{"title":"periodicity","enum":["MONTH","YEAR"],"type":"string","description":"The `PackPrice` time range","example":"MONTH"},"periodicity_id":{"title":"periodicity_id","enum":["1","2"],"type":"integer","description":"Unique identifier of the resource `Periodicity`","example":1}}},"8183272b_StreamSimplify":{"title":"Stream Simplify","required":["bitrate","codec","id","is_fallback","is_source","mountpoint","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Stream`","example":1},"type":{"title":"type","type":"string","description":"The type of stream","example":"standard"},"mountpoint":{"title":"mountpoint","type":"string","description":"The mountpoint to access to the stream"},"codec":{"title":"codec","type":"integer","description":"The codec used in the stream"},"bitrate":{"title":"bitrate","type":"string","description":"The bitrate used to in the stream"},"is_source":{"title":"is_source","type":"boolean","description":"Define if the stream is used like a source for HlsStream or Transcoding"},"is_fallback":{"title":"is_fallback","type":"boolean","description":"Is the `Stream` is a fallback?","example":true}}},"8183272b_OptionPrice":{"title":"OptionPrice","required":["currency","id","name","pack_id","price_excluding_vat"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `OptionPrice`","example":1},"name":{"title":"name","type":"string","description":"Name of the resource `OptionPrice`","example":"Mayuri"},"pack_id":{"title":"pack_id","type":"integer"},"price_excluding_vat":{"title":"price_excluding_vat","type":"number","description":"The `OptionPrice` without vat","example":15.2},"currency":{"title":"currency","enum":["CHF","EUR"],"type":"string","description":"The `OptionPrice` currency","example":"CHF"}}},"8183272b_Pack":{"title":"Pack","required":["category","id","max_bandwidth","max_bitrate","max_free_autodj_size","max_stations","name","options","price"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Pack`","example":1},"name":{"title":"name","type":"string","description":"Name of the resource `Pack`","example":"Starter"},"category":{"title":"category","type":"string","example":"indie"},"max_stations":{"title":"max_stations","type":"integer","description":"The max `Station` can be created","example":5},"max_bitrate":{"title":"max_bitrate","type":"integer","description":"The max bitrate can be used for create a `Stream` (KiloBit)","example":128},"max_bandwidth":{"title":"max_bandwidth","type":"integer","description":"The max bandwidth can be used in total of all `Station`(Byte)","example":5},"max_free_autodj_size":{"title":"max_free_autodj_size","type":"integer","description":"The max free AutoDJ space can be used in VOD (GigaByte)","example":5},"price":{"$ref":"#\/components\/schemas\/8183272b_PackPrice"},"options":{"title":"options","type":"string"}}},"8183272b_ContinentMetric":{"title":"ContinentMetric","required":["AF","AN","AS","EU","NA","OC","SA"],"type":"object","properties":{"AS":{"title":"AS","type":"integer","description":"The number of listeners in Asie","example":5},"AN":{"title":"AN","type":"integer","description":"The number of listeners in Antarctique","example":10},"AF":{"title":"AF","type":"integer","description":"The number of listeners in Afrique","example":9},"SA":{"title":"SA","type":"integer","description":"The number of listeners in South America","example":3},"EU":{"title":"EU","type":"integer","description":"The number of listeners in Europe","example":15},"OC":{"title":"OC","type":"integer","description":"The number of listeners in Oc\u00e9anie"},"NA":{"title":"NA","type":"integer","description":"The number of listeners in North America","example":2}}},"8183272b_StatPlayerStats":{"title":"StatPlayerStats","required":["date","listeners"],"type":"object","properties":{"date":{"title":"date","type":"string","description":"The date for this stat","example":"2023-01-01"},"listeners":{"title":"listeners","type":"integer","description":"The number of listeners","example":10}}},"8183272b_StreamStored":{"title":"Stream Stored","required":["bitrate","codec","fallback_mountpoint","id","is_fallback","is_relay","is_source","is_transcoding","mountpoint","server_address","url"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Stream`","example":1},"mountpoint":{"title":"mountpoint","type":"string","description":"The mountpoint to access to the stream"},"codec":{"title":"codec","type":"integer","description":"The codec used in the stream"},"bitrate":{"title":"bitrate","type":"integer","description":"The bitrate used to in the stream"},"url":{"title":"url","type":"string","description":"The url to listen the stream"},"server_address":{"title":"server_address","type":"string","description":"The server address to connect encoder"},"fallback_mountpoint":{"title":"fallback_mountpoint","type":"string","description":"The mountpoint used to fallback the stream"},"is_relay":{"title":"is_relay","type":"boolean","description":"Define if the stream is a relay stream"},"is_source":{"title":"is_source","type":"boolean","description":"Define if the stream is used like a source for HlsStream or Transcoding"},"is_transcoding":{"title":"is_transcoding","type":"boolean","description":"Define if the stream is a transcoded stream"},"is_fallback":{"title":"is_fallback","type":"boolean","description":"Is the `Stream` is a fallback?","example":true}}},"1a4921f4_Tag":{"title":"Tag","required":["color","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Tag`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Tag`","example":"My tag name"},"color":{"title":"color","type":"integer","example":4},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource `Tag`","example":2}}},"1a4921f4_Right":{"title":"Right","type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"statistic":{"title":"statistic","type":"boolean"},"check":{"title":"check","type":"boolean"},"sale":{"title":"sale","type":"boolean"}}},"1a4921f4_Productstatus":{"title":"Product status","required":["activated_at","activated_by","infomaniak","locked","maintenance","superuser","technical"],"type":"object","properties":{"maintenance":{"title":"maintenance","type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"superuser":{"title":"superuser","type":"boolean"},"infomaniak":{"title":"infomaniak","type":"boolean"}}},"locked":{"title":"locked","type":"object","properties":{"superuser":{"title":"superuser","type":"boolean"},"infomaniak":{"title":"infomaniak","type":"boolean"}}},"activated_by":{"title":"activated_by","type":"array"},"activated_at":{"title":"activated_at","type":"integer","format":"timestamp"}}},"1a4921f4_ProductUser":{"title":"ProductUser","required":["rights","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer"},"rights":{"$ref":"#\/components\/schemas\/1a4921f4_Right","schema":[]}}},"1a4921f4_ProductAdminUser":{"title":"ProductAdminUser","required":["display_name","email","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer"},"email":{"title":"email","type":"string","description":"Email"},"display_name":{"title":"display_name","type":"string","description":"Display name"}}},"1a4921f4_KubernetesServicePack":{"title":"Kubernetes Service Pack","required":["description","is_active","kaas_pack_id","limit_per_project","name","price_per_hour"],"type":"object","properties":{"kaas_pack_id":{"title":"kaas_pack_id","type":"integer","description":"Kubernetes Service Pack unique identifier"},"name":{"title":"name","type":"string","description":"Kubernetes Service Pack Name","example":"shared"},"description":{"title":"description","type":"string","description":"Kubernetes Service Pack Description"},"price_per_hour":{"title":"price_per_hour","type":"array","description":"Current Kubernetes Service Pack price per hour of usage"},"limit_per_project":{"title":"limit_per_project","type":"integer","description":"The maximum number of Kubernetes Services of the given pack per project. null = unlimited","nullable":true},"is_active":{"title":"is_active","type":"string","description":"Is the pack currently active for use in Kubernetes Service creations","example":"true"}}},"1a4921f4_ServiceProject":{"title":"Service Project","required":["id","name","open_stack_name","public_cloud_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Project unique identifier","example":56321},"public_cloud_id":{"title":"public_cloud_id","type":"integer","description":"Public Cloud unique identifier","example":12345},"name":{"title":"name","type":"string","description":"Project Name","example":"Super Project"},"open_stack_name":{"title":"open_stack_name","type":"string","description":"Project OpenStack Name","example":"PCP-SUPER123"}}},"1a4921f4_KubernetesServiceInstanceTotals":{"title":"Kubernetes Service Instance Totals","required":["fixed","maximum_autoscaled","maximum_available_instances","minimum_autoscaled","minimum_available_instances","total","used"],"type":"object","properties":{"total":{"title":"total","type":"integer","description":"Total allowed instances","nullable":true,"example":30},"used":{"title":"used","type":"integer","description":"Total used instances","nullable":true,"example":25},"fixed":{"title":"fixed","type":"integer","description":"Total fixed instances","example":10},"minimum_autoscaled":{"title":"minimum_autoscaled","type":"integer","description":"Minimum autoscaled instances","example":5},"maximum_autoscaled":{"title":"maximum_autoscaled","type":"integer","description":"Maximum autoscaled instances","example":15},"minimum_available_instances":{"title":"minimum_available_instances","type":"integer","description":"Minimum available instances","example":1},"maximum_available_instances":{"title":"maximum_available_instances","type":"integer","description":"Maximum available instances","example":5}}},"1a4921f4_DatabaseServicePack":{"title":"Database Service Pack","required":["cpu","group","id","instances","name","ram","rates","storage","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Database Service Pack Identifier"},"type":{"title":"type","type":"string","description":"Database Service Pack Type"},"group":{"title":"group","type":"string","description":"Database Service Pack Group"},"name":{"title":"name","type":"string","description":"Database Service Pack Name"},"instances":{"title":"instances","type":"integer","description":"The number of instances in this Database Service pack"},"cpu":{"title":"cpu","type":"integer","description":"The number of vCPUs in this Database Service pack"},"ram":{"title":"ram","type":"integer","description":"The amount of RAM in this Database Service pack"},"storage":{"title":"storage","type":"integer","description":"The amount of storage in this Database Service pack"},"rates":{"title":"rates","type":"array","items":{"hour_excl_tax":{"title":"hour_excl_tax","type":"number","description":"The hourly price of this Database Service pack in filter[currency] (excluding VAT)","format":"double"},"hour_incl_tax":{"title":"hour_incl_tax","type":"number","description":"The hourly price of this Database Service pack in filter[currency] (including VAT)","format":"double"},"CHF":{"title":"CHF","type":"array","items":{"hour_excl_tax":{"title":"hour_excl_tax","type":"number","description":"The hourly price of this Database Service pack in CHF (excluding VAT)","format":"double"},"hour_incl_tax":{"title":"hour_incl_tax","type":"number","description":"The hourly price of this Database Service pack in CHF (including VAT)","format":"double"}}},"EUR":{"title":"EUR","type":"array","items":{"hour_excl_tax":{"title":"hour_excl_tax","type":"number","description":"The hourly price of this Database Service pack in EURO (excluding VAT)","format":"double"},"hour_incl_tax":{"title":"hour_incl_tax","type":"number","description":"The hourly price of this Database Service pack in EURO (including VAT)","format":"double"}}}}}}},"1a4921f4_DatabaseServiceBackupSchedule":{"title":"Database Service Backup Schedule","required":["id","is_pitr_enabled","retention","scheduled_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Backup schedule identifier"},"name":{"title":"name","type":"string","description":"Backup schedule name"},"scheduled_at":{"title":"scheduled_at","type":"string","description":"Backup schedule time in format H:i (24 hour, UTC)"},"retention":{"title":"retention","type":"integer","description":"The number of backups to keep for this schedule"},"is_pitr_enabled":{"title":"is_pitr_enabled","type":"boolean","description":"Is point in time recovery enabled or disabled","example":true}}},"1a4921f4_DatabaseServiceBackup":{"title":"Database Service Backup","required":["created_at","endpoint","id","location","status"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Unique identifier of the resource `Database Service Backup`"},"location":{"title":"location","type":"string"},"endpoint":{"title":"endpoint","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Database Service Backup` has been created","format":"timestamp"},"completed_at":{"title":"completed_at","type":"integer","format":"timestamp"},"status":{"title":"status","type":"string","description":"Status of the resource `Database Service Backup`"}}},"1a4921f4_PublicCloudPrice":{"title":"Public Cloud Price","required":["CHF_excl_tax","CHF_incl_tax","EUR_excl_tax","EUR_incl_tax"],"type":"object","properties":{"CHF_excl_tax":{"title":"CHF_excl_tax","type":"number","example":124.51},"CHF_incl_tax":{"title":"CHF_incl_tax","type":"number","example":136.36},"EUR_excl_tax":{"title":"EUR_excl_tax","type":"number","example":118.21},"EUR_incl_tax":{"title":"EUR_incl_tax","type":"number","example":138.49}}},"93e74a89_SignatureTemplateCreator":{"title":"Signature Template Creator","required":["email","firstname","id","lastname"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Signature Template Creator`","example":123456},"email":{"title":"email","type":"string","description":"Email"},"firstname":{"title":"firstname","type":"string"},"lastname":{"title":"lastname","type":"string"}},"description":"The signature template creator information"},"93e74a89_RecurrentDays":{"title":"Recurrent Days","required":["friday","monday","saturday","sunday","thursday","tuesday","wednesday"],"type":"object","properties":{"monday":{"title":"monday","type":"boolean","example":true},"tuesday":{"title":"tuesday","type":"boolean","example":true},"wednesday":{"title":"wednesday","type":"boolean","example":true},"thursday":{"title":"thursday","type":"boolean","example":true},"friday":{"title":"friday","type":"boolean","example":true},"sunday":{"title":"sunday","type":"boolean","example":true},"saturday":{"title":"saturday","type":"boolean","example":true}}},"93e74a89_ValidEmail":{"title":"Valid Email","required":["email","email_idn","id","is_account","is_removable","is_verified"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Valid Email`","example":123456},"email":{"title":"email","type":"string","description":"Email"},"email_idn":{"title":"email_idn","type":"string","description":"Mail with special character like \u00e9 or other"},"is_account":{"title":"is_account","type":"string"},"is_verified":{"title":"is_verified","type":"string"},"is_removable":{"title":"is_removable","type":"string"}}},"93e74a89_MailboxFilterConditions":{"title":"Mailbox Filter Conditions","required":["operator","property","value"],"type":"object","properties":{"property":{"title":"property","type":"string"},"operator":{"title":"operator","type":"string"},"value":{"title":"value","type":"string"}}},"93e74a89_MailboxFilterActions":{"title":"Mailbox Filter Actions","required":["type","value"],"type":"object","properties":{"type":{"title":"type","type":"string"},"value":{"title":"value","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"array","type":"array"}]}}},"93e74a89_MailboxUser":{"title":"Mailbox User","required":["avatar","email","has_double_auth","id","is_deleted","is_unified","last_access_at","last_login_at","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"object","oneOf":[{"title":"int","type":"integer"},{"title":"string","type":"string"}],"description":"Unique identifier of the resource `Mailbox User`","example":"123456"},"email":{"title":"email","type":"string","description":"Email"},"name":{"title":"name","type":"string","description":"Name of the resource `Mailbox User`"},"is_deleted":{"title":"is_deleted","type":"boolean"},"is_unified":{"title":"is_unified","type":"boolean"},"avatar":{"title":"avatar","type":"string","description":"Avatar","example":"https:\/\/example.com\/avatar.png"},"has_double_auth":{"title":"has_double_auth","type":"boolean","description":"Indicates if the account has the double authentication activated or not"},"last_login_at":{"title":"last_login_at","type":"integer","description":"Timestamp related to the last time the user logged in the mailbox","format":"timestamp","nullable":true},"last_access_at":{"title":"last_access_at","type":"integer","format":"timestamp","nullable":true},"has_ksuite":{"title":"has_ksuite","type":"boolean"},"email_reminder_obfuscate":{"title":"email_reminder_obfuscate","type":"string"},"permissions":{"$ref":"#\/components\/schemas\/93e74a89_Permissiononmailbox","schema":[]},"phone_reminder_obfuscate":{"title":"phone_reminder_obfuscate","type":"string"},"mailboxes":{"title":"mailboxes","type":"array"}}},"93e74a89_Listedsenders":{"title":"Listed senders","required":["email","locked"],"type":"object","properties":{"email":{"title":"email","type":"string","description":"Email"},"locked":{"title":"locked","type":"string"}}},"93e74a89_Permissiononmailbox":{"title":"Permission on mailbox","required":["can_access_logs","can_change_password","can_configure_mail_folders","can_manage_aliases","can_manage_auto_reply","can_manage_filters","can_manage_redirections","can_manage_rules","can_manage_security","can_manage_signatures","can_restore_emails"],"type":"object","properties":{"can_manage_filters":{"title":"can_manage_filters","type":"boolean"},"can_manage_security":{"title":"can_manage_security","type":"boolean"},"can_manage_aliases":{"title":"can_manage_aliases","type":"boolean"},"can_manage_redirections":{"title":"can_manage_redirections","type":"boolean"},"can_manage_signatures":{"title":"can_manage_signatures","type":"boolean"},"can_manage_auto_reply":{"title":"can_manage_auto_reply","type":"boolean"},"can_change_password":{"title":"can_change_password","type":"boolean"},"can_configure_mail_folders":{"title":"can_configure_mail_folders","type":"boolean"},"can_restore_emails":{"title":"can_restore_emails","type":"boolean"},"can_manage_rules":{"title":"can_manage_rules","type":"boolean"},"can_access_logs":{"title":"can_access_logs","type":"boolean"}}},"93e74a89_MailingListSubscriberErrorReport":{"title":"Mailing List Subscriber Error Report","required":["count","last_error","last_error_code"],"type":"object","properties":{"count":{"title":"count","type":"integer"},"last_error":{"title":"last_error","type":"integer","format":"timestamp","nullable":true},"last_error_code":{"title":"last_error_code","type":"integer","nullable":true}}},"93e74a89_Mailinglistconfig":{"title":"Mailing list config","required":["is_reply_to_forced","lang","max_message_size","should_send_notifications","subject","use_reply_to","who_can_send","who_can_subscribe"],"type":"object","properties":{"use_reply_to":{"title":"use_reply_to","type":"boolean","description":"Says if we use the reply-to address when we reply to the mailing list"},"is_reply_to_forced":{"title":"is_reply_to_forced","type":"boolean","description":"Says if the email of the sender is the reply-to when responding to the mailing list"},"max_message_size":{"title":"max_message_size","type":"string","description":"Maximum message size in KB"},"who_can_send":{"title":"who_can_send","enum":["0","1","2","3","4","5"],"type":"integer","description":"Indicates who can send mails in the mailing list.<note>0<\/strong>: Only moderator and subscriber can send email through the mailing list.<\/note><note>1<\/strong>: Only moderator can send email through the mailing list.<\/note><note>2<\/strong>: Everyone can send email through the mailing list but requires a moderator validation.<\/note><note>3<\/strong>: Only moderator and subscriber can send email through the mailing list but requires a moderator validation.<\/note><note>4<\/strong>: Everyone can send a mail through the mailing list but requires a moderator validation for the mail sent by non subscribers.<\/note><note>5<\/strong>: Everyone can send a mail through the mailing list.<\/note>","example":0},"who_can_subscribe":{"title":"who_can_subscribe","enum":["0","1","2"],"type":"integer","description":"The subscription policy setup for the mailing list.<note>0<\/strong>: Anybody can subscribe.<\/note><note>1<\/strong>: Any new subscription should be confirmed by the owner.<\/note><note>2<\/strong>: Any new subscription should be confirmed by the owner and the subscriber.<\/note>","example":0},"subject":{"title":"subject","type":"string"},"lang":{"title":"lang","enum":["de","en","es","fr","it"],"type":"string","description":"Current language preference code.<note>de<\/strong>: German language.<\/note><note>en<\/strong>: English language.<\/note><note>es<\/strong>: Spanish language.<\/note><note>fr<\/strong>: French language.<\/note><note>it<\/strong>: Italian language.<\/note>","example":"de"},"should_send_notifications":{"title":"should_send_notifications","type":"boolean","description":"Indicates if the mailing list should send notifications","example":true}}},"93e74a89_Mailinglistmoderator":{"title":"Mailing list moderator","required":["mail","mailIDN"],"type":"object","properties":{"mail":{"title":"mail","type":"string","description":"Email address that identifies a moderator","example":"moderator@example.com"},"mailIDN":{"title":"mailIDN","type":"string"}}},"93e74a89_Advancedsievefilterscript":{"title":"Advanced sieve filter script","required":["content","is_enabled","name"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of the filter"},"is_enabled":{"title":"is_enabled","type":"string","description":"Indicates if the filter is active"},"content":{"title":"content","type":"string","description":"Content of the filter"}}},"93e74a89_MailboxFilter":{"title":"Mailbox Filter","required":["actions","conditions","has_all_of","is_enabled","name","template_id"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of the filter"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Indicates if the mailbox filter is enabled"},"has_all_of":{"title":"has_all_of","type":"boolean","description":"Indicates if the filter has to complete all the condition to be activated or just one"},"conditions":{"title":"conditions","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_MailboxFilterConditions","schema":[]},"description":"List of condition to activate the filter"},"actions":{"title":"actions","type":"array","items":{"$ref":"#\/components\/schemas\/93e74a89_MailboxFilterActions","schema":[]},"description":"List of actions to do when the filter is activated"},"template_id":{"title":"template_id","type":"integer","description":"The identifier of the template to use if it is wanted","nullable":true}}},"93e74a89_Singlemailboxfolder":{"title":"Single mailbox folder","required":["name"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Mailbox folder's name"}}},"93e74a89_SignatureUserAccess":{"title":"Signature User Access","required":["avatarUrl","email","firstname","id","lastname"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Signature User Access`","example":123456},"email":{"title":"email","type":"string","description":"Email"},"firstname":{"title":"firstname","type":"string"},"lastname":{"title":"lastname","type":"string"},"avatarUrl":{"title":"avatarUrl","type":"string"}}},"93e74a89_RedirectionAddress":{"title":"Redirection Address","required":["email","email_idn"],"type":"object","properties":{"email":{"title":"email","type":"string","description":"Email"},"email_idn":{"title":"email_idn","type":"string","description":"Mail with special character like \u00e9 or other"}}},"93e74a89_RedirectionAddress_fc08f222":{"title":"Redirection Address","required":["address","created_at","id","state","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Unique identifier of the resource `Redirection Address`","example":"123456"},"address":{"title":"address","type":"string","description":"targeted email address","example":"example@example.com"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Redirection Address` has been created","format":"datetime","nullable":true},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Redirection Address` has been updated","format":"datetime","nullable":true},"state":{"title":"state","type":"string","example":"enable"}}},"93e74a89_User":{"title":"User","required":["avatarUrl","email","firstname","id","lastname"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `User`","example":123456},"email":{"title":"email","type":"string","description":"Email"},"firstname":{"title":"firstname","type":"string"},"lastname":{"title":"lastname","type":"string"},"avatarUrl":{"title":"avatarUrl","type":"string"}}},"511343ad_SurveyBlockLanguage":{"title":"SurveyBlockLanguage","required":["id","language_id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of a survey","example":1332},"name":{"title":"name","type":"string","description":"name of the survey","example":"Name"},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `SurveyBlockLanguage`"}},"description":"This model represents a survey block language"},"511343ad_SurveyField":{"title":"SurveyField","required":["display","id","is_required","logical_effect","position","status_id","type","visibility"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of a survey","example":1332},"visibility":{"title":"visibility","type":"string"},"is_required":{"title":"is_required","type":"string"},"type":{"title":"type","type":"string"},"position":{"title":"position","type":"integer","nullable":true},"status_id":{"title":"status_id","type":"integer"},"display":{"title":"display","type":"string"},"logical_effect":{"title":"logical_effect","type":"string"},"language":{"$ref":"#\/components\/schemas\/511343ad_SurveyFieldLanguage"},"conditions":{"title":"conditions","type":"string","nullable":true}},"description":"This model represents a survey field"},"511343ad_SurveyFieldLanguage":{"title":"SurveyFieldLanguage","required":["id","language_id","name","options"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of a survey","example":1332},"name":{"title":"name","type":"string","description":"Name of the resource `SurveyFieldLanguage`"},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `SurveyFieldLanguage`"},"options":{"title":"options","type":"array","nullable":true}},"description":"This model represents a survey field language"},"511343ad_Event":{"title":"Event","required":["created_at","id","updated_at","uuid"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Event`"},"language":{"$ref":"#\/components\/schemas\/511343ad_Eventlanguage"},"period":{"$ref":"#\/components\/schemas\/511343ad_Period"},"genre":{"$ref":"#\/components\/schemas\/511343ad_Genre"},"uuid":{"title":"uuid","type":"string","description":"Universally unique identifier of the resource `Event`"},"date":{"$ref":"#\/components\/schemas\/511343ad_Date"},"next_on_sale_date":{"$ref":"#\/components\/schemas\/511343ad_Date"},"last_on_sale_date":{"$ref":"#\/components\/schemas\/511343ad_Date"},"image_url_hint":{"title":"image_url_hint","type":"string","nullable":true},"image":{"title":"image","type":"string","nullable":true},"horizontal_image":{"title":"horizontal_image","type":"string","nullable":true},"gallery":{"title":"gallery","type":"string","nullable":true},"portal_link":{"title":"portal_link","type":"string","nullable":true},"date_publication":{"title":"date_publication","type":"integer","format":"timestamp","nullable":true},"schedule_sale_date":{"title":"schedule_sale_date","type":"integer","format":"timestamp","nullable":true},"relative_days_before_sale":{"title":"relative_days_before_sale","type":"integer","nullable":true},"minimum_age":{"title":"minimum_age","type":"integer","nullable":true},"duration_in_minutes":{"title":"duration_in_minutes","type":"integer","nullable":true},"url_video_youtube":{"title":"url_video_youtube","type":"string","nullable":true},"website":{"title":"website","type":"string","nullable":true},"features":{"title":"features","type":"string","nullable":true},"is_multi_date":{"title":"is_multi_date","type":"boolean","nullable":true},"custom_portal_event_visibility":{"title":"custom_portal_event_visibility","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Customportalevent"},"nullable":true},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Event` has been created","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Event` has been updated","format":"timestamp"}},"description":"This model represents a event"},"511343ad_Period":{"title":"Period","required":["created_at","display_languages","email","group_id","id","organizer_name","phone","status","ticket_pre_print_template_id","ticket_show_address","ticket_show_customer_code","ticket_show_customer_email","ticket_show_customer_name","ticket_show_customer_reservation","ticket_show_date","ticket_show_opening_doors","ticket_show_seller_name","ticket_template_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1332},"group_id":{"title":"group_id","type":"integer"},"organizer_name":{"title":"organizer_name","type":"string"},"email":{"title":"email","type":"string","description":"Email"},"phone":{"title":"phone","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Period` has been created","format":"timestamp"},"status":{"title":"status","type":"integer","description":"Status of the resource `Period`"},"display_languages":{"title":"display_languages","type":"array","description":"List of the activated languages","example":"[\"fr\",\"de\",\"en\"]"},"paid_reservations":{"title":"paid_reservations","type":"string","description":"Number of paid reservations","nullable":true},"organizer":{"$ref":"#\/components\/schemas\/511343ad_Organizer"},"language":{"$ref":"#\/components\/schemas\/511343ad_PeriodLanguage"},"events_count":{"title":"events_count","type":"integer","description":"Number of events","nullable":true},"incomes":{"title":"incomes","type":"string","description":"Amounts of incomes","nullable":true},"sales_status":{"title":"sales_status","type":"string","nullable":true},"features":{"title":"features","type":"string","nullable":true},"customer_fields":{"title":"customer_fields","type":"array","nullable":true},"default_shop":{"$ref":"#\/components\/schemas\/511343ad_Shop"},"portal_status":{"title":"portal_status","type":"string","nullable":true},"ticket_template_id":{"title":"ticket_template_id","type":"integer","nullable":true},"ticket_pre_print_template_id":{"title":"ticket_pre_print_template_id","type":"integer","nullable":true},"ticket_show_date":{"title":"ticket_show_date","type":"boolean","nullable":true},"ticket_show_opening_doors":{"title":"ticket_show_opening_doors","type":"boolean","nullable":true},"ticket_show_address":{"title":"ticket_show_address","type":"boolean","nullable":true},"ticket_show_customer_name":{"title":"ticket_show_customer_name","type":"boolean","nullable":true},"ticket_show_customer_code":{"title":"ticket_show_customer_code","type":"boolean","nullable":true},"ticket_show_customer_email":{"title":"ticket_show_customer_email","type":"boolean","nullable":true},"ticket_show_customer_reservation":{"title":"ticket_show_customer_reservation","type":"boolean","nullable":true},"ticket_show_seller_name":{"title":"ticket_show_seller_name","type":"boolean","nullable":true}},"description":"This model represents a period"},"511343ad_TariffZone":{"title":"TariffZone","required":["color","default_quota","id","import_id","is_numbered","position"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `TariffZone`"},"import_id":{"title":"import_id","type":"string","nullable":true},"default_quota":{"title":"default_quota","type":"integer"},"is_numbered":{"title":"is_numbered","type":"boolean"},"quota":{"title":"quota","type":"integer","description":"Real quota available for current user to sale tickets depending on zones availabilities","nullable":true},"quota_remaining":{"title":"quota_remaining","type":"integer","description":"Quota remaining","nullable":true},"color":{"title":"color","type":"string"},"position":{"title":"position","type":"integer"},"language":{"$ref":"#\/components\/schemas\/511343ad_TariffZoneLanguage"},"date":{"$ref":"#\/components\/schemas\/511343ad_Date"},"tariffs":{"title":"tariffs","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_TariffCategory"},"description":"deprecated as it is not paginated","nullable":true},"ticket_tariffs":{"title":"ticket_tariffs","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_TariffCategory"},"description":"list of tickets tariffs","nullable":true},"tickets_count":{"title":"tickets_count","type":"integer","nullable":true},"valid_tickets_count":{"title":"valid_tickets_count","type":"integer","nullable":true},"paid_tickets_count":{"title":"paid_tickets_count","type":"integer","nullable":true},"scanned_tickets_count":{"title":"scanned_tickets_count","type":"integer","nullable":true}},"description":"This model represents a tariff zone"},"511343ad_Address":{"title":"Address","required":["address","city","designation","id","number","zipcode"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Address`"},"designation":{"title":"designation","type":"string"},"address":{"title":"address","type":"string"},"number":{"title":"number","type":"string"},"zipcode":{"title":"zipcode","type":"string"},"city":{"title":"city","type":"string"}},"description":"This model represents an address"},"511343ad_Eventlanguage":{"title":"Event language","required":["description","id","language_id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Event language`"},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `Event language`"},"name":{"title":"name","type":"string","description":"Name of the resource `Event language`"},"description":{"title":"description","type":"string","description":"Description of the resource `Event language`"}},"description":"This model represents a event language"},"511343ad_Genre":{"title":"Genre","required":["id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Genre`"},"language":{"$ref":"#\/components\/schemas\/511343ad_Genrelanguage"}},"description":"This model represents a genre"},"511343ad_Date":{"title":"Date","required":["capacity","closing_doors","date","end","hall_disposition_id","has_zone","id","import_id","opening_doors","polcom","polcom_id","status","status_id","ticket_pre_print_template_id","ticket_show_address","ticket_show_customer_code","ticket_show_customer_email","ticket_show_customer_name","ticket_show_customer_reservation","ticket_show_date","ticket_show_opening_doors","ticket_show_seller_name","ticket_show_zone","ticket_template_id","warning_low_quota"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Date`"},"warning_low_quota":{"title":"warning_low_quota","type":"integer"},"status":{"title":"status","type":"string","description":"Status of the resource `Date`"},"status_id":{"title":"status_id","type":"integer"},"hall_disposition_id":{"title":"hall_disposition_id","type":"integer","nullable":true},"polcom":{"title":"polcom","type":"string"},"polcom_id":{"title":"polcom_id","type":"integer"},"import_id":{"title":"import_id","type":"string","nullable":true},"ticket_template_id":{"title":"ticket_template_id","type":"integer","nullable":true},"ticket_pre_print_template_id":{"title":"ticket_pre_print_template_id","type":"integer","nullable":true},"date":{"title":"date","type":"integer","format":"timestamp"},"opening_doors":{"title":"opening_doors","type":"integer","format":"timestamp"},"closing_doors":{"title":"closing_doors","type":"integer","format":"timestamp"},"end":{"title":"end","type":"integer","format":"timestamp"},"capacity":{"title":"capacity","type":"integer"},"ticket_show_date":{"title":"ticket_show_date","type":"boolean","nullable":true},"ticket_show_opening_doors":{"title":"ticket_show_opening_doors","type":"boolean","nullable":true},"ticket_show_address":{"title":"ticket_show_address","type":"boolean","nullable":true},"ticket_show_customer_name":{"title":"ticket_show_customer_name","type":"boolean","nullable":true},"ticket_show_customer_code":{"title":"ticket_show_customer_code","type":"boolean","nullable":true},"ticket_show_customer_email":{"title":"ticket_show_customer_email","type":"boolean","nullable":true},"ticket_show_customer_reservation":{"title":"ticket_show_customer_reservation","type":"boolean","nullable":true},"ticket_show_seller_name":{"title":"ticket_show_seller_name","type":"boolean","nullable":true},"ticket_show_zone":{"title":"ticket_show_zone","type":"boolean","nullable":true},"has_zone":{"title":"has_zone","type":"boolean","nullable":true},"default_quota":{"title":"default_quota","type":"integer","description":"Quota defined on the date","nullable":true},"quota":{"title":"quota","type":"integer","description":"Real quota visible for current user rights depending on zones availabilities","nullable":true},"quota_remaining":{"title":"quota_remaining","type":"integer","description":"quota remaining depending on zones availabilities","nullable":true},"event":{"$ref":"#\/components\/schemas\/511343ad_Event"},"period":{"$ref":"#\/components\/schemas\/511343ad_Period"},"zones":{"title":"zones","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_TariffZone"},"nullable":true},"address":{"$ref":"#\/components\/schemas\/511343ad_Address"},"features":{"title":"features","type":"string","nullable":true},"valid_tickets_count":{"title":"valid_tickets_count","type":"integer","description":"Number of tickets scanned or paid or booked","nullable":true},"paid_tickets_count":{"title":"paid_tickets_count","type":"integer","description":"Number of tickets paid","nullable":true},"booked_tickets_count":{"title":"booked_tickets_count","type":"integer","description":"Number of tickets booked but not yet paid or scanned","nullable":true},"scanned_tickets_count":{"title":"scanned_tickets_count","type":"integer","description":"Number of tickets scanned","nullable":true}},"description":"This model represents a date"},"511343ad_Customportalevent":{"title":"Custom portal event","required":["event_id","portal_group_id"],"type":"object","properties":{"event_id":{"title":"event_id","type":"integer"},"portal_group_id":{"title":"portal_group_id","type":"integer"}},"description":"\n This model represents the link between an event and a personalized portal (belonging to a particular organizer). \n The presence of a model means that the event in question is eligible to appear on the organizer's portal."},"511343ad_Organizer":{"title":"Organizer","required":["created_at","crm_state","email","firstname","id","lastname"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Organizer`"},"firstname":{"title":"firstname","type":"string"},"lastname":{"title":"lastname","type":"string"},"email":{"title":"email","type":"string","description":"Email"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Organizer` has been created","format":"timestamp"},"crm_state":{"title":"crm_state","type":"string","nullable":true},"group":{"$ref":"#\/components\/schemas\/511343ad_Account"},"owner":{"$ref":"#\/components\/schemas\/511343ad_User"},"control_tools_code":{"title":"control_tools_code","type":"string","description":"Control tools code (only for admins)","nullable":true},"tracking_state":{"title":"tracking_state","type":"string","nullable":true},"tracking_state_delay":{"title":"tracking_state_delay","type":"integer","format":"timestamp","nullable":true},"webinar":{"$ref":"#\/components\/schemas\/511343ad_Webinar"},"webinar_state":{"title":"webinar_state","type":"string","nullable":true},"last_period_created_at":{"title":"last_period_created_at","type":"integer","format":"timestamp","nullable":true},"plan":{"title":"plan","type":"string","description":"Plan describing organization level with premium subscription, supports, etc","nullable":true},"features":{"title":"features","type":"string","nullable":true},"logoUrl":{"title":"logoUrl","type":"string","nullable":true},"integration_link":{"title":"integration_link","type":"string","nullable":true},"integration_script":{"title":"integration_script","type":"string","nullable":true}},"description":"This model represents an organizer"},"511343ad_PeriodLanguage":{"title":"Period Language","required":["id","language_id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1332},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the language","example":1332},"name":{"title":"name","type":"string","description":"Name of the period"}},"description":"This model represents a period language"},"511343ad_Shop":{"title":"Shop","required":["background_url","code","color","created_at","custom_css","custom_html","filling_mode","header","is_only_purchase_tunnel","is_portal_logo_hidden","is_remaining_quota_displayed","max_passes_per_command","max_tickets_per_command","name","period_id","poster_url","theme","thumbnail_url","type","updated_at"],"type":"object","properties":{"code":{"title":"code","type":"string"},"period_id":{"title":"period_id","type":"integer"},"name":{"title":"name","type":"string","description":"Name of the resource `Shop`"},"type":{"title":"type","type":"string"},"filling_mode":{"title":"filling_mode","type":"string"},"header":{"title":"header","type":"string"},"poster_url":{"title":"poster_url","type":"string","nullable":true},"background_url":{"title":"background_url","type":"string","nullable":true},"thumbnail_url":{"title":"thumbnail_url","type":"string","nullable":true},"is_portal_logo_hidden":{"title":"is_portal_logo_hidden","type":"boolean"},"is_only_purchase_tunnel":{"title":"is_only_purchase_tunnel","type":"boolean"},"color":{"title":"color","type":"string"},"theme":{"title":"theme","type":"string"},"custom_html":{"title":"custom_html","type":"string","nullable":true},"custom_css":{"title":"custom_css","type":"string","nullable":true},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Shop` has been updated","format":"timestamp"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Shop` has been created","format":"timestamp"},"max_tickets_per_command":{"title":"max_tickets_per_command","type":"integer"},"max_passes_per_command":{"title":"max_passes_per_command","type":"integer"},"is_remaining_quota_displayed":{"title":"is_remaining_quota_displayed","type":"boolean"},"sections":{"title":"sections","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ShopSection"},"nullable":true},"language":{"$ref":"#\/components\/schemas\/511343ad_ShopLanguage"},"languages":{"title":"languages","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ShopLanguage"},"nullable":true},"csps":{"title":"csps","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ShopCSP"},"nullable":true},"is_referenced":{"title":"is_referenced","type":"boolean","nullable":true},"integration_script":{"title":"integration_script","type":"string","nullable":true},"integration_link":{"title":"integration_link","type":"string","nullable":true},"address":{"$ref":"#\/components\/schemas\/511343ad_Address"},"period":{"$ref":"#\/components\/schemas\/511343ad_Period"},"payment_modes":{"title":"payment_modes","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_GroupPaymentMode"},"nullable":true}},"description":"This model represents a shop"},"511343ad_Account":{"title":"Account","required":["beta","created_at","id","language_id","legal_entity_type","locale","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Account`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Account`","example":"Secret Organization"},"legal_entity_type":{"title":"legal_entity_type","enum":["company","individual","public_body","restrict"],"type":"string","example":"company"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Account` has been created","format":"timestamp","example":1294959600},"addresses":{"title":"addresses","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Accountaddress"}},"timezone":{"title":"timezone","type":"string","example":"Europe\/Zurich"},"website":{"title":"website","type":"string","example":"https:\/\/www.infomaniak.com"},"phone":{"title":"phone","type":"string","example":"+41790000000"},"fax":{"title":"fax","type":"string","example":"+41220000000"},"language":{"title":"language","type":"string"},"locale":{"title":"locale","type":"string","description":"Represents a language identifier and a region identifier","example":"fr_FR"},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `Account`","example":1},"logo":{"title":"logo","type":"string","example":"https:\/\/www.infomaniak.com\/img\/common\/logo-infomaniak.svg"},"order":{"title":"order","required":["blocked_order_id","in_process","waiting_payment"],"type":"object","properties":{"waiting_payment":{"title":"waiting_payment","type":"integer","example":1},"in_process":{"title":"in_process","type":"integer"},"blocked_order_id":{"title":"blocked_order_id","type":"array"}}},"beta":{"title":"beta","type":"boolean","example":true},"type":{"title":"type","type":"string","example":"owner"},"billing":{"title":"billing","type":"boolean","example":true},"mailing":{"title":"mailing","type":"boolean","example":true},"billing_mailing":{"title":"billing_mailing","type":"boolean","example":true},"workspace_only":{"title":"workspace_only","type":"boolean","example":true},"no_access":{"title":"no_access","type":"boolean","example":true},"is_blocked":{"title":"is_blocked","type":"boolean","example":true},"blocked_at":{"title":"blocked_at","type":"integer","format":"timestamp"},"vat_number":{"title":"vat_number","type":"string"},"field1":{"title":"field1","type":"string"},"field2":{"title":"field2","type":"string"},"tags":{"title":"tags","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Tag"}},"services_already_demo":{"title":"services_already_demo","type":"array"},"customization_url":{"title":"customization_url","type":"object"},"nb_invitations":{"title":"nb_invitations","type":"integer","example":2},"nb_users":{"title":"nb_users","type":"integer","example":2}}},"511343ad_User":{"title":"User","required":["avatar","display_name","email","first_name","id","last_login","last_name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `User`"},"display_name":{"title":"display_name","type":"string","description":"Display name"},"first_name":{"title":"first_name","type":"string","description":"First name"},"last_name":{"title":"last_name","type":"string","description":"Last name"},"email":{"title":"email","type":"string","description":"Email"},"avatar":{"title":"avatar","type":"string","description":"Avatar"},"last_login":{"title":"last_login","type":"integer","format":"timestamp"},"preference":{"$ref":"#\/components\/schemas\/511343ad_"}}},"511343ad_Webinar":{"title":"Webinar","required":["average_price","blurb","created_at","email","event","firm","firstname","id","lastname","needs","phone","status","ticket_quantity","tracking_state"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Webinar`"},"firstname":{"title":"firstname","type":"string"},"lastname":{"title":"lastname","type":"string"},"firm":{"title":"firm","type":"string"},"event":{"title":"event","type":"string"},"ticket_quantity":{"title":"ticket_quantity","type":"integer"},"email":{"title":"email","type":"string","description":"Email"},"average_price":{"title":"average_price","type":"number"},"needs":{"title":"needs","type":"string"},"blurb":{"title":"blurb","type":"string"},"phone":{"title":"phone","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Webinar` has been created","format":"timestamp"},"tracking_state":{"title":"tracking_state","type":"string"},"status":{"title":"status","type":"string","description":"Status of the resource `Webinar`"}},"description":"This model represents a Webinar"},"511343ad_Accountaddress":{"title":"Account address","required":["city","country","created_at","id","street","street2","type","zip"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Account address`","example":1234},"street":{"title":"street","type":"string","example":"Rue Eug\u00e8ne-Marziano 25"},"street2":{"title":"street2","type":"string"},"zip":{"title":"zip","type":"string","example":"1227"},"city":{"title":"city","type":"string","example":"Gen\u00e8ve"},"type":{"title":"type","type":"string","example":"professional"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Account address` has been created","format":"timestamp","example":1558601584},"country":{"$ref":"#\/components\/schemas\/511343ad_Country"},"for_invoice":{"title":"for_invoice","type":"boolean"}}},"511343ad_Tag":{"title":"Tag","required":["color","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Tag`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Tag`","example":"My tag name"},"color":{"title":"color","type":"integer","example":4},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource `Tag`","example":2}}},"511343ad_Country":{"title":"Country","required":["id","is_enabled","name","short_name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1},"name":{"title":"name","type":"string","description":"Name of the country in english","example":"SWITZERLAND"},"short_name":{"title":"short_name","type":"string","description":"Short name of the country in english","example":"CH"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Is this country enabled","example":true}},"description":"This model represents a country"},"511343ad_":{"title":"App\\Http\\Normalizers\\UserPreferenceLanguageNormalizer","required":["locale","short_locale"],"type":"object","properties":{"locale":{"title":"locale","type":"string","description":"Represents a language identifier and a region identifier"},"short_locale":{"title":"short_locale","type":"string","description":"Represents a language identifier"}}},"511343ad_ShopSection":{"title":"ShopSection","required":["display","position","type"],"type":"object","properties":{"position":{"title":"position","type":"integer"},"type":{"title":"type","type":"string"},"display":{"title":"display","type":"string"},"language":{"$ref":"#\/components\/schemas\/511343ad_ShopSectionLanguage"},"languages":{"title":"languages","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ShopSectionLanguage"},"nullable":true}},"description":"This model represents a shop section"},"511343ad_ShopLanguage":{"title":"ShopLanguage","required":["description","end_of_sale","language_id","title"],"type":"object","properties":{"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `ShopLanguage`"},"title":{"title":"title","type":"string"},"description":{"title":"description","type":"string","description":"Description of the resource `ShopLanguage`","nullable":true},"end_of_sale":{"title":"end_of_sale","type":"string","nullable":true}},"description":"This model represents a shop language"},"511343ad_ShopCSP":{"title":"ShopCSP","required":["directive","id","shop_id","value"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `ShopCSP`"},"shop_id":{"title":"shop_id","type":"integer"},"directive":{"title":"directive","type":"string"},"value":{"title":"value","type":"string"}},"description":"This model represents a shop csp"},"511343ad_GroupPaymentMode":{"title":"Group Payment Mode","required":["enabled","id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique id","example":960},"enabled":{"title":"enabled","type":"boolean","nullable":true},"payment_mode":{"$ref":"#\/components\/schemas\/511343ad_PaymentMode"},"language":{"$ref":"#\/components\/schemas\/511343ad_GroupPaymentModeLanguage"}},"description":"This model represents a group payment modes"},"511343ad_ShopSectionLanguage":{"title":"ShopSectionLanguage","required":["language_id","name"],"type":"object","properties":{"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `ShopSectionLanguage`"},"name":{"title":"name","type":"string","description":"Name of the resource `ShopSectionLanguage`"}},"description":"This model represents a shop section language"},"511343ad_PaymentMode":{"title":"Payment Mode","required":["id","name","validation_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique id","example":960},"name":{"title":"name","type":"string","description":"Name of the resource `Payment Mode`"},"validation_id":{"title":"validation_id","type":"string"},"group_mode":{"$ref":"#\/components\/schemas\/511343ad_GroupPaymentMode"}},"description":"This model represents a payment modes"},"511343ad_GroupPaymentModeLanguage":{"title":"Group Payment Mode Language","required":["id","language_id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique id","example":960},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `Group Payment Mode Language`"},"name":{"title":"name","type":"string","description":"Name of the resource `Group Payment Mode Language`","nullable":true}},"description":"This model represents a group payment mode language"},"511343ad_Genrelanguage":{"title":"Genre language","required":["id","language_id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Genre language`"},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `Genre language`"},"name":{"title":"name","type":"string","description":"Name of the resource `Genre language`"}},"description":"This model represents a genre language"},"511343ad_TariffZoneLanguage":{"title":"TariffZoneLanguage","required":["id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `TariffZoneLanguage`"},"name":{"title":"name","type":"string","description":"Name of the resource `TariffZoneLanguage`"}},"description":"This model represents a tariff zone language"},"511343ad_TariffCategory":{"title":"Tariff Category","required":["category_id","default_quota","id","import_id","max","min","pack_size","tariff_id","ticket_pre_print_template_id","ticket_template_id","type","zone_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique id of a tariff category","example":960},"tariff_id":{"title":"tariff_id","type":"integer","description":"Unique id of a tariff","example":960},"category_id":{"title":"category_id","type":"integer","description":"Unique id of a tariff category","example":960},"zone_id":{"title":"zone_id","type":"integer","description":"Unique id of a tariff zone","example":960},"import_id":{"title":"import_id","type":"string","description":"external id for correlation with the tariff","nullable":true,"example":"tariff1"},"default_quota":{"title":"default_quota","type":"integer","nullable":true},"quota":{"title":"quota","type":"integer","description":"Quota","nullable":true},"quota_remaining":{"title":"quota_remaining","type":"integer","description":"Quota remaining","nullable":true},"min":{"title":"min","type":"integer","nullable":true},"max":{"title":"max","type":"integer","nullable":true},"type":{"title":"type","type":"string","nullable":true},"ticket_template_id":{"title":"ticket_template_id","type":"integer","nullable":true},"ticket_pre_print_template_id":{"title":"ticket_pre_print_template_id","type":"integer","nullable":true},"pack_size":{"title":"pack_size","type":"integer"},"has_survey":{"title":"has_survey","type":"boolean","nullable":true},"tickets_count":{"title":"tickets_count","type":"integer","nullable":true},"valid_tickets_count":{"title":"valid_tickets_count","type":"integer","nullable":true},"paid_tickets_count":{"title":"paid_tickets_count","type":"integer","nullable":true},"scanned_tickets_count":{"title":"scanned_tickets_count","type":"integer","nullable":true},"language":{"$ref":"#\/components\/schemas\/511343ad_CategoryLanguage"},"zone":{"$ref":"#\/components\/schemas\/511343ad_TariffZone"},"prices":{"title":"prices","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Pricecategory"},"nullable":true},"current_fees":{"title":"current_fees","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_TariffFee"},"nullable":true}},"description":"This model represents a Tariff Category"},"511343ad_CategoryLanguage":{"title":"Category Language","required":["id","language_id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique id of category language","example":960},"language_id":{"title":"language_id","type":"integer","description":"Id of the language","example":1},"name":{"title":"name","type":"string","description":"Name of the resource `Category Language`"},"description":{"title":"description","type":"string","description":"Description of the resource `Category Language`","nullable":true}},"description":"This model represents a Category Language"},"511343ad_Pricecategory":{"title":"Price category","required":["amount","crossed_amount","currency","currency_short","id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1332},"currency":{"title":"currency","type":"integer"},"currency_short":{"title":"currency_short","type":"string"},"amount":{"title":"amount","type":"number"},"crossed_amount":{"title":"crossed_amount","type":"number","nullable":true}},"description":"This model represents a category of price"},"511343ad_TariffFee":{"title":"Tariff Fee","required":["amount","currency","id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1332},"currency":{"title":"currency","type":"integer","description":"currency of this fee","example":1},"amount":{"title":"amount","type":"number","description":"Fee amount","example":15},"language":{"$ref":"#\/components\/schemas\/511343ad_TariffFeeLanguage"}},"description":"This model represents a tariff fee"},"511343ad_TariffFeeLanguage":{"title":"Tariff Fee Language","required":["language_id","name"],"type":"object","properties":{"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the language","example":1},"name":{"title":"name","type":"string","description":"fee name","example":"Supplement"}},"description":"This model represents a tariff fee language"},"511343ad_Customer":{"title":"Customer","required":["civility","civility_id","firm","firstname","full_name","group_id","id","is_editable","language_id","lastname"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1332},"group_id":{"title":"group_id","type":"integer","description":"Identifier of the customer group","example":1332},"email":{"title":"email","type":"string","description":"Email","nullable":true},"firstname":{"title":"firstname","type":"string","nullable":true},"lastname":{"title":"lastname","type":"string","nullable":true},"full_name":{"title":"full_name","type":"string","nullable":true},"firm":{"title":"firm","type":"string","nullable":true},"civility":{"title":"civility","type":"string","nullable":true},"civility_id":{"title":"civility_id","type":"integer","nullable":true},"phone":{"title":"phone","type":"string","nullable":true},"address":{"title":"address","type":"string","nullable":true},"zipcode":{"title":"zipcode","type":"string","nullable":true},"city":{"title":"city","type":"string","nullable":true},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `Customer`"},"newsletter":{"title":"newsletter","type":"boolean"},"country":{"$ref":"#\/components\/schemas\/511343ad_Country"},"last_reservation":{"$ref":"#\/components\/schemas\/511343ad_Reservation"},"is_editable":{"title":"is_editable","type":"boolean"},"group":{"$ref":"#\/components\/schemas\/511343ad_Account"},"comment":{"title":"comment","type":"string","nullable":true}},"description":"This model represents a customer"},"511343ad_Ticket":{"title":"Ticket","required":["amount","code","date_id","entry_at","hardware_id","id","label","show_price","show_tariff","status_id","type","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of a Ticket","example":1332},"amount":{"title":"amount","type":"number"},"label":{"title":"label","type":"string"},"show_tariff":{"title":"show_tariff","type":"boolean"},"show_price":{"title":"show_price","type":"boolean"},"date":{"$ref":"#\/components\/schemas\/511343ad_Date"},"code":{"title":"code","type":"string"},"date_id":{"title":"date_id","type":"string"},"status_id":{"title":"status_id","type":"integer"},"entry_at":{"title":"entry_at","type":"integer","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Ticket` has been updated","format":"timestamp"},"hardware_id":{"title":"hardware_id","type":"string","nullable":true},"type":{"title":"type","type":"string"},"reservation":{"$ref":"#\/components\/schemas\/511343ad_Reservation"},"pass":{"$ref":"#\/components\/schemas\/511343ad_Pass"},"tariff":{"$ref":"#\/components\/schemas\/511343ad_TariffCategory"},"zone":{"$ref":"#\/components\/schemas\/511343ad_TariffZone"},"seat":{"$ref":"#\/components\/schemas\/511343ad_Seat"},"exchange_operation_id":{"title":"exchange_operation_id","type":"integer","nullable":true},"is_inside":{"title":"is_inside","type":"boolean","nullable":true},"icon_type":{"title":"icon_type","type":"integer","nullable":true}},"description":"This model represents a ticket"},"511343ad_Pass":{"title":"Pass","required":["address","barcode","birthday","city","civility","civility_id","customer_id","email","firm","firstname","free_text","id","lastname","phone","reservation_id","status_id","validation_status","zipcode"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique id of a pass","example":960},"barcode":{"title":"barcode","type":"string","description":"Barcode of a pass","example":"ABCDEF"},"firstname":{"title":"firstname","type":"string","description":"Firstname filled in pass informations","nullable":true,"example":"John"},"lastname":{"title":"lastname","type":"string","description":"Lastname filled in pass informations","nullable":true,"example":"Doe"},"email":{"title":"email","type":"string","description":"Email filled in pass informations","nullable":true,"example":"john.doe@domain.com"},"birthday":{"title":"birthday","type":"integer","description":"Birthday filled","format":"timestamp","nullable":true,"example":620784000},"firm":{"title":"firm","type":"string","description":"Firm filled","nullable":true,"example":"Infomaniak SA"},"civility_id":{"title":"civility_id","type":"integer","description":"Civility id filled","nullable":true,"example":2},"civility":{"title":"civility","type":"string","description":"Civility filled","nullable":true,"example":"MME"},"address":{"title":"address","type":"string","description":"Address filled","nullable":true,"example":"Rue de la paix, 42"},"city":{"title":"city","type":"string","description":"City filled","nullable":true,"example":"Gen\u00e8ve"},"zipcode":{"title":"zipcode","type":"string","description":"Zip filled","nullable":true,"example":"1200"},"phone":{"title":"phone","type":"string","description":"Phone filled","nullable":true,"example":"+41000000000"},"free_text":{"title":"free_text","type":"string","description":"Free text filled","nullable":true,"example":"Hello"},"status_id":{"title":"status_id","type":"string","description":"Status id of the pass","example":"1"},"customer_id":{"title":"customer_id","type":"integer","nullable":true},"reservation_id":{"title":"reservation_id","type":"integer","nullable":true},"validation_status":{"title":"validation_status","type":"string","description":"Validation status of the pass","example":"modified"},"price":{"$ref":"#\/components\/schemas\/511343ad_Pricecategory"},"country":{"title":"country","type":"string","description":"Country filled","nullable":true,"example":"Switzerland"},"reservation":{"$ref":"#\/components\/schemas\/511343ad_Reservation"},"renewed_from":{"$ref":"#\/components\/schemas\/511343ad_Pass"},"renewed_to":{"$ref":"#\/components\/schemas\/511343ad_Pass"},"period":{"$ref":"#\/components\/schemas\/511343ad_Period"},"category":{"$ref":"#\/components\/schemas\/511343ad_PassCategory"},"tariff":{"$ref":"#\/components\/schemas\/511343ad_TariffCategory"},"picture_url":{"title":"picture_url","type":"string","nullable":true},"picture_url_hint":{"title":"picture_url_hint","type":"string","nullable":true},"customer":{"$ref":"#\/components\/schemas\/511343ad_Customer"},"shipping_mode":{"title":"shipping_mode","type":"string","nullable":true},"seat":{"$ref":"#\/components\/schemas\/511343ad_Seat"},"zone_pass_tickets_count":{"title":"zone_pass_tickets_count","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Passticketscountbyzone"},"nullable":true},"zones":{"title":"zones","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_TariffZone"},"nullable":true},"expiration_date":{"title":"expiration_date","type":"integer","format":"timestamp","nullable":true},"tickets_count":{"title":"tickets_count","type":"string","nullable":true}},"description":"This model represents a Pass"},"511343ad_Product":{"title":"Product","required":["code","id","scanned_at","scanned_by","status_id","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1332},"status_id":{"title":"status_id","type":"integer","description":"Id of the related status","example":2},"code":{"title":"code","type":"string","description":"bar code of the product","example":"ABCDEF"},"scanned_at":{"title":"scanned_at","type":"integer","description":"date of the scan","format":"timestamp","example":1667230443},"scanned_by":{"title":"scanned_by","type":"string","description":"Name of the hardware","nullable":true,"example":"Android ABCDE"},"updated_at":{"title":"updated_at","type":"integer","description":"last time the entity was updated","format":"timestamp","example":1667230443},"pickup_date":{"title":"pickup_date","type":"integer","description":"Event date where pickup is scheduled","format":"timestamp","nullable":true,"example":1667230443},"pickup_place":{"title":"pickup_place","type":"string","description":"Event name where pickup is scheduled","nullable":true,"example":"SuperBowl 2022"},"reservation":{"$ref":"#\/components\/schemas\/511343ad_Reservation"},"meta_product":{"$ref":"#\/components\/schemas\/511343ad_MetaProduct"},"values":{"title":"values","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ProductAttributeValueNormalizer"},"nullable":true},"price":{"$ref":"#\/components\/schemas\/511343ad_MetaProductVariantPriceNormalizer"}},"description":"This model represents a product sold"},"511343ad_GiftCode":{"title":"Gift Code","required":["code","expired_at","id","status_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Gift Code`"},"code":{"title":"code","type":"string"},"status_id":{"title":"status_id","type":"integer"},"expired_at":{"title":"expired_at","type":"integer","description":"Timestamp `Gift Code` has expired","format":"timestamp","nullable":true},"price":{"$ref":"#\/components\/schemas\/511343ad_GiftPrice"},"reservation":{"$ref":"#\/components\/schemas\/511343ad_Reservation"}},"description":"This model represents a Gift Code (ordered gift)"},"511343ad_ReservationOperation":{"title":"ReservationOperation","required":["amount","id","insurance","operation_date","payment_mode_id","payment_request_date","payment_type","reference","sales_device_id","shipment","status_code","status_id","supplement","total","tpe_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `ReservationOperation`"},"total":{"title":"total","type":"number"},"amount":{"title":"amount","type":"number"},"status_code":{"title":"status_code","type":"string"},"payment_type":{"title":"payment_type","type":"string"},"supplement":{"title":"supplement","type":"number","nullable":true},"shipment":{"title":"shipment","type":"number","nullable":true},"insurance":{"title":"insurance","type":"number","nullable":true},"status_id":{"title":"status_id","type":"integer"},"payment_mode_id":{"title":"payment_mode_id","type":"integer"},"reference":{"title":"reference","type":"string"},"operation_date":{"title":"operation_date","type":"integer","format":"timestamp"},"payment_request_date":{"title":"payment_request_date","type":"integer","format":"timestamp"},"tpe_id":{"title":"tpe_id","type":"string"},"sales_device_id":{"title":"sales_device_id","type":"integer","nullable":true},"reservation":{"$ref":"#\/components\/schemas\/511343ad_Reservation"},"user":{"$ref":"#\/components\/schemas\/511343ad_User"},"payment_mode":{"$ref":"#\/components\/schemas\/511343ad_PaymentMode"},"last_log":{"$ref":"#\/components\/schemas\/511343ad_ReservationOperationLog"},"sales_device":{"$ref":"#\/components\/schemas\/511343ad_SalesDevice"}},"description":"This model represents an operation"},"511343ad_PromotionCode":{"title":"PromotionCode","required":["code","id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `PromotionCode`"},"code":{"title":"code","type":"string"},"promotion":{"$ref":"#\/components\/schemas\/511343ad_Promotion"}},"description":"This model represents a promotion code"},"511343ad_MetaReservationNormalizer":{"title":"MetaReservationNormalizer","required":["id","uuid"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `MetaReservationNormalizer`"},"uuid":{"title":"uuid","type":"string","description":"Universally unique identifier of the resource `MetaReservationNormalizer`"},"reservations":{"title":"reservations","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Reservation"},"nullable":true},"customer":{"$ref":"#\/components\/schemas\/511343ad_Customer"},"customer_group":{"title":"customer_group","type":"string","nullable":true},"user_level":{"title":"user_level","type":"string","nullable":true}},"description":"This model represents a meta order"},"511343ad_SalesDevice":{"title":"Sales Device","required":["id","name","sales_office_id","uuid"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1332},"name":{"title":"name","type":"string","description":"Name of this entity","example":"Sales Device"},"uuid":{"title":"uuid","type":"string","description":"Unique uuid of this entity","example":"12341234-1234-1234-1234-123412341234"},"sales_office_id":{"title":"sales_office_id","type":"integer","description":"ID of the sales office","example":1234},"sales_office":{"$ref":"#\/components\/schemas\/511343ad_SalesOffice"}},"description":"This model represents a Sales Device"},"511343ad_Reservation":{"title":"Reservation","required":["amount","currency_id","customer_id","group_id","id","meta_reservation_id","ordered_at","period_id","sales_device_id","status_id","uuid"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Reservation`"},"meta_reservation_id":{"title":"meta_reservation_id","type":"integer","nullable":true},"currency_id":{"title":"currency_id","type":"integer"},"period_id":{"title":"period_id","type":"integer"},"sales_device_id":{"title":"sales_device_id","type":"integer","nullable":true},"group_id":{"title":"group_id","type":"integer"},"amount":{"title":"amount","type":"number"},"uuid":{"title":"uuid","type":"string","description":"Universally unique identifier of the resource `Reservation`"},"status_id":{"title":"status_id","type":"integer"},"customer_id":{"title":"customer_id","type":"integer","nullable":true},"ordered_at":{"title":"ordered_at","type":"integer","format":"timestamp"},"total":{"title":"total","type":"number","nullable":true},"total_discount":{"title":"total_discount","type":"number","nullable":true},"total_remaining":{"title":"total_remaining","type":"number","nullable":true},"total_paid":{"title":"total_paid","type":"number","nullable":true},"total_pending":{"title":"total_pending","type":"number","nullable":true},"total_refund":{"title":"total_refund","type":"number","nullable":true},"total_refundable":{"title":"total_refundable","type":"number","nullable":true},"total_being_refunded":{"title":"total_being_refunded","type":"number","nullable":true},"supplement":{"title":"supplement","type":"number","nullable":true},"total_paid_by_gifts":{"title":"total_paid_by_gifts","type":"number","nullable":true},"total_paid_by_credits":{"title":"total_paid_by_credits","type":"number","nullable":true},"customer":{"$ref":"#\/components\/schemas\/511343ad_Customer"},"customer_group":{"title":"customer_group","type":"string","nullable":true},"tickets":{"title":"tickets","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Ticket"},"nullable":true},"passes":{"title":"passes","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Pass"},"nullable":true},"passes_direct":{"title":"passes_direct","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Pass"},"nullable":true},"products":{"title":"products","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Product"},"nullable":true},"gifts":{"title":"gifts","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_GiftCode"},"nullable":true},"donations":{"title":"donations","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_GiftCode"},"nullable":true},"operations":{"title":"operations","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ReservationOperation"},"nullable":true},"operations_count":{"title":"operations_count","type":"integer","nullable":true},"tickets_count":{"title":"tickets_count","type":"integer","nullable":true},"passes_count":{"title":"passes_count","type":"integer","nullable":true},"passes_direct_count":{"title":"passes_direct_count","type":"integer","nullable":true},"gifts_count":{"title":"gifts_count","type":"integer","nullable":true},"donations_count":{"title":"donations_count","type":"integer","nullable":true},"products_count":{"title":"products_count","type":"integer","nullable":true},"tickets_price_sum":{"title":"tickets_price_sum","type":"integer","nullable":true},"passes_direct_price_sum":{"title":"passes_direct_price_sum","type":"integer","nullable":true},"gifts_price_sum":{"title":"gifts_price_sum","type":"integer","nullable":true},"donations_price_sum":{"title":"donations_price_sum","type":"integer","nullable":true},"products_price_sum":{"title":"products_price_sum","type":"integer","nullable":true},"user":{"$ref":"#\/components\/schemas\/511343ad_User"},"period":{"$ref":"#\/components\/schemas\/511343ad_Period"},"promo_code":{"$ref":"#\/components\/schemas\/511343ad_PromotionCode"},"note":{"title":"note","type":"string","nullable":true},"meta_reservation":{"$ref":"#\/components\/schemas\/511343ad_MetaReservationNormalizer"},"sales_device":{"$ref":"#\/components\/schemas\/511343ad_SalesDevice"},"is_content_editable":{"title":"is_content_editable","type":"boolean","nullable":true},"can_add_operation":{"title":"can_add_operation","type":"boolean","nullable":true}},"description":"This model represents an order"},"511343ad_Seat":{"title":"Seat","required":["id","number"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of a Seat","example":1332},"number":{"title":"number","type":"string","description":"Seat number"},"row":{"title":"row","type":"string","description":"Row name","nullable":true},"bloc":{"title":"bloc","type":"string","description":"Bloc name","nullable":true}},"description":"This model represents a seat"},"511343ad_PassCategory":{"title":"Pass Category","required":["id","is_to_be_validated","pass_category_quota","position","type","warning_low_quota"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique id of a pass category","example":960},"is_to_be_validated":{"title":"is_to_be_validated","type":"string"},"type":{"title":"type","type":"string","nullable":true},"pass_category_quota":{"title":"pass_category_quota","type":"integer","description":"Pass Category quota maximum that can be sold","nullable":true},"warning_low_quota":{"title":"warning_low_quota","type":"integer","description":"Quota after which pass category is considered as low","nullable":true},"position":{"title":"position","type":"integer","description":"Selected position for display","nullable":true},"period":{"$ref":"#\/components\/schemas\/511343ad_Period"},"language":{"$ref":"#\/components\/schemas\/511343ad_CategoryLanguage"},"zones":{"title":"zones","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_TariffZone"},"nullable":true},"has_renewed_pass":{"title":"has_renewed_pass","type":"boolean","nullable":true},"prices":{"title":"prices","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_Pricecategory"},"nullable":true},"shipping_modes":{"title":"shipping_modes","type":"string","nullable":true},"reserved_passes_count":{"title":"reserved_passes_count","type":"integer","nullable":true},"form":{"title":"form","type":"array","nullable":true},"tariff":{"$ref":"#\/components\/schemas\/511343ad_TariffCategory"},"is_pass_giftable":{"title":"is_pass_giftable","type":"string","nullable":true}},"description":"This model represents a Pass Category"},"511343ad_Passticketscountbyzone":{"title":"Pass tickets count by zone","required":["pass_ticket_count","pass_ticket_ids","zone_id"],"type":"object","properties":{"zone_id":{"title":"zone_id","type":"integer"},"pass_ticket_count":{"title":"pass_ticket_count","type":"integer"},"pass_ticket_ids":{"title":"pass_ticket_ids","type":"array","items":{"type":"integer","title":"pass_ticket_ids"}},"zone":{"title":"zone","type":"string","nullable":true}},"description":"Pass tickets count by zone"},"511343ad_MetaProduct":{"title":"MetaProduct","required":["collect_options","id","image","status_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique id of the entity","example":960},"status_id":{"title":"status_id","type":"integer","description":"Id of the related status of the metaproduct","example":1},"collect_options":{"title":"collect_options","enum":["event_date","free_date","post"],"type":"string","description":"Pickup type","nullable":true,"example":"event_date"},"image":{"title":"image","type":"string","description":"Image representing the metaproduct displayed in the shop","nullable":true,"example":"https:\/\/url.infomaniak.com"},"count_sold":{"title":"count_sold","type":"integer","description":"Valid sold metaproducts","nullable":true,"example":13},"count_all_products_sold":{"title":"count_all_products_sold","type":"integer","description":"Sold metaproducts even if order is cancelled","nullable":true,"example":13},"language":{"$ref":"#\/components\/schemas\/511343ad_MetaProductLanguage"},"languages":{"title":"languages","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_MetaProductLanguage"},"nullable":true},"attributes":{"title":"attributes","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ProductAttributeNormalizer"},"nullable":true},"variants":{"title":"variants","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_MetaProductVariantNormalizer"},"nullable":true},"has_dependencies":{"title":"has_dependencies","type":"boolean","description":"If the metaproduct is link to other elements with dependency rules","nullable":true,"example":true},"image_url":{"title":"image_url","type":"string","nullable":true}},"description":"This model represents a MetaProduct"},"511343ad_ProductAttributeValueNormalizer":{"title":"ProductAttributeValueNormalizer","required":["id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Id of the product attribute value","example":1},"language":{"$ref":"#\/components\/schemas\/511343ad_ProductAttributeValueLanguageNormalizer"},"languages":{"title":"languages","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ProductAttributeValueLanguageNormalizer"},"nullable":true}},"description":"This model represents a product attribute value"},"511343ad_MetaProductVariantPriceNormalizer":{"title":"MetaProductVariantPriceNormalizer","required":["currency_id","id","price"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Id of the variant price","example":1},"currency_id":{"title":"currency_id","type":"integer","description":"Id of the currency","example":1},"price":{"title":"price","type":"number","description":"price of the variant","example":25}},"description":"This model represents a product variant price"},"511343ad_MetaProductLanguage":{"title":"MetaProductLanguage","required":["description","id","language_id","name","short"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of a metaproduct language","example":42},"language_id":{"title":"language_id","type":"integer","description":"Id of the language related","example":1},"short":{"title":"short","type":"string","description":"short flag representing the language","example":"fr"},"name":{"title":"name","type":"string","description":"Name of the metaproduct","example":"Champagne"},"description":{"title":"description","type":"string","description":"Description of the metaproduct","example":"Champagne from Champagne-Ardenes"}},"description":"This model represents a MetaProductLanguage"},"511343ad_ProductAttributeNormalizer":{"title":"ProductAttributeNormalizer","required":["id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Id of the attribute","example":"1"},"count_products":{"title":"count_products","type":"integer","description":"Number of metaproducts linked with this attribute","nullable":true,"example":5},"language":{"$ref":"#\/components\/schemas\/511343ad_ProductAttributeLanguageNormalizer"},"languages":{"title":"languages","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ProductAttributeLanguageNormalizer"},"nullable":true},"values":{"title":"values","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ProductAttributeValueNormalizer"},"nullable":true}},"description":"This model represents a product attribute"},"511343ad_MetaProductVariantNormalizer":{"title":"MetaProductVariantNormalizer","required":["id","quota","status_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Id of the variant","example":1},"quota":{"title":"quota","type":"number","description":"Quantity that was available (not the current quantity)","example":10},"status_id":{"title":"status_id","type":"integer","description":"Id of the status","example":1},"vat":{"title":"vat","type":"number","nullable":true},"current_prices":{"title":"current_prices","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_MetaProductVariantPriceNormalizer"},"nullable":true},"values":{"title":"values","type":"array","items":{"$ref":"#\/components\/schemas\/511343ad_ProductAttributeValueNormalizer"},"nullable":true},"meta_product":{"$ref":"#\/components\/schemas\/511343ad_MetaProduct"}},"description":"This model represents a product variant"},"511343ad_ProductAttributeLanguageNormalizer":{"title":"ProductAttributeLanguageNormalizer","required":["language_id","name","short"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of the attribute","example":"Size"},"language_id":{"title":"language_id","type":"integer","description":"Id of the language related","example":1},"short":{"title":"short","type":"string","description":"short flag representing the language","example":"fr"}},"description":"This model represents a ProductAttributeLanguage"},"511343ad_ProductAttributeValueLanguageNormalizer":{"title":"ProductAttributeValueLanguageNormalizer","required":["language_id","short","value"],"type":"object","properties":{"value":{"title":"value","type":"string","description":"Name of the value","example":"Brown"},"language_id":{"title":"language_id","type":"integer","description":"Id of the language related","example":1},"short":{"title":"short","type":"string","description":"short flag representing the language","example":"fr"}},"description":"This model represents a product attribute value translation"},"511343ad_GiftPrice":{"title":"Gift Price","required":["id","price","status_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Gift Price`"},"price":{"title":"price","type":"number"},"status_id":{"title":"status_id","type":"integer"},"gift":{"$ref":"#\/components\/schemas\/511343ad_Gift"}},"description":"This model represents a Gift Price"},"511343ad_Gift":{"title":"Gift","required":["id","value"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Gift`"},"value":{"title":"value","type":"number"},"language":{"$ref":"#\/components\/schemas\/511343ad_GiftLanguage"},"price":{"$ref":"#\/components\/schemas\/511343ad_GiftPrice"}},"description":"This model represents a Gift"},"511343ad_GiftLanguage":{"title":"GiftLanguage","required":["id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `GiftLanguage`"},"name":{"title":"name","type":"string","description":"Name of the resource `GiftLanguage`"}},"description":"This model represents a GiftLanguage"},"511343ad_ReservationOperationLog":{"title":"ReservationOperationLog","required":["created_at","id","log","reservation_operation_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `ReservationOperationLog`"},"reservation_operation_id":{"title":"reservation_operation_id","type":"integer"},"log":{"title":"log","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `ReservationOperationLog` has been created","format":"timestamp"}},"description":"This model represents an operation log"},"511343ad_SalesOffice":{"title":"Sales Office","required":["group_id","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of this entity","example":1332},"group_id":{"title":"group_id","type":"integer","description":"Organizer id","example":1332},"name":{"title":"name","type":"string","description":"Name of this entity","example":"Sales Office"},"sales_devices":{"title":"sales_devices","type":"string","nullable":true},"image":{"title":"image","type":"string","description":"Image of this entity if existing","nullable":true},"image_hint":{"title":"image_hint","type":"string","description":"Image url of this entity without checking presence","nullable":true}},"description":"This model represents a Sales Office"},"511343ad_Promotion":{"title":"Promotion","required":["id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Promotion`"},"name":{"title":"name","type":"string","description":"Name of the resource `Promotion`"}},"description":"This model represents a promotion"},"511343ad_ScanTicketsResponse":{"title":"Scan Tickets Response","required":["barcode","customer_full_name","date_id","entry_at","hardware_id","icon_type","id","is_inside","owner_info","pass","reservation_id","row","seat","status","type","zone_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of a Ticket","example":1332},"barcode":{"title":"barcode","type":"string"},"date_id":{"title":"date_id","type":"string"},"hardware_id":{"title":"hardware_id","type":"string","nullable":true},"icon_type":{"title":"icon_type","type":"string","nullable":true},"reservation_id":{"title":"reservation_id","type":"string"},"customer_full_name":{"title":"customer_full_name","type":"string","nullable":true},"seat":{"title":"seat","type":"string","nullable":true},"row":{"title":"row","type":"string","nullable":true},"status":{"title":"status","type":"string","description":"Status of the resource `Scan Tickets Response`"},"type":{"title":"type","type":"string"},"is_inside":{"title":"is_inside","type":"string","nullable":true},"entry_at":{"title":"entry_at","type":"integer","format":"timestamp","nullable":true},"zone_id":{"title":"zone_id","type":"string"},"pass":{"$ref":"#\/components\/schemas\/511343ad_ScanPass"},"owner_info":{"title":"owner_info","type":"string","nullable":true}},"description":"This model represents a scan tickets response"},"511343ad_ScanPass":{"title":"Scan Pass","required":["barcode","firstname","id","lastname","picture_url_hint"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of a pass","example":1337},"barcode":{"title":"barcode","type":"string","description":"Pass barcode"},"firstname":{"title":"firstname","type":"string","description":"Firstname printed on the pass","nullable":true},"lastname":{"title":"lastname","type":"string","description":"Lastname printed on the pass","nullable":true},"picture_url_hint":{"title":"picture_url_hint","type":"string","description":"URL (or hint) to the pass picture","nullable":true}},"description":"Minimal pass information returned by scan tickets routes"},"97034793_HardwareModel":{"title":"HardwareModel","required":["id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `HardwareModel`"},"name":{"title":"name","type":"string","description":"Name of equipment","example":"Exos X20 SAS"}}},"97034793_EquipmentBase":{"title":"EquipmentBase","required":["created_at","id","name","root_name","serial_number","status","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `EquipmentBase`"},"serial_number":{"title":"serial_number","type":"string","example":"WSJSJS45"},"name":{"title":"name","type":"string","description":"Name of equipment","example":"swift03-swiftstore-10"},"type":{"title":"type","type":"string","description":"Type of equipment","example":"server"},"status":{"title":"status","type":"string","description":"Status of equipment","example":"available"},"created_at":{"title":"created_at","type":"integer","description":"Date of creation","format":"timestamp"},"hardware_model":{"$ref":"#\/components\/schemas\/97034793_HardwareModel","schema":[]},"specification":{"title":"specification","type":"array"},"ancestors":{"type":"array","items":{"$ref":"#\/components\/schemas\/97034793_EquipmentBase","schema":[]}},"description":{"title":"description","type":"string","description":"Description of the resource `EquipmentBase`"},"serial_number_2":{"title":"serial_number_2","type":"string","description":"Some equipments have 2 SN","example":"WSJSJS95"},"order":{"title":"order","type":"string","description":"Order details"},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/97034793_EquipmentTag","schema":[]}},"root_name":{"title":"root_name","type":"string","description":"Name of datacenter","example":"Datacenter 3 production"}}},"97034793_EquipmentTag":{"title":"EquipmentTag","required":["category","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `EquipmentTag`"},"name":{"title":"name","type":"string","description":"Name of tag","example":"kDrive"},"category":{"title":"category","type":"string","description":"Category of tag","example":"Team"}}},"97034793_PhysicalServer":{"title":"PhysicalServer","required":["cpu_description","id","main_server","memory_description","servers","storage_description"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `PhysicalServer`"},"cpu_description":{"title":"cpu_description","type":"string","example":"Xeon L5320"},"memory_description":{"title":"memory_description","type":"string","example":"8GB (4x2GB Dual Rank DIMMs)"},"storage_description":{"title":"storage_description","type":"string"},"main_server":{"$ref":"#\/components\/schemas\/97034793_LogicalServer","schema":[]},"servers":{"type":"array","items":{"$ref":"#\/components\/schemas\/97034793_LogicalServer","schema":[]}}}},"97034793_LogicalServer":{"title":"LogicalServer","required":["cpu","created_at","description","ipv4","ipv6","name","parent_id","ram","server_id","type"],"type":"object","properties":{"server_id":{"title":"server_id","type":"integer"},"name":{"title":"name","type":"string","description":"Name of the resource `LogicalServer`"},"description":{"title":"description","type":"string","description":"Description of the resource `LogicalServer`"},"type":{"title":"type","enum":["DMU","IMU","NAS","NMU","NTU","OS","VMU","VNU","XEN","XENMU"],"type":"string"},"cpu":{"title":"cpu","type":"integer","description":"count of allowed CPU"},"ram":{"title":"ram","type":"integer","description":"quantity of allowed RAM"},"ipv4":{"title":"ipv4","type":"string","nullable":true},"ipv6":{"title":"ipv6","type":"string","nullable":true},"parent_id":{"title":"parent_id","type":"integer"},"parent":{"$ref":"#\/components\/schemas\/97034793_LogicalServer","schema":[]},"parent_equipment":{"$ref":"#\/components\/schemas\/97034793_EquipmentServer","schema":[]},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `LogicalServer` has been created","format":"timestamp"}},"description":"This model represents a logical server, could be a main server or a VM."},"97034793_EquipmentServer":{"title":"EquipmentServer","required":["created_at","id","name","position","rack_id","rack_name","root_name","serial_number","size","status","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `EquipmentServer`"},"serial_number":{"title":"serial_number","type":"string","example":"WSJSJS45Z"},"name":{"title":"name","type":"string","description":"Name of equipment","example":"swift03-swiftstore-10"},"type":{"title":"type","type":"string","description":"Type of equipment","example":"server"},"status":{"title":"status","type":"string","description":"Status of equipment","example":"available"},"created_at":{"title":"created_at","type":"integer","description":"Date of creation","format":"timestamp"},"hardware_model":{"$ref":"#\/components\/schemas\/97034793_HardwareModel","schema":[]},"specification":{"title":"specification","type":"array"},"ancestors":{"type":"array","items":{"$ref":"#\/components\/schemas\/97034793_EquipmentBase","schema":[]}},"description":{"title":"description","type":"string","description":"Description of the resource `EquipmentServer`"},"serial_number_2":{"title":"serial_number_2","type":"string","description":"Some equipments have 2 SN","example":"WSJSJS95"},"order":{"title":"order","type":"string","description":"Order details"},"tags":{"type":"array","items":{"$ref":"#\/components\/schemas\/97034793_EquipmentTag","schema":[]}},"root_name":{"title":"root_name","type":"string","description":"Name of datacenter","example":"Datacenter 3 production"},"rack_name":{"title":"rack_name","type":"string","description":"Name of installed rack if is in production","nullable":true,"example":"A12"},"rack_id":{"title":"rack_id","type":"integer","description":"Id of installed rack if is in production","nullable":true,"example":271},"position":{"title":"position","type":"string","nullable":true,"example":"22"},"size":{"title":"size","type":"string","description":"Size of server on rack (1U,2U)"},"components":{"type":"array","items":{"$ref":"#\/components\/schemas\/97034793_EquipmentBase","schema":[]}},"network_infos":{"$ref":"#\/components\/schemas\/97034793_PhysicalServer","schema":[]},"interfaces":{"title":"interfaces","type":"string"}}},"97034793_Reservation":{"title":"Reservation","required":["id","position","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Unique identifier of the resource `Reservation`"},"position":{"title":"position","type":"integer","description":"Position of reservation","example":40},"type":{"title":"type","type":"string","description":"Type of reservation","example":"patch_panel"}}},"6a791d9b_api_domain_dnssec_data":{"title":"DNSSEC data","required":["algorithm"],"type":"object","properties":{"key":{"title":"key","type":"string","description":"The DNSSEC key identifier"},"flags":{"title":"flags","type":"string","description":"The DNSSEC flags"},"protocol":{"title":"protocol","type":"string","description":"The DNSSEC protocol used to generate the public key"},"algorithm":{"title":"algorithm","type":"string","description":"The algorithm used to generate the public key"},"public_key":{"title":"public_key","type":"string","description":"The DNSSEC public key"},"digest_type":{"title":"digest_type","type":"string","description":"The type of digest used to generate the public key"},"digest":{"title":"digest","type":"string","description":"The digest key"}}},"6a791d9b_api_domain_tld":{"title":"Tld","required":["for_sale","id","tld"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Tld`"},"tld":{"title":"tld","type":"string"},"for_sale":{"title":"for_sale","type":"string"}}},"2f8071fd_api_dns_dns_record":{"title":"Dns record","required":["id","source","target","ttl","type","updated_at"],"type":"object","properties":{"id":{"title":"id","type":"integer","description":"The identifier of the dns record"},"source":{"title":"source","type":"string","description":"The source of the dns record"},"source_idn":{"title":"source_idn","type":"string","description":"The full idn of the dns record"},"type":{"title":"type","enum":["A","AAAA","CAA","CNAME","DNAME","DNSKEY","DS","MX","NS","PTR","SMIMEA","SOA","SRV","SSHFP","TLSA","TXT"],"type":"string","description":"The type of the dns record"},"ttl":{"title":"ttl","type":"integer","description":"The TTL of the dns record"},"target":{"title":"target","type":"string","description":"The dns record target"},"updated_at":{"title":"updated_at","type":"integer","description":"The last updated time of the dns record","format":"timestamp"},"dyndns_id":{"title":"dyndns_id","type":"integer","description":"If any, the dyndns user identifier related to the dns record"},"delegated_zone":{"$ref":"#\/components\/schemas\/2f8071fd_api_dns_api_resource"},"description":{"$ref":"#\/components\/schemas\/2f8071fd_api_dns_dns_record_description"}}},"2f8071fd_api_dns_api_resource":{"title":"Api Resource","required":["id","uri"],"type":"object","properties":{"id":{"title":"id","type":"object","oneOf":[{"title":"integer","type":"integer"},{"title":"string","type":"string"}],"description":"Unique identifier"},"uri":{"title":"uri","type":"string","description":"API endpoint of this resource"}}},"2f8071fd_api_dns_dns_record_description":{"title":"Dns record description","type":"object","properties":{"priority":{"title":"priority","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with MX and SRV dns record, the priority attribute of the dns record"},"port":{"title":"port","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SRV dns record, the port attribute of the dns record"},"weight":{"title":"weight","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SRV dns record, the weight attribute of the dns record"},"protocol":{"title":"protocol","type":"object","properties":{"value":{"title":"value","type":"string","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SRV and DNSKEY dns record, the protocol attribute of the dns record"},"flags":{"title":"flags","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with CAA and DNSKEY dns record, the flags attribute of the dns record"},"tag":{"title":"tag","type":"object","properties":{"value":{"title":"value","type":"string","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with CAA dns record, the tag attribute of the dns record"},"usage":{"title":"usage","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with TLSA or SMIMEA dns record, the usage attribute of the dns record"},"selector":{"title":"selector","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with TLSA or SMIMEA dns record, the selector attribute of the dns record"},"matching_type":{"title":"matching_type","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with TLSA, SSHFP or SMIMEA dns record, the matching type attribute of the dns record"},"algorithm":{"title":"algorithm","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SSHFP, DS and DNSKEY dns record, the algorithm attribute of the dns record"},"key_tag":{"title":"key_tag","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with DS dns record, the key tag attribute of the dns record"},"digest_type":{"title":"digest_type","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with DS dns record, the digest type attribute of the dns record"},"digest":{"title":"digest","type":"object","properties":{"value":{"title":"value","type":"string","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with DS dns record, the digest type attribute of the dns record"},"mname":{"title":"mname","type":"object","properties":{"value":{"title":"value","type":"string","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SOA dns record, the mname attribute of the dns record"},"rname":{"title":"rname","type":"object","properties":{"value":{"title":"value","type":"string","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SOA dns record, the rname attribute of the dns record"},"serial":{"title":"serial","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SOA dns record, the serial attribute of the dns record"},"refresh":{"title":"refresh","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SOA dns record, the refresh attribute of the dns record"},"retry":{"title":"retry","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SOA dns record, the retry attribute of the dns record"},"expire":{"title":"expire","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SOA dns record, the expire attribute of the dns record"},"minimum_ttl":{"title":"minimum_ttl","type":"object","properties":{"value":{"title":"value","type":"integer","description":"The value of the attribute"},"label":{"title":"label","type":"string","description":"The human readable value of the attribute"}},"description":"Only available with SOA dns record, the minimum ttl attribute of the dns record"}},"description":"The description of the dns record"},"2f8071fd_api_dns_dns_record_data":{"title":"Dns record Data","required":["source","target","type"],"type":"object","properties":{"source":{"title":"source","type":"string","description":"The source of the dns record"},"source_idn":{"title":"source_idn","type":"string","description":"The full idn of the dns record"},"type":{"title":"type","enum":["A","AAAA","CAA","CNAME","DNAME","DNSKEY","DS","MX","NS","PTR","SMIMEA","SOA","SRV","SSHFP","TLSA","TXT"],"type":"string","description":"The type of the dns record"},"ttl":{"title":"ttl","type":"integer","description":"The TTL of the dns record"},"target":{"title":"target","type":"string","description":"The dns record target"},"description":{"$ref":"#\/components\/schemas\/2f8071fd_api_dns_dns_record_description"}}},"087adaad_User":{"title":"User","required":["avatar","display_name","email","first_name","id","is_sso","last_name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `User`"},"display_name":{"title":"display_name","type":"string","description":"Display name"},"first_name":{"title":"first_name","type":"string","description":"First name"},"last_name":{"title":"last_name","type":"string","description":"Last name"},"email":{"title":"email","type":"string","description":"Email"},"is_sso":{"title":"is_sso","type":"boolean","description":"returns true if the user is provided by an external IDP"},"avatar":{"title":"avatar","type":"string","description":"null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar","nullable":true},"type":{"title":"type","type":"string"}}},"087adaad_Servicepermissions":{"title":"Service permissions","required":["rights","service_id","service_name"],"type":"object","properties":{"service_id":{"title":"service_id","type":"integer","description":"Unique identifier of the `service` that is related to the resource `Service permissions`"},"service_name":{"title":"service_name","type":"string","description":"Name of the service","example":"swiss_backup"},"rights":{"title":"rights","enum":["check","sale","statistic","technical"],"type":"string"}}},"087adaad_Team_7471c6bd":{"title":"Team","required":["color_id","created_at","id","name","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Team`"},"name":{"title":"name","type":"string","description":"Name of the resource `Team`"},"color_id":{"title":"color_id","type":"integer","description":"Unique identifier of the `color` of the resource `Team`"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Team` has been created","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Team` has been updated","format":"timestamp"},"user_count":{"title":"user_count","type":"integer","description":"User count related to the resource `Team`"}}},"087adaad_Partner":{"title":"Partner","required":["budget_max","budget_min","created_at","email","id","image","is_active","is_premium","is_privileged","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Partner`","example":414},"name":{"title":"name","type":"string","description":"Name of the resource `Partner`","example":"The WebAgency"},"image":{"title":"image","type":"string"},"is_active":{"title":"is_active","type":"boolean","example":true},"budget_min":{"title":"budget_min","type":"integer","example":100},"budget_max":{"title":"budget_max","type":"integer","example":2000},"email":{"title":"email","type":"string","description":"Email","example":"partner@infomaniak.com"},"is_premium":{"title":"is_premium","type":"boolean","example":true},"is_privileged":{"title":"is_privileged","type":"boolean","example":true},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Partner` has been created","format":"timestamp"},"description":{"title":"description","type":"string","description":"Description of the resource `Partner`"},"description_en":{"title":"description_en","type":"string"},"description_de":{"title":"description_de","type":"string"},"description_it":{"title":"description_it","type":"string"},"description_es":{"title":"description_es","type":"string"},"addresses":{"title":"addresses","type":"array"},"skills":{"title":"skills","type":"array"},"skills_by_domain":{"title":"skills_by_domain","type":"array"},"skills_by_activity":{"title":"skills_by_activity","type":"array"},"references":{"title":"references","type":"string"},"certifications":{"title":"certifications","type":"array"},"languages":{"title":"languages","type":"array"},"available_languages":{"title":"available_languages","type":"array"},"tenders":{"title":"tenders","type":"string"},"opinions":{"title":"opinions","type":"string"},"messages":{"title":"messages","type":"string"},"note":{"title":"note","type":"number"},"medal":{"title":"medal","type":"string","nullable":true},"products":{"title":"products","type":"array"},"invoices":{"title":"invoices","type":"array"}}},"087adaad_RoleRight":{"title":"RoleRight","required":["created_at","rights","role_id"],"type":"object","properties":{"role_id":{"title":"role_id","type":"integer"},"service_id":{"title":"service_id","type":"integer","description":"Unique identifier of the `service` that is related to the resource `RoleRight`"},"product_id":{"title":"product_id","type":"integer","description":"Unique identifier of the `product` that is related to the resource `RoleRight`"},"product_unique_id":{"title":"product_unique_id","type":"integer"},"product_name":{"title":"product_name","type":"string"},"rights":{"title":"rights","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `RoleRight` has been created","format":"timestamp"}}},"087adaad_PartnershipIncomeTotal":{"title":"Partnership Income Total","required":["amount","currency"],"type":"object","properties":{"amount":{"title":"amount","type":"number"},"currency":{"title":"currency","type":"string","example":"CHF"}}},"087adaad_Account":{"title":"Account","required":["beta","blocked_order_id","created_at","has_2fa_required","id","in_process","is_customer","is_sso","language_id","legal_entity_type","locale","name","support_level","waiting_payment"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Account`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Account`","example":"Secret Organization"},"legal_entity_type":{"title":"legal_entity_type","enum":["company","individual","public_body","restrict"],"type":"string","example":"company"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Account` has been created","format":"timestamp","example":1294959600},"addresses":{"title":"addresses","type":"array","items":{"$ref":"#\/components\/schemas\/087adaad_Accountaddress","schema":[]}},"timezone":{"title":"timezone","type":"string","example":"Europe\/Zurich"},"website":{"title":"website","type":"string","example":"https:\/\/www.infomaniak.com"},"phone":{"title":"phone","type":"string","example":"+41790000000"},"fax":{"title":"fax","type":"string","example":"+41220000000"},"language":{"title":"language","type":"string"},"locale":{"title":"locale","type":"string","description":"Represents a language identifier and a region identifier","example":"fr_FR"},"language_id":{"title":"language_id","type":"integer","description":"Unique identifier of the `language` that is related to the resource `Account`","example":1},"logo":{"title":"logo","type":"string","example":"https:\/\/www.infomaniak.com\/img\/common\/logo-infomaniak.svg"},"logo_square":{"title":"logo_square","type":"string","example":"https:\/\/www.infomaniak.com\/img\/common\/logo-infomaniak.svg"},"order":{"title":"order","type":"object","properties":{"waiting_payment":{"title":"waiting_payment","type":"integer","example":1},"in_process":{"title":"in_process","type":"integer","example":0},"blocked_order_id":{"title":"blocked_order_id","type":"array"}}},"beta":{"title":"beta","type":"boolean","example":true},"support_level":{"title":"support_level","type":"integer","example":1},"has_2fa_required":{"title":"has_2fa_required","type":"boolean"},"type":{"title":"type","type":"string","example":"owner"},"billing":{"title":"billing","type":"boolean","example":true},"mailing":{"title":"mailing","type":"boolean","example":true},"billing_mailing":{"title":"billing_mailing","type":"boolean","example":true},"workspace_only":{"title":"workspace_only","type":"boolean","example":true},"no_access":{"title":"no_access","type":"boolean","example":true},"is_blocked":{"title":"is_blocked","type":"boolean","example":true},"blocked_at":{"title":"blocked_at","type":"integer","format":"timestamp","example":0},"vat_number":{"title":"vat_number","type":"string","example":""},"field1":{"title":"field1","type":"string","example":""},"field2":{"title":"field2","type":"string","example":""},"tags":{"title":"tags","type":"array","items":{"$ref":"#\/components\/schemas\/087adaad_Tag","schema":[]}},"services_already_demo":{"title":"services_already_demo","type":"array"},"customization_url":{"title":"customization_url","type":"object"},"nb_invitations":{"title":"nb_invitations","type":"integer","example":2},"nb_users":{"title":"nb_users","type":"integer","example":2},"count_owners":{"title":"count_owners","type":"integer","example":2},"is_customer":{"title":"is_customer","type":"boolean"},"is_sso":{"title":"is_sso","type":"boolean"},"has_full_access":{"title":"has_full_access","type":"boolean"},"has_customer_paiement_method":{"title":"has_customer_paiement_method","type":"boolean"},"partner_id":{"title":"partner_id","type":"integer"},"in_partnership_full_access":{"title":"in_partnership_full_access","type":"boolean"},"in_partnership_limited":{"title":"in_partnership_limited","type":"boolean"},"support_premium":{"title":"support_premium","type":"object"},"is_user_has_ksuite_access":{"title":"is_user_has_ksuite_access","type":"boolean"},"is_user_email_account_mailbox_exist":{"title":"is_user_email_account_mailbox_exist","type":"boolean"},"ksuite_id":{"title":"ksuite_id","type":"integer","description":"Unique identifier of the `ksuite` that is related to the resource `Account`","nullable":true},"my_ksuite":{"title":"my_ksuite","type":"object","nullable":true}}},"087adaad_Accountaddress":{"title":"Account address","required":["city","country","created_at","for_invoice","id","street","street2","type","zip"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Account address`","example":1234},"street":{"title":"street","type":"string","example":"Rue Eug\u00e8ne-Marziano 25"},"street2":{"title":"street2","type":"string","example":""},"zip":{"title":"zip","type":"string","example":"1227"},"city":{"title":"city","type":"string","example":"Gen\u00e8ve"},"type":{"title":"type","type":"string","example":"professional"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Account address` has been created","format":"timestamp","example":1558601584},"country":{"$ref":"#\/components\/schemas\/087adaad_Country","schema":[]},"for_invoice":{"title":"for_invoice","type":"boolean"}}},"087adaad_Tag":{"title":"Tag","required":["color","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Tag`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Tag`","example":"My tag name"},"color":{"title":"color","type":"integer","example":4},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource `Tag`","example":2}}},"087adaad_Country":{"title":"Country","required":["id","is_enabled","name","short_name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Country`","format":"int32","example":203},"name":{"title":"name","type":"string","description":"Name of the resource `Country`","example":"SWITZERLAND"},"short_name":{"title":"short_name","type":"string","description":"Short name of the resource `Country`","example":"CH"},"is_enabled":{"title":"is_enabled","type":"boolean","description":"Is the resource `Country` enabled?","example":true}}},"087adaad_PartnerInvitationData":{"title":"PartnerInvitationData","required":["full_access","partner_id"],"type":"object","properties":{"partner_id":{"title":"partner_id","type":"integer"},"full_access":{"title":"full_access","type":"boolean","description":"Describes the type of access the partner has on its client"},"products":{"title":"products","type":"array"}}},"087adaad_EventTag":{"title":"Event Tag","required":["id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Event Tag`","example":1},"name":{"title":"name","type":"string","description":"Name of the resource `Event Tag`","example":"hosting"},"type":{"$ref":"#\/components\/schemas\/087adaad_EventTag","schema":[]}}},"087adaad_applicationPublishedVersion":{"title":"applicationPublishedVersion","required":["build_min_os_version","build_version","data","download_link","tag","tag_updated_at","type","version_changelog"],"type":"object","properties":{"tag":{"title":"tag","type":"string","example":"1.0.1"},"tag_updated_at":{"title":"tag_updated_at","type":"string"},"version_changelog":{"title":"version_changelog","type":"string"},"type":{"title":"type","type":"string","example":"production"},"build_version":{"title":"build_version","type":"string"},"build_min_os_version":{"title":"build_min_os_version","type":"string"},"download_link":{"title":"download_link","type":"string","nullable":true},"data":{"title":"data","type":"array"}}},"087adaad_Right":{"title":"Right","type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"statistic":{"title":"statistic","type":"boolean"},"check":{"title":"check","type":"boolean"},"sale":{"title":"sale","type":"boolean"}}},"087adaad_Productstatus":{"title":"Product status","required":["activated_at","activated_by","infomaniak","locked","maintenance","superuser","technical"],"type":"object","properties":{"maintenance":{"title":"maintenance","type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"superuser":{"title":"superuser","type":"boolean"},"infomaniak":{"title":"infomaniak","type":"boolean"}}},"locked":{"title":"locked","type":"object","properties":{"superuser":{"title":"superuser","type":"boolean"},"infomaniak":{"title":"infomaniak","type":"boolean"}}},"activated_by":{"title":"activated_by","type":"array"},"activated_at":{"title":"activated_at","type":"integer","format":"timestamp"}}},"087adaad_ProductUser":{"title":"ProductUser","required":["rights","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer"},"rights":{"$ref":"#\/components\/schemas\/087adaad_Right","schema":[]}}},"087adaad_ProductAdminUser":{"title":"ProductAdminUser","required":["display_name","email","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer"},"email":{"title":"email","type":"string","description":"Email"},"display_name":{"title":"display_name","type":"string","description":"Display name"}}},"087adaad_PartnershipProductAccessUser":{"title":"Partnership Product Access User","required":["avatar_url","display_name","email","id","last_admin"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Partnership Product Access User`","example":12345},"display_name":{"title":"display_name","type":"string","description":"Display name","example":"Jane Smith"},"email":{"title":"email","type":"string","description":"Email","example":"jane.smith@email.ch"},"avatar_url":{"title":"avatar_url","type":"string","example":"https:\/\/infomaniak.com\/img\/company\/logos\/logo-k.svg"},"role":{"title":"role","type":"string","example":"admin"},"last_admin":{"title":"last_admin","type":"string","example":"true"}}},"087adaad_EventDescription":{"title":"Event Description","required":["description","title","translations"],"type":"object","properties":{"title":{"title":"title","type":"string","example":"Network maintenance"},"description":{"title":"description","type":"string","description":"Description of the resource `Event Description`","example":"This maintenance is intended to increase the capacity of our network infrastructure in order to accompany the growth of our activities."},"translations":{"title":"translations","type":"array","items":{"$ref":"#\/components\/schemas\/087adaad_EventTranslation","schema":[]}}}},"087adaad_EventComment":{"title":"Event Comment","required":["body","started_at","title","translations"],"type":"object","properties":{"title":{"title":"title","type":"string","example":"Network maintenance"},"body":{"title":"body","type":"string","example":"Maintenance details"},"started_at":{"title":"started_at","type":"integer","description":"Timestamp `Event Comment` has been started","format":"timestamp"},"translations":{"title":"translations","type":"array","items":{"$ref":"#\/components\/schemas\/087adaad_EventTranslation","schema":[]}}}},"087adaad_EventTranslation":{"title":"Event Translation","required":["body","language","title"],"type":"object","properties":{"title":{"title":"title","type":"string","example":"Network maintenance"},"body":{"title":"body","type":"string","example":"This maintenance is intended to increase the capacity of our network infrastructure in order to accompany the growth of our activities."},"language":{"title":"language","enum":["de","en","es","fr","it"],"type":"string","example":"en"}}},"087adaad_Usersession":{"title":"User session","required":["browser","device","ip","last_accessed_at","location","user_agent"],"type":"object","properties":{"browser":{"title":"browser","type":"string"},"last_accessed_at":{"title":"last_accessed_at","type":"integer","format":"timestamp"},"device":{"title":"device","type":"string"},"location":{"title":"location","type":"string"},"ip":{"title":"ip","type":"string"},"user_agent":{"title":"user_agent","type":"string"}}},"087adaad_Userauthdevice":{"title":"User auth device","required":["created_at","deleted_at","device","id","last_connexion","name","updated_at","user_agent","user_ip"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `User auth device`"},"name":{"title":"name","type":"string","description":"Name of the resource `User auth device`"},"last_connexion":{"title":"last_connexion","type":"integer","format":"timestamp"},"user_agent":{"title":"user_agent","type":"string"},"user_ip":{"title":"user_ip","type":"string"},"device":{"title":"device","type":"string"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `User auth device` has been created","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `User auth device` has been updated","format":"timestamp"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `User auth device` has been deleted","format":"timestamp"}}},"087adaad_Userconnection":{"title":"User connection","required":["successful_notification","unsuccessful_limit","unsuccessful_notification","unsuccessful_rate_limit"],"type":"object","properties":{"unsuccessful_limit":{"title":"unsuccessful_limit","type":"boolean"},"unsuccessful_rate_limit":{"title":"unsuccessful_rate_limit","type":"integer"},"unsuccessful_notification":{"title":"unsuccessful_notification","type":"boolean"},"successful_notification":{"title":"successful_notification","type":"boolean"}}},"087adaad_Language":{"title":"Language","required":["id","locale","name","short_locale","short_name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Language`","example":2},"name":{"title":"name","type":"string","description":"Name of the resource `Language`","example":"English"},"short_name":{"title":"short_name","type":"string","description":"Short name of the resource `Language`","example":"E"},"locale":{"title":"locale","type":"string","description":"Represents a language identifier and a region identifier","example":"en_GB"},"short_locale":{"title":"short_locale","type":"string","description":"Represents a language identifier","example":"en"}}},"087adaad_Timezone":{"title":"Timezone","required":["gmt","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Timezone`","example":414},"name":{"title":"name","type":"string","description":"Name of the resource `Timezone`","example":"Europe\/Zurich"},"gmt":{"title":"gmt","type":"string","description":"Greenwich Mean Time (GMT)","example":"01:00"}}},"087adaad_Userphone":{"title":"User phone","required":["checked","created_at","id","phone","reminder","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `User phone`","example":2},"phone":{"title":"phone","type":"string","example":"+41123456789"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `User phone` has been created","format":"timestamp","example":1632896634},"reminder":{"title":"reminder","type":"string","example":"true"},"checked":{"title":"checked","type":"boolean","example":true},"type":{"title":"type","type":"string","example":"phone"}}},"087adaad_Useremail":{"title":"User email","required":["checked","created_at","email","id","reminder","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `User email`","example":123456},"email":{"title":"email","type":"string","description":"Email","example":"john.doe@infomaniak.com"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `User email` has been created","format":"timestamp","example":1632815150},"reminder":{"title":"reminder","type":"boolean","example":true},"checked":{"title":"checked","type":"boolean","example":true},"type":{"title":"type","enum":["other","personal","professional"],"type":"string","example":"other"}}},"087adaad_Useremail_f4611cfe":{"title":"User email","required":["checked","created_at","email","id","reminder","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `User email`"},"email":{"title":"email","type":"string","description":"Email","example":"tony@stark-industries.com"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `User email` has been created","format":"timestamp"},"reminder":{"title":"reminder","type":"boolean","example":true},"checked":{"title":"checked","type":"boolean"},"type":{"title":"type","type":"string","example":"email_request"}}},"087adaad_Country_e76d7464":{"title":"Country","required":["enabled","id","name","short"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Country`","format":"int32","example":203},"short":{"title":"short","type":"string","example":"CH"},"name":{"title":"name","type":"string","description":"Name of the resource `Country`","example":"SWITZERLAND"},"enabled":{"title":"enabled","type":"boolean","example":true}}},"087adaad_Usersecretquestion":{"title":"User secret question","required":["secret_answer","secret_question_id"],"type":"object","properties":{"secret_question_id":{"title":"secret_question_id","type":"integer"},"secret_answer":{"title":"secret_answer","type":"string"}}},"071b12a8_AIPrice":{"title":"AI Price","required":["currency_id","label","unit"],"type":"object","properties":{"label":{"title":"label","type":"string"},"model":{"title":"model","type":"string"},"input_amount_excl_vat":{"title":"input_amount_excl_vat","type":"number"},"output_amount_excl_vat":{"title":"output_amount_excl_vat","type":"number"},"amount_excl_vat":{"title":"amount_excl_vat","type":"number"},"currency_id":{"title":"currency_id","type":"integer"},"unit":{"title":"unit","type":"array"}}},"071b12a8_AiModel-meta":{"title":"AiModel-meta","required":["is_beta"],"type":"object","properties":{"is_beta":{"title":"is_beta","type":"boolean","description":"true if the model is in **beta** and is subject to changes, see the [General Terms and Conditions](https:\/\/www.infomaniak.com\/gtl\/rgpd.documents)"}},"description":"Various meta information about the model"},"071b12a8_Base64image":{"title":"Base64 image","required":["b64_json","revised_prompt"],"type":"object","properties":{"b64_json":{"title":"b64_json","type":"string","description":"Base64 format image"},"revised_prompt":{"title":"revised_prompt","type":"string","description":"We are not currently revising the input prompt"}},"description":"Base64 image"},"071b12a8_OpenAI-model-object":{"title":"OpenAI-model-object","required":["created","id","object","owned_by"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"The model identifier, which can be referenced in the API endpoints.","example":"qwen3"},"object":{"title":"object","type":"string","description":"The object type, which is always `model`.","example":"model"},"created":{"title":"created","type":"integer","description":"The Unix timestamp (in seconds) when the model was created.","format":"timestamp","example":1742971676},"owned_by":{"title":"owned_by","type":"string","description":"The organization that owns the model.","example":"system"}},"description":"Describes a model that can be used with the API."},"071b12a8_Choice_8fc99c63":{"title":"Choice","required":["finish_reason","index","logprobs"],"type":"object","properties":{"index":{"title":"index","type":"integer"},"message":{"$ref":"#\/components\/schemas\/071b12a8_Message"},"delta":{"$ref":"#\/components\/schemas\/071b12a8_Choice"},"logprobs":{"$ref":"#\/components\/schemas\/071b12a8_Logprobability_c61983bb"},"finish_reason":{"title":"finish_reason","type":"string","description":"The reason the model stopped generating tokens","nullable":true,"example":"eos_token"}},"description":"A completion choices."},"071b12a8_Usage":{"title":"Usage","required":["completion_tokens","completion_tokens_details","input_tokens","output_tokens","prompt_tokens","prompt_tokens_details","total_tokens"],"type":"object","properties":{"input_tokens":{"title":"input_tokens","type":"integer","description":"Number of tokens in the prompt."},"output_tokens":{"title":"output_tokens","type":"integer","description":"Number of tokens in the generated completion.","nullable":true},"prompt_tokens":{"title":"prompt_tokens","type":"integer","description":"Number of tokens in the prompt."},"completion_tokens":{"title":"completion_tokens","type":"integer","description":"Number of tokens in the generated completion.","nullable":true},"total_tokens":{"title":"total_tokens","type":"integer","description":"Total number of tokens used in the request (input+output)."},"prompt_tokens_details":{"title":"prompt_tokens_details","type":"string","description":"Detailed breakdown of prompt tokens."},"completion_tokens_details":{"title":"completion_tokens_details","type":"string","description":"Detailed breakdown of completion tokens."}}},"071b12a8_Message":{"title":"Message","required":["content","role"],"type":"object","properties":{"role":{"title":"role","enum":["assistant","developer","system","tool","user"],"type":"string","description":"The role of the author of this message.","example":"assistant"},"content":{"title":"content","type":"string","description":"The contents of the message."}}},"071b12a8_Choice":{"title":"Choice","required":["content","role"],"type":"object","properties":{"role":{"title":"role","type":"string"},"content":{"title":"content","type":"string"}},"description":"A completion choices."},"071b12a8_Logprobability_c61983bb":{"title":"Log probability","required":["content"],"type":"object","properties":{"content":{"title":"content","type":"array","items":{"$ref":"#\/components\/schemas\/071b12a8_Logprobability"},"description":"A list of message content tokens with log probability information.","nullable":true}},"description":"Log probability information for the choice."},"071b12a8_Logprobability":{"title":"Log probability","required":["bytes","logprob","token","top_logprobs"],"type":"object","properties":{"token":{"title":"token","type":"string","description":"The token."},"logprob":{"title":"logprob","type":"number","description":"The log probability of this token"},"bytes":{"title":"bytes","type":"array","items":{"type":"integer","title":"bytes","description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token."},"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.","nullable":true},"top_logprobs":{"title":"top_logprobs","type":"array","items":{"$ref":"#\/components\/schemas\/071b12a8_Mostlikelytoken"},"description":"List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned."}},"description":"Log probability information for the choice."},"071b12a8_Mostlikelytoken":{"title":"Most likely token","required":["bytes","logprob","token"],"type":"object","properties":{"token":{"title":"token","type":"string","description":"The token."},"bytes":{"title":"bytes","type":"array","items":{"type":"integer","title":"bytes","description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token."},"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.","nullable":true},"logprob":{"title":"logprob","type":"number","description":"The log probability of this token"}},"description":"most likely token and their log probability"},"071b12a8_Embeddingobject":{"title":"Embedding object","required":["embedding","index","object"],"type":"object","properties":{"index":{"title":"index","type":"integer","description":"The index of the embedding in the list of embeddings."},"object":{"title":"object","type":"string","description":"The object type, which is always \"embedding\".","example":"embedding"},"embedding":{"title":"embedding","type":"array","items":{"type":"number","title":"embedding","description":"The embedding vector, which is a list of floats."},"description":"The embedding vector, which is a list of floats."}},"description":"An embedding object"},"071b12a8_EmbeddingResponse":{"title":"Embedding Response","required":["prompt_tokens","total_tokens"],"type":"object","properties":{"prompt_tokens":{"title":"prompt_tokens","type":"integer","description":"Number of tokens in the prompt"},"total_tokens":{"title":"total_tokens","type":"integer","description":"Number of tokens in total"}},"description":"Usage statistics for embedding request"},"071b12a8_Embeddingobjectbase64":{"title":"Embedding object base64","required":["embedding","index","object"],"type":"object","properties":{"index":{"title":"index","type":"integer","description":"The index of the embedding in the list of embeddings."},"object":{"title":"object","type":"string","description":"The object type, which is always \"embedding\".","example":"embedding"},"embedding":{"title":"embedding","type":"string","description":"The embedding vector, which is a list of floats."}},"description":"An embedding object formated in base64"},"071b12a8_Speech-to-TextSegment":{"title":"Speech-to-Text Segment","required":["avg_logprob","compression_ratio","end","id","no_speech_prob","seek","start","temperature","text","tokens"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the segment."},"seek":{"title":"seek","type":"integer","description":"Seek offset of the segment."},"start":{"title":"start","type":"number","description":"Start time of the segment in seconds.","example":14.26},"end":{"title":"end","type":"number","description":"End time of the segment in seconds.","example":38.04},"text":{"title":"text","type":"string","description":"Text content of the segment.","example":"My transcription"},"tokens":{"title":"tokens","type":"array","items":{"type":"integer","title":"tokens","description":"Array of token IDs for the text content."},"description":"Array of token IDs for the text content."},"temperature":{"title":"temperature","type":"number","description":"Temperature parameter used for generating the segment."},"avg_logprob":{"title":"avg_logprob","type":"number","description":"Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.","example":-0.059655232719429},"compression_ratio":{"title":"compression_ratio","type":"number","description":"Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.","example":1.7109826589595},"no_speech_prob":{"title":"no_speech_prob","type":"number","description":"Probability of no speech in the segment. If the value is higher than 1.0 and the avg_logprob is below -1, consider this segment silent.","example":0.0081787109375}},"description":"A transcription segment."},"071b12a8_Speech-to-TextWordtimestamp":{"title":"Speech-to-Text Word timestamp","required":["end","start","word"],"type":"object","properties":{"start":{"title":"start","type":"number","description":"Start time of the word in seconds.","example":14.26},"end":{"title":"end","type":"number","description":"End time of the word in seconds.","example":38.04},"word":{"title":"word","type":"string","description":"The text content of the word.","example":"Infomaniak"}},"description":"World level timestamp for speech-to-text response."},"071b12a8_Tag":{"title":"Tag","required":["color","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Tag`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Tag`","example":"My tag name"},"color":{"title":"color","type":"integer","example":4},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource `Tag`","example":2}}},"071b12a8_Right":{"title":"Right","type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"statistic":{"title":"statistic","type":"boolean"},"check":{"title":"check","type":"boolean"},"sale":{"title":"sale","type":"boolean"}}},"071b12a8_Productstatus":{"title":"Product status","required":["activated_at","activated_by","locked","maintenance"],"type":"object","properties":{"maintenance":{"title":"maintenance","required":["infomaniak","superuser","technical"],"type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"superuser":{"title":"superuser","type":"boolean"},"infomaniak":{"title":"infomaniak","type":"boolean"}}},"locked":{"title":"locked","required":["infomaniak","superuser"],"type":"object","properties":{"superuser":{"title":"superuser","type":"boolean"},"infomaniak":{"title":"infomaniak","type":"boolean"}}},"activated_by":{"title":"activated_by","type":"array"},"activated_at":{"title":"activated_at","type":"integer","format":"timestamp"}}},"071b12a8_ProductUser":{"title":"ProductUser","required":["rights","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer"},"rights":{"$ref":"#\/components\/schemas\/071b12a8_Right"}}},"071b12a8_ProductAdminUser":{"title":"ProductAdminUser","required":["display_name","email","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer"},"email":{"title":"email","type":"string","description":"Email"},"display_name":{"title":"display_name","type":"string","description":"Display name"}}},"071b12a8_AIconfigusage":{"title":"AI config usage","required":["currency_id","current_value","limitation_value","max_limitation_value","min_limitation_value"],"type":"object","properties":{"currency_id":{"title":"currency_id","type":"integer"},"current_value":{"title":"current_value","type":"integer"},"limitation_value":{"title":"limitation_value","type":"integer"},"min_limitation_value":{"title":"min_limitation_value","type":"integer"},"max_limitation_value":{"title":"max_limitation_value","type":"integer"}},"description":"Consumption"},"071b12a8_AiDiscount":{"title":"Ai Discount","required":["end_at","max_credit_count","start_at","used_credit_count"],"type":"object","properties":{"start_at":{"title":"start_at","type":"integer","format":"timestamp"},"end_at":{"title":"end_at","type":"integer","format":"timestamp"},"used_credit_count":{"title":"used_credit_count","type":"integer"},"max_credit_count":{"title":"max_credit_count","type":"integer"}}},"071b12a8_OpenAI-choices":{"title":"OpenAI-choices","required":["finish_reason","index","logprobs","message"],"type":"object","properties":{"index":{"title":"index","type":"integer","description":"The index of the choice in the list of choices."},"message":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-message"},"logprobs":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-logprobs"},"finish_reason":{"title":"finish_reason","type":"string","description":"The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function."}},"description":"A list of chat completion choices. Can be more than one if `n` is greater than 1."},"071b12a8_OpenAI-chat-completions-usage":{"title":"OpenAI-chat-completions-usage","required":["completion_tokens","completion_tokens_details","prompt_tokens","prompt_tokens_details","total_tokens"],"type":"object","properties":{"prompt_tokens":{"title":"prompt_tokens","type":"integer","description":"Number of tokens in the prompt."},"completion_tokens":{"title":"completion_tokens","type":"integer","description":"Number of tokens in the generated completion."},"total_tokens":{"title":"total_tokens","type":"integer","description":"Total number of tokens used in the request (prompt + completion)."},"prompt_tokens_details":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-usage-prompt-tokens-details"},"completion_tokens_details":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-usage-completion-tokens-details"}},"description":"Usage statistics for the completion request."},"071b12a8_OpenAI-message":{"title":"OpenAI-message","required":["annotations","content","refusal","role"],"type":"object","properties":{"role":{"title":"role","type":"string","description":"The role of the author of this message."},"content":{"title":"content","type":"string","description":"The contents of the message."},"refusal":{"title":"refusal","type":"string","description":"The refusal message generated by the model.","nullable":true},"annotations":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-annotations"}},"description":"A chat completion message generated by the model."},"071b12a8_OpenAI-logprobs":{"title":"OpenAI-logprobs","required":["content","refusal"],"type":"object","properties":{"content":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-content"},"refusal":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-refusal"}},"description":"Log probability information for the choice."},"071b12a8_OpenAI-annotations":{"title":"OpenAI-annotations","required":["type","url_citation"],"type":"object","properties":{"type":{"title":"type","type":"string","description":"The type of the URL citation. Always `url_citation`.","example":"url_citation"},"url_citation":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-url_citation"}},"description":"Annotations for the message, when applicable, as when using the *web search tool*."},"071b12a8_OpenAI-url_citation":{"title":"OpenAI-url_citation","required":["end_index","start_index","title","url"],"type":"object","properties":{"end_index":{"title":"end_index","type":"integer","description":"The index of the last character of the URL citation in the message."},"start_index":{"title":"start_index","type":"integer","description":"The index of the first character of the URL citation in the message."},"title":{"title":"title","type":"string","description":"The title of the web resource."},"url":{"title":"url","type":"integer","description":"The URL of the web resource."}},"description":"A URL citation when using web search."},"071b12a8_OpenAI-content":{"title":"OpenAI-content","required":["bytes","logprob","token","top_logprobs"],"type":"object","properties":{"bytes":{"title":"bytes","type":"array","items":{"type":"integer","title":"bytes","description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."},"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."},"logprob":{"title":"logprob","type":"number","description":"The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."},"token":{"title":"token","type":"string","description":"The token."},"top_logprobs":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-top-logprobs"}},"description":"A list of message content tokens with log probability information."},"071b12a8_OpenAI-refusal":{"title":"OpenAI-refusal","required":["bytes","logprob","token","top_logprobs"],"type":"object","properties":{"bytes":{"title":"bytes","type":"array","items":{"type":"integer","title":"bytes","description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."},"description":"A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."},"logprob":{"title":"logprob","type":"number","description":"The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."},"token":{"title":"token","type":"string","description":"The token."},"top_logprobs":{"$ref":"#\/components\/schemas\/071b12a8_OpenAI-top-logprobs"}},"description":"A list of message refusal tokens with log probability information."},"071b12a8_OpenAI-top-logprobs":{"title":"OpenAI-top-logprobs","required":["bytes","logprob","token"],"type":"object","properties":{"bytes":{"title":"bytes","type":"array","items":{"type":"integer","title":"bytes"}},"logprob":{"title":"logprob","type":"number","description":"The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."},"token":{"title":"token","type":"string","description":"The token."}},"description":"List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned."},"071b12a8_OpenAI-usage-prompt-tokens-details":{"title":"OpenAI-usage-prompt-tokens-details","required":["audio_tokens","cached_tokens"],"type":"object","properties":{"audio_tokens":{"title":"audio_tokens","type":"integer","description":"Audio input tokens present in the prompt."},"cached_tokens":{"title":"cached_tokens","type":"integer","description":"Cached tokens present in the prompt."}},"description":"Breakdown of tokens used in the prompt."},"071b12a8_OpenAI-usage-completion-tokens-details":{"title":"OpenAI-usage-completion-tokens-details","required":["accepted_prediction_tokens","audio_tokens","reasoning_tokens","rejected_prediction_tokens"],"type":"object","properties":{"accepted_prediction_tokens":{"title":"accepted_prediction_tokens","type":"integer","description":"When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion."},"audio_tokens":{"title":"audio_tokens","type":"integer","description":"Audio input tokens generated by the model."},"reasoning_tokens":{"title":"reasoning_tokens","type":"integer","description":"Tokens generated by the model for reasoning."},"rejected_prediction_tokens":{"title":"rejected_prediction_tokens","type":"integer","description":"When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits."}},"description":"Breakdown of tokens used in a completion"},"071b12a8_OpenAI-embedding-object":{"title":"OpenAI-embedding-object","required":["embedding","index","object"],"type":"object","properties":{"object":{"title":"object","type":"string","description":"The object type, which is always `embedding`.","example":"embedding"},"embedding":{"title":"embedding","type":"array","items":{"type":"number","title":"embedding","description":"The embedding vector, which is a list of floats. The length of vector depends on the model."},"description":"The embedding vector, which is a list of floats. The length of vector depends on the model."},"index":{"title":"index","type":"integer","description":"The index of the embedding in the list of embeddings."}},"description":"Represents an embedding vector returned by embedding endpoint."},"071b12a8_OpenAI-embeddings-usage":{"title":"OpenAI-embeddings-usage","required":["prompt_tokens","total_tokens"],"type":"object","properties":{"prompt_tokens":{"title":"prompt_tokens","type":"integer","description":"Number of tokens in the prompt."},"total_tokens":{"title":"total_tokens","type":"integer","description":"Total number of tokens used in the request, same as `prompt_tokens` for embeddings."}},"description":"Usage statistics for the embeddings request."},"91ac10ff_Drive":{"title":"Drive","required":["account_admin","account_id","created_at","current","expired_at","id","in_maintenance","is_demo","is_in_app_subscription","is_locked","maintenance_at","max","name","product_id","role","size","status","updated_at","used_size","users_count","users_quota","version"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Id of the kDrive"},"name":{"title":"name","type":"string","description":"Name of the kDrive"},"size":{"title":"size","type":"integer","description":"Maximum space (in bytes)"},"used_size":{"title":"used_size","type":"integer","description":"Used space (in bytes)"},"created_at":{"title":"created_at","type":"integer","description":"Creation timestamp","format":"timestamp","nullable":true},"updated_at":{"title":"updated_at","type":"integer","description":"Last update timestamp","format":"timestamp","nullable":true},"in_maintenance":{"title":"in_maintenance","type":"boolean","description":"When maintenance is activated"},"maintenance_reason":{"title":"maintenance_reason","enum":["demo_end","invoice_overdue","not_renew","technical"],"type":"string","description":"Reason of Drive maintenance.<note>demo_end<\/strong>: The demonstration period of the Drive has come to an end.<\/note><note>invoice_overdue<\/strong>: An invoice for this Drive is currently unpaid.<\/note><note>not_renew<\/strong>: This Drive has expired and must be renewed.<\/note>","example":"demo_end"},"maintenance_at":{"title":"maintenance_at","type":"integer","description":"When maintenance was activated at","format":"timestamp","nullable":true},"maintenance_types":{"title":"maintenance_types","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_MaintenanceType"},"description":"Lists active Maintenance Types."},"version":{"title":"version","type":"string","description":"Backend version"},"users_count":{"title":"users_count","type":"integer","description":"Number of user slots used"},"users_quota":{"title":"users_quota","type":"integer","description":"Maximum number of users for this kdrive"},"product_id":{"title":"product_id","type":"integer","description":"Unique id of the kDrive product"},"account_id":{"title":"account_id","type":"integer","description":"Id of the account in which the kDrive is"},"account":{"title":"account","type":"string","description":"Account the Drive belongs to."},"expired_at":{"title":"expired_at","type":"integer","description":"Product expiration timestamp","format":"timestamp","nullable":true},"is_locked":{"title":"is_locked","type":"boolean","description":"If the product is locked"},"description":{"title":"description","type":"string","description":"Custom description of this kDrive"},"bill_reference":{"title":"bill_reference","type":"string","description":"Reference used for billing"},"is_demo":{"title":"is_demo","type":"boolean","description":"If the product is in free trial period"},"role":{"title":"role","enum":["admin","external","none","user"],"type":"string","description":"Role of the current user within this kDrive","example":"admin"},"account_admin":{"title":"account_admin","type":"boolean","description":"Whether user is an administrator of the current kDrive account"},"is_in_app_subscription":{"title":"is_in_app_subscription","type":"boolean","description":"Whether this drive has been purchased within an app store"},"rewind":{"$ref":"#\/components\/schemas\/91ac10ff_RewindV3"},"invitations_count":{"title":"invitations_count","type":"integer","description":"Number of pending invitation."},"categories":{"title":"categories","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Category"},"description":"All categories of the kDrive"},"categories_permissions":{"$ref":"#\/components\/schemas\/91ac10ff_Categorypermission"},"users":{"title":"users","type":"object","properties":{"account":{"title":"account","type":"array","items":{"type":"integer","title":"account","description":"Users identifiers of the account group"},"description":"Users identifiers of the account group"},"drive":{"title":"drive","type":"array","items":{"type":"integer","title":"drive","description":"Users identifiers of the kDrive"},"description":"Users identifiers of the kDrive"},"external":{"title":"external","type":"array","items":{"type":"integer","title":"external","description":"Users identifiers of the drive (only externals users)"},"description":"Users identifiers of the drive (only externals users)"},"internal":{"title":"internal","type":"array","items":{"type":"integer","title":"internal","description":"Users identifiers of the drive (only internal users)"},"description":"Users identifiers of the drive (only internal users)"}},"description":"All users identifiers by types"},"teams":{"title":"teams","type":"object","properties":{"account":{"title":"account","type":"array","items":{"type":"integer","title":"account","description":"Teams identifiers of the account group"},"description":"Teams identifiers of the account group"},"drive":{"title":"drive","type":"array","items":{"type":"integer","title":"drive","description":"Teams identifiers of the kDrive"},"description":"Teams identifiers of the kDrive"}},"description":"All teams identifiers by types"},"rights":{"$ref":"#\/components\/schemas\/91ac10ff_Right"},"tags":{"title":"tags","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Tag"},"description":"User defined tags on this kDrive"},"k_suite":{"$ref":"#\/components\/schemas\/91ac10ff_KSuite"},"capabilities":{"title":"capabilities","required":["can_add_user","can_rewind","can_see_stats","can_upgrade_to_ksuite","use_team_space","use_upload_compression","use_versioning"],"type":"object","properties":{"use_versioning":{"title":"use_versioning","type":"boolean","description":"Is versioning activated"},"use_upload_compression":{"title":"use_upload_compression","type":"boolean","description":"During upload compression is allowed"},"use_team_space":{"title":"use_team_space","type":"boolean","description":"Shared\/Team directory feature"},"can_add_user":{"title":"can_add_user","type":"boolean","description":"Can add an user in the kDrive"},"can_see_stats":{"title":"can_see_stats","type":"boolean","description":"Can see stats of the kDrive"},"can_upgrade_to_ksuite":{"title":"can_upgrade_to_ksuite","type":"boolean","description":"Can the drive be upgraded to a kSuite"},"can_rewind":{"title":"can_rewind","type":"boolean","description":"Can rewind the kDrive"}},"description":"The Drive available features list"},"settings":{"title":"settings","required":["ai_scan","max_keep_deleted_user","office","versioning"],"type":"object","properties":{"ai_scan":{"title":"ai_scan","required":["has_approved","has_approved_ai_categories","has_approved_content_search","is_enabled","updated_at"],"type":"object","properties":{"is_enabled":{"title":"is_enabled","type":"boolean","description":"Is AI scanning enabled"},"has_approved":{"title":"has_approved","type":"boolean","description":"Is AI scanning approved","nullable":true},"has_approved_ai_categories":{"title":"has_approved_ai_categories","type":"boolean","description":"Are AI categories approved","nullable":true},"has_approved_content_search":{"title":"has_approved_content_search","type":"boolean","description":"Is file content search approved","nullable":true},"updated_at":{"title":"updated_at","type":"integer","description":"When AI scanning was approved at","format":"timestamp","nullable":true}}},"versioning":{"title":"versioning","required":["max_days","max_numbers"],"type":"object","properties":{"max_numbers":{"title":"max_numbers","type":"integer","description":"Number of versions that can be kept if active"},"max_days":{"title":"max_days","type":"integer","description":"Maximum number of days versions are kept"}}},"office":{"title":"office","required":["default_mode","presentation","spreadsheet","text"],"type":"object","properties":{"presentation":{"title":"presentation","enum":["365","collabora","onlyoffice"],"type":"string","description":"Default current application for presentation document.<note>365<\/strong>: The 365 application.<\/note><note>collabora<\/strong>: The collabora application.<\/note><note>onlyoffice<\/strong>: The onlyoffice application.<\/note>","example":"365"},"spreadsheet":{"title":"spreadsheet","enum":["365","collabora","onlyoffice"],"type":"string","description":"Default current application for spreadsheet document.<note>365<\/strong>: The 365 application.<\/note><note>collabora<\/strong>: The collabora application.<\/note><note>onlyoffice<\/strong>: The onlyoffice application.<\/note>","example":"365"},"text":{"title":"text","enum":["365","collabora","onlyoffice"],"type":"string","description":"Default current application for text document.<note>365<\/strong>: The 365 application.<\/note><note>collabora<\/strong>: The collabora application.<\/note><note>onlyoffice<\/strong>: The onlyoffice application.<\/note>","example":"365"},"default_mode":{"title":"default_mode","enum":["desktop","embedded","mobile"],"type":"string","description":"OnlyOffice display mode.<note>desktop<\/strong>: Optimized for the display in desktop computer browsers.<\/note><note>embedded<\/strong>: Optimized for embedding the documents into a website page.<\/note><note>mobile<\/strong>: Optimized for the display in mobile device browsers.<\/note>","nullable":true,"example":"desktop"}}},"max_keep_deleted_user":{"title":"max_keep_deleted_user","type":"string","description":"Max time the files of an user deleted is kept"}},"description":"Settings of the current users for this kDrive"},"preferences":{"title":"preferences","required":["color","default","default_page","hide","ui"],"type":"object","properties":{"color":{"title":"color","type":"string","description":"Default color for kDrive"},"hide":{"title":"hide","type":"boolean","description":"Is the drive hidden for the current user"},"default":{"title":"default","type":"boolean","description":"The default drive chosen by the user, if none the first drive in the list should be considered the default. There should only be one default drive."},"default_page":{"title":"default_page","type":"string","description":"User's default landing page"},"ui":{"title":"ui","required":["rag_ocr_promotion","storage_limit_alert","storage_warning_alert"],"type":"object","properties":{"storage_warning_alert":{"title":"storage_warning_alert","type":"boolean","description":"Display an alert when storage limit is about to be reached"},"storage_limit_alert":{"title":"storage_limit_alert","type":"boolean","description":"Display an alert when storage limit has been reached"},"rag_ocr_promotion":{"title":"rag_ocr_promotion","type":"boolean","description":"Display a promotion message about the RAG OCR if the user has not seen it yet"}},"description":"User's UI preferences on current drive"}}},"pack":{"$ref":"#\/components\/schemas\/91ac10ff_PricingPlan"},"bdd_storage_host":{"title":"bdd_storage_host","type":"string","description":"Bdd storage hostname","nullable":true},"status":{"title":"status","enum":["initializing","ok","uninitialized"],"type":"string","description":"Status of the drive"},"quota":{"title":"quota","type":"object","properties":{"dropbox":{"title":"dropbox","type":"string"},"shared_link":{"title":"shared_link","type":"string"}},"description":"Drive feature limits depending on offer"}}},"91ac10ff_AppUser":{"title":"App User","required":["avatar","deleted_at","display_name","email","first_name","id","is_sso","last_name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `App User`"},"display_name":{"title":"display_name","type":"string","description":"Display name"},"first_name":{"title":"first_name","type":"string","description":"First name"},"last_name":{"title":"last_name","type":"string","description":"Last name"},"email":{"title":"email","type":"string","description":"Email"},"is_sso":{"title":"is_sso","type":"boolean","description":"returns true if the user is provided by an external IDP"},"avatar":{"title":"avatar","type":"string","description":"null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar","nullable":true},"type":{"title":"type","type":"string"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `App User` was deleted at","format":"timestamp","nullable":true},"teams":{"title":"teams","type":"array","items":{"type":"integer","title":"teams","description":"List of Team identifiers"},"description":"List of Team identifiers"},"security":{"title":"security","required":["assistant_at","double_auth_method","has_double_auth","has_recovery_email","has_valid_email","has_valid_phone","last_password_at","score"],"type":"object","properties":{"assistant_at":{"title":"assistant_at","type":"integer","description":"The last date the assistant was used","format":"timestamp","nullable":true},"double_auth_method":{"title":"double_auth_method","type":"string","description":"Double authentication method used to log in"},"has_double_auth":{"title":"has_double_auth","type":"boolean","description":"Whether the `App User` has double authentication enabled"},"last_password_at":{"title":"last_password_at","type":"integer","description":"Last time `App User`'s password was changed","format":"timestamp","nullable":true},"score":{"title":"score","type":"integer","description":"Security score of the `App User`"},"has_valid_email":{"title":"has_valid_email","type":"integer","description":"Whether the `App User` has a valid email"},"has_recovery_email":{"title":"has_recovery_email","type":"boolean","description":"Whether the `App User` has a recovery email"},"has_valid_phone":{"title":"has_valid_phone","type":"boolean","description":"Whether the `App User` has a valid phone number"}}}}},"91ac10ff_Team":{"title":"Team","required":["color_id","created_at","created_by_id","id","name","owned_by_id","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Team`"},"name":{"title":"name","type":"string","description":"Name of the resource `Team`"},"color_id":{"title":"color_id","type":"integer","description":"Unique identifier of the `color` of the resource `Team`"},"owned_by_id":{"title":"owned_by_id","type":"integer","description":"Unique identifier of the `user` that owned the resource `Team`","nullable":true},"created_by_id":{"title":"created_by_id","type":"integer","description":"Unique identifier of the `user` that created the resource `Team`","nullable":true},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Team` was created at","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Team` was updated at","format":"timestamp"},"created_by":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"},"owned_by":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"},"user_count":{"title":"user_count","type":"integer","description":"User count related to the resource `Team`"},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource `Team`"},"product_by_service_count":{"title":"product_by_service_count","type":"integer","description":"Product by service count related to the resource `Team`"}}},"91ac10ff_UserUuid":{"title":"User Uuid","required":["uuid","valid_until"],"type":"object","properties":{"uuid":{"title":"uuid","type":"string","description":"Uuid v4","example":"96df2a1c-e449-441c-ae3a-2191f91fdc7d"},"valid_until":{"title":"valid_until","type":"integer","description":"Validity of the Uuid","format":"timestamp"}}},"91ac10ff_MaintenanceType":{"title":"Maintenance Type","required":["code","description","name"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of active Maintenance Type"},"code":{"title":"code","type":"string","description":"Active Maintenance Type"},"description":{"title":"description","type":"string","description":"Short explanation of active Maintenance Type"}}},"91ac10ff_RewindV3":{"title":"Rewind V3","required":["approval_at","archiving","created_at","created_by","directory_id","expires_at","id","is_approved","mode","rewind_at","status","user_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Rewind identifier"},"status":{"title":"status","enum":["canceled","done","drive_not_ready","expired","failed","in_progress","new","sanitizing","waiting_approval"],"type":"string","description":"Rewind status.<note>canceled<\/strong>: Rewind was canceled by the user and deleted.<\/note><note>done<\/strong>: Rewind completed successfully.<\/note><note>drive_not_ready<\/strong>: Rewind cannot start because the drive was not ready (uploads or actions in progress).<\/note><note>expired<\/strong>: Rewind has expired and deleted.<\/note><note>failed<\/strong>: Rewind completed with errors.<\/note><note>in_progress<\/strong>: Rewind is currently in progress.<\/note><note>new<\/strong>: Rewind did not start.<\/note><note>sanitizing<\/strong>: Rewind find the activity to sanitize.<\/note><note>waiting_approval<\/strong>: Rewind waiting user approval to continue.<\/note>","example":"canceled"},"mode":{"title":"mode","enum":["directory","drive","user"],"type":"string","description":"Rewind type.<note>directory<\/strong>: Rewind only a directory.<\/note><note>drive<\/strong>: Rewind all the drive.<\/note><note>user<\/strong>: Rewind a user's private folder.<\/note>","example":"directory"},"archiving":{"title":"archiving","enum":["all","current","none"],"type":"string","description":"Rewind archive mode, all created files between now and the rewind date will be set to trash or to an archive depending on the mode selected.<note>all<\/strong>: Keep in an archive folder the current or trashed files.<\/note><note>current<\/strong>: Keep in an archive folder the current files.<\/note><note>none<\/strong>: Don't build an archive, trash all created files.<\/note>","nullable":true,"example":"all"},"directory_id":{"title":"directory_id","type":"integer","description":"The targeted directory of the rewind <note>Filled only in directory and user mode<\/note>","nullable":true},"directory":{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"},"directory_name":{"title":"directory_name","type":"string","description":"The name of the directory selected when the directory mode is selected"},"user_id":{"title":"user_id","type":"integer","description":"The targeted user of the rewind <note>Filled only in user mode<\/note>","nullable":true},"rewind_at":{"title":"rewind_at","type":"integer","description":"Rewind at","format":"timestamp"},"created_at":{"title":"created_at","type":"integer","description":"created at","format":"timestamp"},"finished_at":{"title":"finished_at","type":"integer","description":"when the rewind is executed the finished process time is save here","format":"timestamp"},"expires_at":{"title":"expires_at","type":"integer","description":"Date of the rewind approval","format":"timestamp"},"created_by":{"title":"created_by","type":"integer","description":"created by the user"},"is_approved":{"title":"is_approved","type":"boolean","description":"Rewind approved by the user"},"approval_at":{"title":"approval_at","type":"integer","description":"Date of the rewind approval","format":"timestamp"},"rewind_name":{"title":"rewind_name","type":"string","description":"The name of the directory choose during approval step"},"sanitizer":{"title":"sanitizer","required":["me","sanitized","team","total"],"type":"object","properties":{"sanitized":{"title":"sanitized","type":"integer"},"total":{"title":"total","required":["files_found","not_handled_files","not_handled_versions","to_archive","to_execute","to_move","to_rename","to_restore","to_trash","to_update"],"type":"object","properties":{"to_execute":{"title":"to_execute","type":"integer"},"files_found":{"title":"files_found","type":"integer"},"to_move":{"title":"to_move","type":"integer"},"to_rename":{"title":"to_rename","type":"integer"},"to_update":{"title":"to_update","type":"integer"},"to_restore":{"title":"to_restore","type":"integer"},"to_trash":{"title":"to_trash","type":"integer"},"to_archive":{"title":"to_archive","type":"integer"},"not_handled_versions":{"title":"not_handled_versions","type":"integer"},"not_handled_files":{"title":"not_handled_files","type":"integer"}}},"team":{"title":"team","required":["files_found","not_handled_files","not_handled_versions","to_archive","to_execute","to_move","to_rename","to_restore","to_trash","to_update"],"type":"object","properties":{"to_execute":{"title":"to_execute","type":"integer"},"files_found":{"title":"files_found","type":"integer"},"to_move":{"title":"to_move","type":"integer"},"to_rename":{"title":"to_rename","type":"integer"},"to_update":{"title":"to_update","type":"integer"},"to_restore":{"title":"to_restore","type":"integer"},"to_trash":{"title":"to_trash","type":"integer"},"to_archive":{"title":"to_archive","type":"integer"},"not_handled_versions":{"title":"not_handled_versions","type":"integer"},"not_handled_files":{"title":"not_handled_files","type":"integer"}}},"me":{"title":"me","required":["files_found","not_handled_files","not_handled_versions","to_archive","to_execute","to_move","to_rename","to_restore","to_trash","to_update"],"type":"object","properties":{"to_execute":{"title":"to_execute","type":"integer"},"files_found":{"title":"files_found","type":"integer"},"to_move":{"title":"to_move","type":"integer"},"to_rename":{"title":"to_rename","type":"integer"},"to_update":{"title":"to_update","type":"integer"},"to_restore":{"title":"to_restore","type":"integer"},"to_trash":{"title":"to_trash","type":"integer"},"to_archive":{"title":"to_archive","type":"integer"},"not_handled_versions":{"title":"not_handled_versions","type":"integer"},"not_handled_files":{"title":"not_handled_files","type":"integer"}}},"others":{"title":"others","type":"string"}},"description":"Sanitizer resume, returned only when the rewind has done the sanitizing process"},"summary":{"title":"summary","required":["me","team","total"],"type":"object","properties":{"total":{"title":"total","required":["archived","conflicted","executed"],"type":"object","properties":{"executed":{"title":"executed","type":"integer"},"archived":{"title":"archived","type":"integer"},"conflicted":{"title":"conflicted","type":"integer"}}},"team":{"title":"team","required":["archived","conflicted","directory_archive_id","directory_conflict_id","directory_id","executed"],"type":"object","properties":{"executed":{"title":"executed","type":"integer"},"archived":{"title":"archived","type":"integer"},"conflicted":{"title":"conflicted","type":"integer"},"directory_id":{"title":"directory_id","type":"integer","nullable":true},"directory_archive_id":{"title":"directory_archive_id","type":"integer","nullable":true},"directory_conflict_id":{"title":"directory_conflict_id","type":"integer","nullable":true}}},"me":{"title":"me","required":["archived","conflicted","directory_archive_id","directory_conflict_id","directory_id","executed"],"type":"object","properties":{"executed":{"title":"executed","type":"integer"},"archived":{"title":"archived","type":"integer"},"conflicted":{"title":"conflicted","type":"integer"},"directory_id":{"title":"directory_id","type":"integer","nullable":true},"directory_archive_id":{"title":"directory_archive_id","type":"integer","nullable":true},"directory_conflict_id":{"title":"directory_conflict_id","type":"integer","nullable":true}}},"others":{"title":"others","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_RewindSummaryFileCounter"}}},"description":"Rewind resume, returned only when the rewind is finished"}}},"91ac10ff_Category":{"title":"Category","required":["color","created_at","created_by","id","is_predefined","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Category identifier"},"name":{"title":"name","type":"string","description":"Category name"},"color":{"title":"color","type":"string","description":"Color the Category displays in","example":"#FF1493"},"is_predefined":{"title":"is_predefined","type":"boolean","description":"If the Category is system or user defined"},"created_by":{"title":"created_by","type":"integer","description":"Unique identifier of the creator of the resource `Category`"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Category` was created at","format":"timestamp"},"user_uses":{"title":"user_uses","type":"integer","description":"Number of uses of the Category"}}},"91ac10ff_Categorypermission":{"title":"Category permission","required":["can_create","can_delete","can_edit","can_put_on_file","can_read_on_file"],"type":"object","properties":{"can_create":{"title":"can_create","type":"boolean","description":"User can create new categories"},"can_edit":{"title":"can_edit","type":"boolean","description":"User can edit existing categories"},"can_delete":{"title":"can_delete","type":"boolean","description":"User can delete categories and remove them from files"},"can_read_on_file":{"title":"can_read_on_file","type":"boolean","description":"User can read the categories that are present on files"},"can_put_on_file":{"title":"can_put_on_file","type":"boolean","description":"User can add categories to files"}}},"91ac10ff_Right":{"title":"Right","type":"object","properties":{"technical":{"title":"technical","type":"boolean"},"statistic":{"title":"statistic","type":"boolean"},"check":{"title":"check","type":"boolean"},"sale":{"title":"sale","type":"boolean"}}},"91ac10ff_Tag":{"title":"Tag","required":["color","id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Tag`","example":1234},"name":{"title":"name","type":"string","description":"Name of the resource `Tag`","example":"My tag name"},"color":{"title":"color","type":"integer","example":4},"product_count":{"title":"product_count","type":"integer","description":"Product count related to the resource `Tag`","example":2}}},"91ac10ff_KSuite":{"title":"KSuite","required":["id","name","pack","pack_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Id of the kSuite"},"name":{"title":"name","type":"string","description":"Name of the kSuite"},"pack_id":{"title":"pack_id","type":"integer","description":"Id of the type of kSuite"},"pack":{"title":"pack","type":"string","description":"Name of the type of kSuite"}}},"91ac10ff_PricingPlan":{"title":"Pricing Plan","required":["display_name","id","is_free","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Pricing Plan`"},"name":{"title":"name","type":"string","description":"Name of the resource `Pricing Plan`","example":"team"},"display_name":{"title":"display_name","type":"string","description":"Display name","example":"Team"},"is_free":{"title":"is_free","type":"boolean","description":"If the pack is free"},"limits":{"title":"limits","required":["storage","trash","users"],"type":"object","properties":{"users":{"title":"users","required":["base","max","min"],"type":"object","properties":{"base":{"title":"base","type":"integer","description":"Included\/Allowed number of user"},"min":{"title":"min","type":"integer","description":"Minimum number of additional user","nullable":true},"max":{"title":"max","type":"integer","description":"Maximum number of additional user","nullable":true}},"description":"Get users number limit of the Pricing Plan"},"trash":{"title":"trash","required":["retention_options"],"type":"object","properties":{"retention_options":{"title":"retention_options","enum":["one_month","one_year","six_months","three_months","two_months"],"type":"array","items":{"type":"integer","title":"retention_options","description":"Available options for setting trash retention.<note>one_month<\/strong>: 30 days.<\/note><note>one_year<\/strong>: A year.<\/note><note>six_months<\/strong>: 180 days.<\/note><note>three_months<\/strong>: 90 days.<\/note><note>two_months<\/strong>: 60 days.<\/note>"},"description":"Available options for setting trash retention.<note>one_month<\/strong>: 30 days.<\/note><note>one_year<\/strong>: A year.<\/note><note>six_months<\/strong>: 180 days.<\/note><note>three_months<\/strong>: 90 days.<\/note><note>two_months<\/strong>: 60 days.<\/note>","example":"one_month"}},"description":"Get the drive trash options"},"storage":{"title":"storage","required":["giga","max","min"],"type":"object","properties":{"giga":{"title":"giga","type":"integer","description":"Included\/Allowed storage (in gigabyte)"},"min":{"title":"min","type":"integer","description":"Minimum number of additional storage (in gigabyte)","nullable":true},"max":{"title":"max","type":"integer","description":"Maximum number of additional storage (in gigabyte)","nullable":true}},"description":"Get the limits of the pricing plan"}},"description":"Get the users and storage limits of the Pricing Plan"},"prices":{"title":"prices","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Drivepackprice"},"description":"Price of the Pricing Plan, contains basic plan and additional storages and users prices by currency"},"capabilities":{"title":"capabilities","required":["can_access_dashboard","can_edit_pdf","can_join_sharelink","can_rewind","can_set_office","can_set_sharelink_custom_url","can_set_sharelink_expiration","can_set_sharelink_password","can_set_trash_duration","can_use_activity_reports","can_use_content_search","can_use_office365","can_use_rag","can_use_signatures","can_use_statistics","can_use_webdav","start_guide_pdf","use_dropbox","use_folder_custom_color","use_manage_right","use_vault"],"type":"object","properties":{"use_vault":{"title":"use_vault","type":"boolean","description":"Vault directory feature"},"use_manage_right":{"title":"use_manage_right","type":"boolean","description":"Can use additional manage right"},"use_dropbox":{"title":"use_dropbox","type":"boolean","description":"Dropboxes feature"},"can_rewind":{"title":"can_rewind","type":"boolean","description":"Can access\/use restoration feature"},"use_folder_custom_color":{"title":"use_folder_custom_color","type":"boolean","description":"Can set a custom color on a folder"},"can_access_dashboard":{"title":"can_access_dashboard","type":"boolean","description":"Can access the managing dashboard"},"can_set_sharelink_password":{"title":"can_set_sharelink_password","type":"boolean","description":"Public link can be protected by password"},"can_join_sharelink":{"title":"can_join_sharelink","type":"boolean","description":"Users with Infomaniak account can ask to join drive via public links"},"can_set_sharelink_expiration":{"title":"can_set_sharelink_expiration","type":"boolean","description":"Public link can expire"},"can_set_sharelink_custom_url":{"title":"can_set_sharelink_custom_url","type":"boolean","description":"Public link can have custom theme"},"can_use_content_search":{"title":"can_use_content_search","type":"boolean","description":"Can activate advanced search functions in file contents"},"can_use_activity_reports":{"title":"can_use_activity_reports","type":"boolean","description":"Can access activity reports"},"can_use_signatures":{"title":"can_use_signatures","type":"boolean","description":"Can sign documents"},"can_use_statistics":{"title":"can_use_statistics","type":"boolean","description":"Can access statistics"},"can_edit_pdf":{"title":"can_edit_pdf","type":"boolean","description":"Can edit PDFs"},"can_use_office365":{"title":"can_use_office365","type":"boolean","description":"Can access to the Microsoft 365 editor"},"can_set_office":{"title":"can_set_office","type":"boolean","description":"Can change office editor or office related settings"},"start_guide_pdf":{"title":"start_guide_pdf","type":"boolean","description":"Add the start guide PDF to the private folder for new users"},"can_use_rag":{"title":"can_use_rag","type":"boolean","description":"Can ask AI assistant questions about the content of an open document"},"can_use_webdav":{"title":"can_use_webdav","type":"boolean","description":"Webdav protocol service"},"can_set_trash_duration":{"title":"can_set_trash_duration","type":"boolean","description":"Can set trash retention duration"}},"description":"Locked\/Unlocked features of the Pricing Plan"}}},"91ac10ff_DirectoryV3":{"title":"Directory V3","required":["added_at","color","created_at","created_by","depth","drive_id","id","last_modified_at","last_modified_by","name","parent_id","revised_at","status","type","updated_at","visibility"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Directory V3`"},"name":{"title":"name","type":"string","description":"File name","example":"Directory V3"},"sorted_name":{"title":"sorted_name","type":"string","description":"Specific sortable name"},"path":{"title":"path","type":"string","description":"Full path of the Directory V3","example":"\/full\/path\/Directory V3"},"type":{"title":"type","enum":["dir","file"],"type":"string","description":"Type of returned element either a dir (Directory) or file (File)","nullable":true,"example":"file"},"status":{"title":"status","enum":["locked","ok","trash_inherited","trashed","uploading"],"type":"string","description":"Current state of Directory V3. The state can be null meaning that the Directory V3 has no specific state.<note>locked<\/strong>: Directory V3 is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).<\/note><note>ok<\/strong>: Directory V3 is available.<\/note><note>trash_inherited<\/strong>: Directory V3 is currently in trash because a parent directory was trashed.<\/note><note>trashed<\/strong>: Directory V3 is currently in trash and specifically trashed by the user.<\/note><note>uploading<\/strong>: Directory V3 is currently being uploaded. The Directory V3 is locked and no action can be done excepting upload actions.<\/note>","example":"locked"},"visibility":{"title":"visibility","enum":["","is_in_private_space","is_in_shared_space","is_in_team_space_folder","is_private_space","is_root","is_shared_space","is_team_space","is_team_space_folder"],"type":"string","description":"Visibility of Directory V3, empty string if no specific visibility. Add additional information about Directory V3 to show different icons or more.<note><\/strong>: Empty visibility mean no special visibility.<\/note><note>is_in_private_space<\/strong>: Is a Directory V3 inside the private directory of the user.<\/note><note>is_in_shared_space<\/strong>: Is a Directory V3 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_in_team_space_folder<\/strong>: Is a Directory V3 inside a Common Documents directory.<\/note><note>is_private_space<\/strong>: Is the private directory of the user.<\/note><note>is_root<\/strong>: Is the root directory of the user.<\/note><note>is_shared_space<\/strong>: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_team_space<\/strong>: Is the Common Documents directory, a special directory where the files inside are common to all users by default.<\/note><note>is_team_space_folder<\/strong>: Is the root directory inside the Common Documents.<\/note>"},"drive_id":{"title":"drive_id","type":"integer","description":"Drive identifier","example":1111},"depth":{"title":"depth","type":"integer","description":"Current path depth of Directory V3","example":3},"created_by":{"title":"created_by","type":"integer","description":"The identifier of the user who first uploaded the Directory V3","nullable":true},"created_at":{"title":"created_at","type":"integer","description":"Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp","nullable":true},"added_at":{"title":"added_at","type":"integer","description":"The timestamp (in seconds) at which the Directory V3 has been uploaded for the first time","format":"timestamp"},"last_modified_at":{"title":"last_modified_at","type":"integer","description":"Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp"},"last_modified_by":{"title":"last_modified_by","type":"integer","description":"Id of the user who last modified the Directory V3","nullable":true},"revised_at":{"title":"revised_at","type":"integer","description":"The last time the content of the Directory V3 was revised","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"The last time the Directory V3 was updated","format":"timestamp"},"parent_id":{"title":"parent_id","type":"integer","description":"Parent directory identifier"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp of deleted resource Directory V3, only visible when the Directory V3 is trashed","format":"timestamp"},"deleted_by":{"title":"deleted_by","type":"integer","description":"User identifier of deleted resource Directory V3, only visible when the Directory V3 is trashed"},"shared_root_id":{"title":"shared_root_id","type":"integer","description":"Root Directory identifier, only visible for shared user","nullable":true,"example":1},"parents":{"title":"parents","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"},"description":"Get all parents directories"},"users":{"title":"users","type":"array","items":{"type":"integer","title":"users","description":"Array of users identifiers that has access to the Directory V3"},"description":"Array of users identifiers that has access to the Directory V3"},"teams":{"title":"teams","type":"array","items":{"type":"integer","title":"teams","description":"Array of teams identifiers that has access to the Directory V3"},"description":"Array of teams identifiers that has access to the Directory V3"},"is_favorite":{"title":"is_favorite","type":"boolean","description":"Is Directory V3 pinned as favorite"},"activity":{"title":"activity","required":["last_accessed_at"],"type":"object","properties":{"last_accessed_at":{"title":"last_accessed_at","type":"integer","description":"Timestamp of the last user access of the Directory V3","format":"timestamp"}},"description":"Activities information about the Directory V3"},"sharelink":{"$ref":"#\/components\/schemas\/91ac10ff_ShareLink"},"capabilities":{"title":"capabilities","required":["can_become_dropbox","can_become_sharelink","can_create_directory","can_create_file","can_delete","can_leave","can_move","can_move_into","can_read","can_rename","can_share","can_show","can_upload","can_use_favorite","can_use_team","can_write","colorable"],"type":"object","properties":{"can_use_favorite":{"title":"can_use_favorite","type":"boolean","description":"Right to set file as favorite"},"can_become_sharelink":{"title":"can_become_sharelink","type":"boolean","description":"Right to share file by link (share_link)"},"can_use_team":{"title":"can_use_team","type":"boolean","description":"Right to use and give team access"},"can_show":{"title":"can_show","type":"boolean","description":"Right to see Directory V3 information"},"can_read":{"title":"can_read","type":"boolean","description":"Right to read Directory V3 content"},"can_write":{"title":"can_write","type":"boolean","description":"Right to write Directory V3"},"can_share":{"title":"can_share","type":"boolean","description":"Right to share Directory V3 or manage access to Directory V3"},"can_leave":{"title":"can_leave","type":"boolean","description":"Right to leave shared Directory V3"},"can_delete":{"title":"can_delete","type":"boolean","description":"Right to delete Directory V3"},"can_rename":{"title":"can_rename","type":"boolean","description":"Right to rename Directory V3"},"can_move":{"title":"can_move","type":"boolean","description":"Right to move Directory V3"},"can_create_directory":{"title":"can_create_directory","type":"boolean","description":"Right to add new child directory"},"can_create_file":{"title":"can_create_file","type":"boolean","description":"Right to add new child file"},"can_upload":{"title":"can_upload","type":"boolean","description":"Right to upload a child file"},"can_move_into":{"title":"can_move_into","type":"boolean","description":"right to move directory"},"can_become_dropbox":{"title":"can_become_dropbox","type":"boolean","description":"Right to use convert directory into collaborative directory"},"colorable":{"title":"colorable","type":"boolean","description":"Right to change or add color to the directory"}},"description":"Directory rights"},"lock":{"title":"lock","required":["description","locked_at","token","unlocked_at"],"type":"object","properties":{"locked_at":{"title":"locked_at","type":"integer","description":"When Directory V3 is locked, locked timestamp","format":"timestamp","nullable":true},"unlocked_at":{"title":"unlocked_at","type":"integer","description":"When Directory V3 is locked, automatic lock release timestamp","format":"timestamp","nullable":true},"description":{"title":"description","enum":["365","external_import","internal_copy","internal_import","onlyoffice","unknown","webdav"],"type":"string","description":"List of applications.<note>365<\/strong>: The 365 application.<\/note><note>external_import<\/strong>: The external_import application.<\/note><note>internal_copy<\/strong>: The internal_copy application.<\/note><note>internal_import<\/strong>: The internal_import application.<\/note><note>onlyoffice<\/strong>: The onlyoffice application.<\/note><note>webdav<\/strong>: The webdav application.<\/note>","nullable":true,"example":"365"},"token":{"title":"token","type":"string","description":"When Directory V3 is locked, locked token","nullable":true,"example":"onlyoffice:123456"}},"description":"When Directory V3 is locked, locked information"},"categories":{"title":"categories","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_FileCategory"},"description":"File categories"},"etag":{"title":"etag","type":"string","description":"ETag of the file","nullable":true},"color":{"title":"color","type":"string","description":"Color of the directory for the user requesting it","nullable":true,"example":"#0098ff"},"dropbox":{"$ref":"#\/components\/schemas\/91ac10ff_Dropbox"},"external_import":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImport"},"rewind":{"$ref":"#\/components\/schemas\/91ac10ff_RewindV3"}}},"91ac10ff_RewindSummaryFileCounter":{"title":"Rewind Summary File Counter","required":["archived","conflicted","executed","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer","description":"User id"},"executed":{"title":"executed","type":"integer","description":"Total of actions executed"},"archived":{"title":"archived","type":"integer","description":"Total of actions archived"},"conflicted":{"title":"conflicted","type":"integer","description":"Total of actions conflicted"}}},"91ac10ff_ShareLink":{"title":"Share Link","required":["access_blocked","capabilities","created_at","created_by","file_id","right","updated_at","url","valid_until"],"type":"object","properties":{"url":{"title":"url","type":"string","description":"Share link url","example":"https:\/\/kdrive.infomaniak.com\/app\/share\/xxxx\/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"},"file_id":{"title":"file_id","type":"integer"},"right":{"title":"right","enum":["inherit","password","public"],"type":"string","description":"Rights required to view the share link.<note>inherit<\/strong>: Share link is accessible only by users of the drive.<\/note><note>password<\/strong>: Share link is public but protected by a password.<\/note><note>public<\/strong>: Share link is public, no restriction set.<\/note>","example":"inherit"},"valid_until":{"title":"valid_until","type":"integer","description":"Until when the share link is valid","format":"timestamp","nullable":true},"created_by":{"title":"created_by","type":"integer","description":"Unique identifier of the creator of the resource `Share Link`"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Share Link` was created at","format":"timestamp","nullable":true},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Share Link` was updated at","format":"timestamp","nullable":true},"capabilities":{"title":"capabilities","required":["can_comment","can_download","can_edit","can_request_access","can_see_info","can_see_stats"],"type":"object","properties":{"can_edit":{"title":"can_edit","type":"boolean","description":"Does share link allow editing"},"can_see_stats":{"title":"can_see_stats","type":"boolean","description":"Does share link allow stats to be seen"},"can_see_info":{"title":"can_see_info","type":"boolean","description":"Does share link allow info to be seen"},"can_download":{"title":"can_download","type":"boolean","description":"Does share link allow download"},"can_comment":{"title":"can_comment","type":"boolean","description":"Does share link allow adding comments"},"can_request_access":{"title":"can_request_access","type":"boolean","description":"Does share link allow user to request access to folder"}}},"access_blocked":{"title":"access_blocked","type":"boolean","description":"If the share link is blocked"},"views":{"title":"views","type":"integer","description":"Number of views of share link (last 180 days only)","nullable":true}}},"91ac10ff_FileCategory":{"title":"File Category","required":["added_at","category_id","is_generated_by_ai","user_id","user_validation"],"type":"object","properties":{"category_id":{"title":"category_id","type":"integer","description":"Category identifier"},"added_at":{"title":"added_at","type":"integer","description":"Time when the category was added to file","format":"timestamp"},"user_validation":{"title":"user_validation","enum":["CORRECT","INCORRECT","TO_VALIDATE"],"type":"string","description":"State of user validation after auto assignment from AI.","nullable":true,"example":"TO_VALIDATE"},"is_generated_by_ai":{"title":"is_generated_by_ai","type":"boolean","description":"Whether the Category was generated by an AI or not"},"user_id":{"title":"user_id","type":"integer","description":"User identifier","nullable":true},"category":{"$ref":"#\/components\/schemas\/91ac10ff_Category"}}},"91ac10ff_Dropbox":{"title":"Dropbox","required":["capabilities","created_at","created_by","date","has_expired","id","last_uploaded_at","limit","name","remaining","updated_at","url","used","users_count","uuid"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Dropbox`"},"uuid":{"title":"uuid","type":"string","description":"Dropbox unique identifier"},"name":{"title":"name","type":"string","description":"Name of the dropbox"},"url":{"title":"url","type":"string","description":"Public URL of the dropbox"},"directory":{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"},"users_count":{"title":"users_count","type":"integer","description":"Number of recorded users that uploaded in the dropbox"},"created_by":{"title":"created_by","type":"integer","description":"Unique identifier of the creator of the resource `Dropbox`"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Dropbox` was created at","format":"timestamp","nullable":true},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Dropbox` was updated at","format":"timestamp","nullable":true},"last_uploaded_at":{"title":"last_uploaded_at","type":"integer","description":"Last time someone uploaded a file in the dropbox","format":"timestamp","nullable":true},"capabilities":{"title":"capabilities","required":["has_password","has_size_limit","has_validity"],"type":"object","properties":{"has_password":{"title":"has_password","type":"boolean","description":"A password was defined to access to the dropbox"},"has_notification":{"title":"has_notification","type":"boolean","description":"Notification was enabled on the dropbox, email we be send to dropbox owner when someone upload a file"},"has_validity":{"title":"has_validity","type":"boolean","description":"A validity period was set to the dropbox, after the date define the dropbox is not accessible"},"has_size_limit":{"title":"has_size_limit","type":"boolean","description":"A limit size was defined to the dropbox, after the date define the dropbox is not accessible"},"validity":{"title":"validity","type":"string"},"size":{"title":"size","type":"string"}}},"user":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"}}},"91ac10ff_ExternalImport":{"title":"External Import","required":["account_name","application","count_failed_files","count_success_files","created_at","directory_id","has_shared_files","id","path","status","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"External import identifier"},"application":{"title":"application","enum":["dropbox","google","google_drive","kdrive","kdrive_sharelink","nextcloud","onedrive","owncloud","webdav"],"type":"string","description":"Service from which the import originates.<note>dropbox<\/strong>: Import from Dropbox.<\/note><note>google<\/strong>: (deprecated) Import from Google Drive.<\/note><note>google_drive<\/strong>: Import from Google Drive.<\/note><note>kdrive<\/strong>: Import from another kDrive.<\/note><note>kdrive_sharelink<\/strong>: Import from a kDrive sharelink.<\/note><note>nextcloud<\/strong>: Import from Nextcloud.<\/note><note>onedrive<\/strong>: Import from Microsoft OneDrive.<\/note><note>owncloud<\/strong>: Import from ownCloud.<\/note><note>webdav<\/strong>: Import from a generic WebDAV provider.<\/note>","example":"dropbox"},"account_name":{"title":"account_name","type":"string","description":"Account imported"},"status":{"title":"status","enum":["canceled","canceling","done","failed","in_progress","queued","waiting"],"type":"string","description":"External import status.<note>canceled<\/strong>: External import was canceled.<\/note><note>canceling<\/strong>: External import is being canceled.<\/note><note>done<\/strong>: External import is finished.<\/note><note>failed<\/strong>: External import failed.<\/note><note>in_progress<\/strong>: External import is currently in progress.<\/note><note>queued<\/strong>: External import is waiting for a process to handle it.<\/note><note>waiting<\/strong>: External import has not started yet.<\/note>","example":"canceled"},"error_code":{"title":"error_code","type":"string","description":"Give an error code if the failed reason is known."},"path":{"title":"path","type":"string","description":"Import path destination"},"directory_id":{"title":"directory_id","type":"integer","description":"Import directory identifier destination (if was not deleted)","nullable":true},"has_shared_files":{"title":"has_shared_files","type":"string","description":"Import application has shared files"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `External Import` was created at","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `External Import` was updated at","format":"timestamp"},"count_success_files":{"title":"count_success_files","type":"integer","description":"Number of successfully imported files"},"count_failed_files":{"title":"count_failed_files","type":"integer","description":"Number of failed imported files"}}},"91ac10ff_Drivepackprice":{"title":"Drive pack price","required":["amount_excl_vat","amount_incl_vat","currency_id","period","type","unit"],"type":"object","properties":{"type":{"title":"type","enum":["base","storage_giga","user"],"type":"string","description":"Drive pack price type, Base: standard price, User : Additional user price, Storage_giga : Additional storage price"},"unit":{"title":"unit","type":"integer","description":"Unity of additional type"},"period":{"title":"period","type":"integer","description":"Price by months"},"currency_id":{"title":"currency_id","type":"integer","description":"Currency identifier"},"amount_excl_vat":{"title":"amount_excl_vat","type":"number","description":"Price without the tax"},"amount_incl_vat":{"title":"amount_incl_vat","type":"number","description":"Price with the tax"}}},"91ac10ff_UserSignatureStroke":{"title":"UserSignatureStroke","required":["compositeOperation","dotSize","maxWidth","minWidth","penColor","points","velocityFilterWeight"],"type":"object","properties":{"penColor":{"title":"penColor","type":"string","description":"Color of the signature stroke, in hex format"},"dotSize":{"title":"dotSize","type":"string","description":"Stroke thickness"},"minWidth":{"title":"minWidth","type":"string"},"maxWidth":{"title":"maxWidth","type":"string"},"velocityFilterWeight":{"title":"velocityFilterWeight","type":"string"},"compositeOperation":{"title":"compositeOperation","type":"string"},"points":{"title":"points","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_UserSignatureStrokePoint"}}}},"91ac10ff_UserSignatureStrokePoint":{"title":"UserSignatureStrokePoint","required":["pressure","time","x","y"],"type":"object","properties":{"time":{"title":"time","type":"integer","description":"Point creation integer timestamp in milliseconds"},"x":{"title":"x","type":"string","description":"Point abscissa"},"y":{"title":"y","type":"string","description":"Point ordinate"},"pressure":{"title":"pressure","type":"string","description":"Outline thickness"}}},"91ac10ff_Directory":{"title":"Directory","required":["added_at","color","created_at","created_by","depth","drive_id","id","last_modified_at","name","parent_id","status","type","visibility"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Directory`"},"name":{"title":"name","type":"string","description":"File name","example":"Directory"},"sorted_name":{"title":"sorted_name","type":"string","description":"Specific sortable name"},"path":{"title":"path","type":"string","description":"Full path of the Directory","example":"\/full\/path\/Directory"},"type":{"title":"type","enum":["dir","file"],"type":"string","description":"Type of returned element either a dir (Directory) or file (File)","nullable":true,"example":"file"},"status":{"title":"status","enum":["locked","ok","trash_inherited","trashed","uploading"],"type":"string","description":"Current state of Directory. The state can be null meaning that the Directory has no specific state.<note>locked<\/strong>: Directory is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).<\/note><note>ok<\/strong>: Directory is available.<\/note><note>trash_inherited<\/strong>: Directory is currently in trash because a parent directory was trashed.<\/note><note>trashed<\/strong>: Directory is currently in trash and specifically trashed by the user.<\/note><note>uploading<\/strong>: Directory is currently being uploaded. The Directory is locked and no action can be done excepting upload actions.<\/note>","example":"locked"},"visibility":{"title":"visibility","enum":["","is_in_team_space_folder","is_root","is_shared_space","is_team_space","is_team_space_folder"],"type":"string","description":"Visibility of Directory, empty string if no specific visibility. Add additional information about Directory to show different icons or more.<note><\/strong>: Empty visibility mean no special visibility.<\/note><note>is_in_team_space_folder<\/strong>: Is a Directory inside a Common Documents directory.<\/note><note>is_root<\/strong>: Is the root directory of the user.<\/note><note>is_shared_space<\/strong>: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_team_space<\/strong>: Is the Common Documents directory, a special directory where the files inside are common to all users by default.<\/note><note>is_team_space_folder<\/strong>: Is the root directory inside the Common Documents.<\/note>"},"drive_id":{"title":"drive_id","type":"integer","description":"Drive identifier","example":1111},"depth":{"title":"depth","type":"integer","description":"Current path depth of Directory","example":3},"created_by":{"title":"created_by","type":"integer","description":"The identifier of the user who first uploaded the Directory","nullable":true},"created_at":{"title":"created_at","type":"integer","description":"Directory creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp","nullable":true},"added_at":{"title":"added_at","type":"integer","description":"The timestamp (in seconds) at which the Directory has been uploaded for the first time","format":"timestamp"},"last_modified_at":{"title":"last_modified_at","type":"integer","description":"Directory creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp"},"parent_id":{"title":"parent_id","type":"integer","description":"Parent directory identifier"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp of deleted resource Directory, only visible when the Directory is trashed","format":"timestamp"},"deleted_by":{"title":"deleted_by","type":"integer","description":"User identifier of deleted resource Directory, only visible when the Directory is trashed"},"shared_root_id":{"title":"shared_root_id","type":"integer","description":"Root Directory identifier, only visible for shared user","nullable":true,"example":1},"parents":{"title":"parents","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Directory"},"description":"Get all parents directories"},"users":{"title":"users","type":"array","items":{"type":"integer","title":"users","description":"Array of users identifiers that has access to the Directory"},"description":"Array of users identifiers that has access to the Directory"},"teams":{"title":"teams","type":"array","items":{"type":"integer","title":"teams","description":"Array of teams identifiers that has access to the Directory"},"description":"Array of teams identifiers that has access to the Directory"},"is_favorite":{"title":"is_favorite","type":"boolean","description":"Is Directory pinned as favorite"},"activity":{"title":"activity","required":["last_accessed_at"],"type":"object","properties":{"last_accessed_at":{"title":"last_accessed_at","type":"integer","description":"Timestamp of the last user access of the Directory","format":"timestamp"}},"description":"Activities information about the Directory"},"sharelink":{"$ref":"#\/components\/schemas\/91ac10ff_ShareLink"},"capabilities":{"title":"capabilities","required":["can_become_dropbox","can_become_sharelink","can_create_directory","can_create_file","can_delete","can_leave","can_move","can_move_into","can_read","can_rename","can_share","can_show","can_upload","can_use_favorite","can_use_team","can_write"],"type":"object","properties":{"can_use_favorite":{"title":"can_use_favorite","type":"boolean","description":"Right to set file as favorite"},"can_become_sharelink":{"title":"can_become_sharelink","type":"boolean","description":"Right to share file by link (share_link)"},"can_use_team":{"title":"can_use_team","type":"boolean","description":"Right to use and give team access"},"can_show":{"title":"can_show","type":"boolean","description":"Right to see Directory information"},"can_read":{"title":"can_read","type":"boolean","description":"Right to read Directory content"},"can_write":{"title":"can_write","type":"boolean","description":"Right to write Directory"},"can_share":{"title":"can_share","type":"boolean","description":"Right to share Directory or manage access to Directory"},"can_leave":{"title":"can_leave","type":"boolean","description":"Right to leave shared Directory"},"can_delete":{"title":"can_delete","type":"boolean","description":"Right to delete Directory"},"can_rename":{"title":"can_rename","type":"boolean","description":"Right to rename Directory"},"can_move":{"title":"can_move","type":"boolean","description":"Right to move Directory"},"can_create_directory":{"title":"can_create_directory","type":"boolean","description":"Right to add new child directory"},"can_create_file":{"title":"can_create_file","type":"boolean","description":"Right to add new child file"},"can_upload":{"title":"can_upload","type":"boolean","description":"Right to upload a child file"},"can_move_into":{"title":"can_move_into","type":"boolean","description":"right to move directory"},"can_become_dropbox":{"title":"can_become_dropbox","type":"boolean","description":"Right to use convert directory into collaborative directory"}},"description":"Directory rights"},"lock":{"title":"lock","required":["description","locked_at","token","unlocked_at"],"type":"object","properties":{"locked_at":{"title":"locked_at","type":"integer","description":"When Directory is locked, locked timestamp","format":"timestamp","nullable":true},"unlocked_at":{"title":"unlocked_at","type":"integer","description":"When Directory is locked, automatic lock release timestamp","format":"timestamp","nullable":true},"description":{"title":"description","type":"string","description":"When Directory is locked, locked reason","nullable":true,"example":"onlyoffice"},"token":{"title":"token","type":"string","description":"When Directory is locked, locked token","nullable":true,"example":"onlyoffice:123456"}},"description":"When Directory is locked, locked information"},"categories":{"title":"categories","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_FileCategory"},"description":"File categories"},"etag":{"title":"etag","type":"string","description":"ETag of the file","nullable":true},"color":{"title":"color","type":"string","description":"Color of the directory for the user requesting it","nullable":true,"example":"#0098ff"},"dropbox":{"$ref":"#\/components\/schemas\/91ac10ff_Dropbox"},"external_import":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImport"},"rewind":{"$ref":"#\/components\/schemas\/91ac10ff_RewindV3"}}},"91ac10ff_PublicImage":{"title":"PublicImage","required":["id","public_url"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `PublicImage`"},"public_url":{"title":"public_url","type":"string","example":"\"https:\/\/kdrive.infomaniak.com\/drive\/xxxxx\/public\/d\/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx\/preview\""}}},"91ac10ff_DriveUserInvitation":{"title":"Drive User Invitation","required":["access_name","created_at","email","expired_at","file_id","id","invited_by","is_private","is_valid","key","lang","message","role","status","type","url","user_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Drive User Invitation`"},"type":{"title":"type","enum":["file","user"],"type":"string","description":"Type of `Invitation`"},"is_private":{"title":"is_private","type":"boolean"},"user_exist":{"title":"user_exist","type":"boolean"},"key":{"title":"key","type":"string","description":"Random key used to uniquely identify the `Invitation`"},"file_id":{"title":"file_id","type":"integer"},"lang":{"title":"lang","type":"string","description":"Language to invite the `User` in"},"user_id":{"title":"user_id","type":"integer","description":"User identifier","nullable":true},"user":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"},"invited_by":{"title":"invited_by","type":"integer","description":"Identifier of `User` that sent the invitation","nullable":true},"invited":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"},"url":{"title":"url","type":"string","description":"`Invitation` url"},"is_valid":{"title":"is_valid","type":"boolean","description":"Whether the `Invitation` is still valid or not"},"status":{"title":"status","enum":["accepted","cancelled","pending","rejected"],"type":"string","description":"Status of the `Invitation`"},"email":{"title":"email","type":"string","description":"Email"},"message":{"title":"message","type":"string","description":"`Invitation` message"},"expired_at":{"title":"expired_at","type":"integer","description":"When the invitation expire","format":"timestamp","nullable":true},"created_at":{"title":"created_at","type":"integer","description":"When the invitation was created","format":"timestamp","nullable":true},"access_name":{"title":"access_name","type":"string","description":"`Drive` name displayed for user"},"role":{"title":"role","type":"string","description":"Role that will be assigned to invited `User`"},"drive":{"$ref":"#\/components\/schemas\/91ac10ff_Drive"},"file":{"title":"file","type":"object","oneOf":[{"$ref":"#\/components\/schemas\/91ac10ff_FileV3"},{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"}],"description":"The `File` the `User` is invited to","nullable":true}}},"91ac10ff_DriveUser":{"title":"Drive User","required":["account_id","avatar","created_at","deleted_at","display_name","drive_id","drive_name","email","first_name","id","is_sso","last_connection_at","last_name","preference","product_id","role","status","type","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Drive User`"},"display_name":{"title":"display_name","type":"string","description":"Display name"},"first_name":{"title":"first_name","type":"string","description":"First name"},"last_name":{"title":"last_name","type":"string","description":"Last name"},"email":{"title":"email","type":"string","description":"Email"},"is_sso":{"title":"is_sso","type":"boolean","description":"returns true if the user is provided by an external IDP"},"avatar":{"title":"avatar","type":"string","description":"null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar","nullable":true},"type":{"title":"type","enum":["main","shared"],"type":"string","description":"Type of the access; this field is no longer used and has been replaced by an additional role property `external`.<note>main<\/strong>: User has access to the drive.<\/note><note>shared<\/strong>: User has access to a shared file \/ directory only.<\/note>","example":"main","deprecated":true},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp `Drive User` was deleted at","format":"timestamp"},"teams":{"title":"teams","type":"array","items":{"type":"integer","title":"teams","description":"List of Team identifiers"},"description":"List of Team identifiers"},"security":{"title":"security","required":["assistant_at","double_auth_method","has_double_auth","has_recovery_email","has_valid_email","has_valid_phone","last_password_at","score"],"type":"object","properties":{"assistant_at":{"title":"assistant_at","type":"integer","description":"The last date the assistant was used","format":"timestamp","nullable":true},"double_auth_method":{"title":"double_auth_method","type":"string","description":"Double authentication method used to log in"},"has_double_auth":{"title":"has_double_auth","type":"boolean","description":"Whether the `Drive User` has double authentication enabled"},"last_password_at":{"title":"last_password_at","type":"integer","description":"Last time `Drive User`'s password was changed","format":"timestamp","nullable":true},"score":{"title":"score","type":"integer","description":"Security score of the `Drive User`"},"has_valid_email":{"title":"has_valid_email","type":"integer","description":"Whether the `Drive User` has a valid email"},"has_recovery_email":{"title":"has_recovery_email","type":"boolean","description":"Whether the `Drive User` has a recovery email"},"has_valid_phone":{"title":"has_valid_phone","type":"boolean","description":"Whether the `Drive User` has a valid phone number"}}},"drive_id":{"title":"drive_id","type":"integer","description":"Drive identifier","example":1111},"drive":{"$ref":"#\/components\/schemas\/91ac10ff_Drive"},"drive_name":{"title":"drive_name","type":"string"},"account_id":{"title":"account_id","type":"integer","description":"Account identifier of resource `Drive User`"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Drive User` was created at","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Drive User` was updated at","format":"timestamp"},"last_connection_at":{"title":"last_connection_at","type":"integer","description":"Timestamp `User` was last connected at","format":"timestamp","nullable":true},"product_id":{"title":"product_id","type":"integer","description":"Unique identifier of the `product` that is related to the resource `Drive User`"},"status":{"title":"status","enum":["active","deleted_kept","deleted_removed","deleted_transferred","deleted_transferring","locked","pending"],"type":"string","description":"Current access status of the user in the drive.<note>active<\/strong>: User has access to the Drive.<\/note><note>deleted_kept<\/strong>: User has been removed but his data remain in the drive.<\/note><note>deleted_removed<\/strong>: User has been removed.<\/note><note>deleted_transferred<\/strong>: User has been removed and his data has been transferred to another user.<\/note><note>deleted_transferring<\/strong>: User has been removed and is being transferred to another user.<\/note><note>locked<\/strong>: User has been locked, user can no longer access to the drive.<\/note><note>pending<\/strong>: User has not accepted the invitation request.<\/note>","example":"active"},"role":{"title":"role","enum":["admin","external","user"],"type":"string","description":"Administration level of the user.<note>admin<\/strong>: Administrator of the drive, can manage the drive (settings, invitations and users) and the files.<\/note><note>external<\/strong>: External user can only access the files given by the others roles.<\/note><note>user<\/strong>: Internal user can invite user and manage the files of his private directory and other directories with manage file access.<\/note>","example":"admin"},"preference":{"title":"preference","required":["color","default","default_page","hide","ui"],"type":"object","properties":{"color":{"title":"color","type":"string","description":"Default color for drive"},"hide":{"title":"hide","type":"boolean","description":"Is the drive hidden for the current user"},"default":{"title":"default","type":"boolean","description":"The default drive chosen by the user, if none the first drive in the list should be considered the default. There should only be one default drive."},"default_page":{"title":"default_page","type":"string","description":"User's default landing page"},"ui":{"title":"ui","required":["rag_ocr_promotion","storage_limit_alert","storage_warning_alert"],"type":"object","properties":{"storage_warning_alert":{"title":"storage_warning_alert","type":"boolean","description":"Display an alert when storage limit is about to be reached"},"storage_limit_alert":{"title":"storage_limit_alert","type":"boolean","description":"Display an alert when storage limit has been reached"},"rag_ocr_promotion":{"title":"rag_ocr_promotion","type":"boolean","description":"Display a promotion message about the RAG OCR if the user has not seen it yet"}},"description":"User's UI preferences on current drive"}}},"categories_permissions":{"title":"categories_permissions","type":"string","description":"Get user permissions on categories"},"capabilities":{"title":"capabilities","required":["can_create_team_directory","can_set_trash_duration","has_technical_permission"],"type":"object","properties":{"can_create_team_directory":{"title":"can_create_team_directory","type":"boolean"},"can_set_trash_duration":{"title":"can_set_trash_duration","type":"boolean"},"has_technical_permission":{"title":"has_technical_permission","type":"boolean","description":"Whether the `Drive User` has the permission to perform technical operations"}},"description":"Accessible features for the Drive User"},"private_storage":{"title":"private_storage","type":"integer","description":"Storage size of private files (bytes)"}}},"91ac10ff_FileV3":{"title":"File V3","required":["added_at","created_at","created_by","depth","drive_id","extension_type","id","last_modified_at","last_modified_by","mime_type","name","parent_id","revised_at","scan_status","size","status","type","updated_at","visibility"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `File V3`"},"name":{"title":"name","type":"string","description":"File name","example":"File V3"},"sorted_name":{"title":"sorted_name","type":"string","description":"Specific sortable name"},"path":{"title":"path","type":"string","description":"Full path of the File V3","example":"\/full\/path\/File V3"},"type":{"title":"type","enum":["dir","file"],"type":"string","description":"Type of returned element either a dir (Directory) or file (File)","nullable":true,"example":"file"},"status":{"title":"status","enum":["locked","ok","trash_inherited","trashed","uploading"],"type":"string","description":"Current state of File V3. The state can be null meaning that the File V3 has no specific state.<note>locked<\/strong>: File V3 is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).<\/note><note>ok<\/strong>: File V3 is available.<\/note><note>trash_inherited<\/strong>: File V3 is currently in trash because a parent directory was trashed.<\/note><note>trashed<\/strong>: File V3 is currently in trash and specifically trashed by the user.<\/note><note>uploading<\/strong>: File V3 is currently being uploaded. The File V3 is locked and no action can be done excepting upload actions.<\/note>","example":"locked"},"visibility":{"title":"visibility","enum":["","is_in_private_space","is_in_shared_space","is_in_team_space_folder","is_private_space","is_root","is_shared_space","is_team_space","is_team_space_folder"],"type":"string","description":"Visibility of File V3, empty string if no specific visibility. Add additional information about File V3 to show different icons or more.<note><\/strong>: Empty visibility mean no special visibility.<\/note><note>is_in_private_space<\/strong>: Is a File V3 inside the private directory of the user.<\/note><note>is_in_shared_space<\/strong>: Is a File V3 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_in_team_space_folder<\/strong>: Is a File V3 inside a Common Documents directory.<\/note><note>is_private_space<\/strong>: Is the private directory of the user.<\/note><note>is_root<\/strong>: Is the root directory of the user.<\/note><note>is_shared_space<\/strong>: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_team_space<\/strong>: Is the Common Documents directory, a special directory where the files inside are common to all users by default.<\/note><note>is_team_space_folder<\/strong>: Is the root directory inside the Common Documents.<\/note>"},"drive_id":{"title":"drive_id","type":"integer","description":"Drive identifier","example":1111},"depth":{"title":"depth","type":"integer","description":"Current path depth of File V3","example":3},"created_by":{"title":"created_by","type":"integer","description":"The identifier of the user who first uploaded the File V3","nullable":true},"created_at":{"title":"created_at","type":"integer","description":"File V3 creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp","nullable":true},"added_at":{"title":"added_at","type":"integer","description":"The timestamp (in seconds) at which the File V3 has been uploaded for the first time","format":"timestamp"},"last_modified_at":{"title":"last_modified_at","type":"integer","description":"File V3 creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp"},"last_modified_by":{"title":"last_modified_by","type":"integer","description":"Id of the user who last modified the File V3","nullable":true},"revised_at":{"title":"revised_at","type":"integer","description":"The last time the content of the File V3 was revised","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"The last time the File V3 was updated","format":"timestamp"},"parent_id":{"title":"parent_id","type":"integer","description":"Parent directory identifier"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp of deleted resource File V3, only visible when the File V3 is trashed","format":"timestamp"},"deleted_by":{"title":"deleted_by","type":"integer","description":"User identifier of deleted resource File V3, only visible when the File V3 is trashed"},"shared_root_id":{"title":"shared_root_id","type":"integer","description":"Root Directory identifier, only visible for shared user","nullable":true,"example":1},"parents":{"title":"parents","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"},"description":"Get all parents directories"},"users":{"title":"users","type":"array","items":{"type":"integer","title":"users","description":"Array of users identifiers that has access to the File V3"},"description":"Array of users identifiers that has access to the File V3"},"teams":{"title":"teams","type":"array","items":{"type":"integer","title":"teams","description":"Array of teams identifiers that has access to the File V3"},"description":"Array of teams identifiers that has access to the File V3"},"is_favorite":{"title":"is_favorite","type":"boolean","description":"Is File V3 pinned as favorite"},"activity":{"title":"activity","required":["last_accessed_at"],"type":"object","properties":{"last_accessed_at":{"title":"last_accessed_at","type":"integer","description":"Timestamp of the last user access of the File V3","format":"timestamp"}},"description":"Activities information about the File V3"},"sharelink":{"$ref":"#\/components\/schemas\/91ac10ff_ShareLink"},"capabilities":{"title":"capabilities","required":["can_become_sharelink","can_delete","can_leave","can_move","can_read","can_rename","can_share","can_show","can_use_favorite","can_use_team","can_write"],"type":"object","properties":{"can_use_favorite":{"title":"can_use_favorite","type":"boolean","description":"Right to set file as favorite"},"can_become_sharelink":{"title":"can_become_sharelink","type":"boolean","description":"Right to share file by link (share_link)"},"can_use_team":{"title":"can_use_team","type":"boolean","description":"Right to use and give team access"},"can_show":{"title":"can_show","type":"boolean","description":"Right to see File V3 information"},"can_read":{"title":"can_read","type":"boolean","description":"Right to read File V3 content"},"can_write":{"title":"can_write","type":"boolean","description":"Right to write File V3"},"can_share":{"title":"can_share","type":"boolean","description":"Right to share File V3 or manage access to File V3"},"can_leave":{"title":"can_leave","type":"boolean","description":"Right to leave shared File V3"},"can_delete":{"title":"can_delete","type":"boolean","description":"Right to delete File V3"},"can_rename":{"title":"can_rename","type":"boolean","description":"Right to rename File V3"},"can_move":{"title":"can_move","type":"boolean","description":"Right to move File V3"}},"description":"Capabilities of File V3"},"lock":{"title":"lock","required":["description","locked_at","token","unlocked_at"],"type":"object","properties":{"locked_at":{"title":"locked_at","type":"integer","description":"When File V3 is locked, locked timestamp","format":"timestamp","nullable":true},"unlocked_at":{"title":"unlocked_at","type":"integer","description":"When File V3 is locked, automatic lock release timestamp","format":"timestamp","nullable":true},"description":{"title":"description","enum":["365","external_import","internal_copy","internal_import","onlyoffice","unknown","webdav"],"type":"string","description":"List of applications.<note>365<\/strong>: The 365 application.<\/note><note>external_import<\/strong>: The external_import application.<\/note><note>internal_copy<\/strong>: The internal_copy application.<\/note><note>internal_import<\/strong>: The internal_import application.<\/note><note>onlyoffice<\/strong>: The onlyoffice application.<\/note><note>webdav<\/strong>: The webdav application.<\/note>","nullable":true,"example":"365"},"token":{"title":"token","type":"string","description":"When File V3 is locked, locked token","nullable":true,"example":"onlyoffice:123456"}},"description":"When File V3 is locked, locked information"},"categories":{"title":"categories","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_FileCategory"},"description":"File categories"},"etag":{"title":"etag","type":"string","description":"ETag of the file","nullable":true},"size":{"title":"size","type":"integer","description":"Size of File V3 <note>The unit of size is defined in Bytes<\/note>","nullable":true,"example":1700},"mime_type":{"title":"mime_type","type":"string","description":"Mime-type of file","nullable":true},"extension_type":{"title":"extension_type","enum":["archive","audio","code","diagram","dir","email","font","form","image","model","pdf","presentation","spreadsheet","text","unknown","video"],"type":"string","description":"Generic file types, matching a known set of extensions and\/or mime types.<note>archive<\/strong>: Archive file.<\/note><note>audio<\/strong>: Audio only file.<\/note><note>code<\/strong>: Text file recognized as code.<\/note><note>diagram<\/strong>: Diagram file.<\/note><note>dir<\/strong>: Directory.<\/note><note>email<\/strong>: Bundled email file.<\/note><note>font<\/strong>: Text file recognized as font.<\/note><note>form<\/strong>: Form file.<\/note><note>image<\/strong>: Image file.<\/note><note>model<\/strong>: 3D file.<\/note><note>pdf<\/strong>: PDF file.<\/note><note>presentation<\/strong>: Presentation\/slides file.<\/note><note>spreadsheet<\/strong>: Spreadsheet file.<\/note><note>text<\/strong>: Generic text file.<\/note><note>unknown<\/strong>: Generic file, not recognized as any of the other type.<\/note><note>video<\/strong>: Video file; may contain other stream types such as audio or subtitles.<\/note>","example":"archive"},"symbolic_link":{"title":"symbolic_link","type":"string","description":"Symlink target path if the file was uploaded as a symlink"},"scan_status":{"title":"scan_status","enum":["cannot_be_scanned","clean","error","infected","not_to_be_scanned","pua","to_be_defined","to_be_scan"],"type":"string","description":"Current state of virus scan for File V3.<note>cannot_be_scanned<\/strong>: This File V3 cannot be scanned. Possibly because the File V3 is too large.<\/note><note>clean<\/strong>: This File V3 has been successfully scanned for known viruses.<\/note><note>error<\/strong>: An error occurred while scanning the File V3.<\/note><note>infected<\/strong>: This File V3 has been detected as infected by a virus.<\/note><note>not_to_be_scanned<\/strong>: This File V3 is not eligible to be scanned. Possibly because the File V3 is empty.<\/note><note>pua<\/strong>: This File V3 has been detected as Potentially Unwanted Applications (PUA).<\/note><note>to_be_defined<\/strong>: The status for this File V3 has not yet been determined.<\/note><note>to_be_scan<\/strong>: This File V3 will be analyzed soon.<\/note>","example":"cannot_be_scanned"},"supported_by":{"title":"supported_by","enum":["365","drawio","kmail","onlyoffice","thumbnail"],"type":"object","oneOf":[{"title":"array","type":"array"},{"title":"string","type":"string"}],"description":"List of applications.<note>365<\/strong>: The 365 application.<\/note><note>drawio<\/strong>: The drawio application.<\/note><note>kmail<\/strong>: The kmail application.<\/note><note>onlyoffice<\/strong>: The onlyoffice application.<\/note><note>thumbnail<\/strong>: Thumbnail is preview and thumbnail.<\/note>","example":"365"},"version":{"title":"version","required":["is_multiple","keep_forever","number","total_size"],"type":"object","properties":{"is_multiple":{"title":"is_multiple","type":"boolean","description":"File has multi-version"},"number":{"title":"number","type":"integer","description":"Get number of version"},"total_size":{"title":"total_size","type":"integer","description":"Size of the file with all version (byte unit)","nullable":true},"keep_forever":{"title":"keep_forever","type":"boolean","description":"True if the current version of this file should be kept forever, otherwise false or empty"}},"description":"Information when file has multi-version"},"conversion_capabilities":{"title":"conversion_capabilities","required":["download_extensions","onlyoffice_extension","when_downloading","when_onlyoffice_opening"],"type":"object","properties":{"when_downloading":{"title":"when_downloading","type":"boolean","description":"Whether the file may be converted upon download"},"download_extensions":{"title":"download_extensions","type":"array","items":{"type":"string","title":"download_extensions","description":"Available extensions to which the file may be converted upon download, if possible"},"description":"Available extensions to which the file may be converted upon download, if possible"},"when_onlyoffice_opening":{"title":"when_onlyoffice_opening","type":"boolean","description":"Whether the file may be converted for live edition with OnlyOffice"},"onlyoffice_extension":{"title":"onlyoffice_extension","type":"string","description":"Available extension to which the file may be converted by OnlyOffice, if possible","nullable":true,"example":"docx"}},"description":"The available ways to convert the file"},"hash":{"title":"hash","type":"string","description":"Hash of the file content","nullable":true,"example":"xxh3:00ec7bec63e548df"}}},"91ac10ff_DriveDefaultLimits":{"title":"Drive Default Limits","required":["archive_files_download","bandwidth","comments_per_file","concurrent_external_imports","dropboxes","empty_trash_days","files_by_folders","files_by_user","files_size","min_size_for_hotcache","shared_link","stats_days","sub_folders","versioning","versioning_days"],"type":"object","properties":{"files_by_folders":{"title":"files_by_folders","type":"integer","description":"Number of files\/folders in the same folder"},"files_size":{"title":"files_size","type":"integer","description":"Max file size"},"sub_folders":{"title":"sub_folders","type":"integer","description":"Max depth of folder"},"empty_trash_days":{"title":"empty_trash_days","type":"integer","description":"Number of days a file is conserved when trashed"},"versioning_days":{"title":"versioning_days","type":"integer","description":"Number of days a version of a file is conserved"},"versioning":{"title":"versioning","type":"integer","description":"Number of versions of a file"},"files_by_user":{"title":"files_by_user","type":"integer","description":"Max number of file for one user"},"shared_link":{"title":"shared_link","type":"integer","description":"Max shared link"},"bandwidth":{"title":"bandwidth","type":"integer","description":"Bandwidth authorize for a user in 24 hours"},"archive_files_download":{"title":"archive_files_download","type":"integer","description":"Max files downloadable in a archive"},"comments_per_file":{"title":"comments_per_file","type":"integer","description":"Max number of comments per file"},"min_size_for_hotcache":{"title":"min_size_for_hotcache","type":"integer","description":"Minimum size of a file to be cached on kCache before moving to a \"cold\" storage"},"concurrent_external_imports":{"title":"concurrent_external_imports","type":"integer","description":"Maximum number of external imports which may run at the same time"},"dropboxes":{"title":"dropboxes","type":"integer","description":"Maximum number of dropboxes per drive"},"stats_days":{"title":"stats_days","type":"integer","description":"Maximum number of days, in past, statistics can be seen - 0 for unlimited"}}},"91ac10ff_File":{"title":"File","required":["added_at","created_at","created_by","depth","drive_id","extension_type","has_onlyoffice","has_thumbnail","id","last_modified_at","mime_type","name","parent_id","scan_status","size","status","type","visibility"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `File`"},"name":{"title":"name","type":"string","description":"File name","example":"File"},"sorted_name":{"title":"sorted_name","type":"string","description":"Specific sortable name"},"path":{"title":"path","type":"string","description":"Full path of the File","example":"\/full\/path\/File"},"type":{"title":"type","enum":["dir","file"],"type":"string","description":"Type of returned element either a dir (Directory) or file (File)","nullable":true,"example":"file"},"status":{"title":"status","enum":["locked","ok","trash_inherited","trashed","uploading"],"type":"string","description":"Current state of File. The state can be null meaning that the File has no specific state.<note>locked<\/strong>: File is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).<\/note><note>ok<\/strong>: File is available.<\/note><note>trash_inherited<\/strong>: File is currently in trash because a parent directory was trashed.<\/note><note>trashed<\/strong>: File is currently in trash and specifically trashed by the user.<\/note><note>uploading<\/strong>: File is currently being uploaded. The File is locked and no action can be done excepting upload actions.<\/note>","example":"locked"},"visibility":{"title":"visibility","enum":["","is_in_team_space_folder","is_root","is_shared_space","is_team_space","is_team_space_folder"],"type":"string","description":"Visibility of File, empty string if no specific visibility. Add additional information about File to show different icons or more.<note><\/strong>: Empty visibility mean no special visibility.<\/note><note>is_in_team_space_folder<\/strong>: Is a File inside a Common Documents directory.<\/note><note>is_root<\/strong>: Is the root directory of the user.<\/note><note>is_shared_space<\/strong>: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_team_space<\/strong>: Is the Common Documents directory, a special directory where the files inside are common to all users by default.<\/note><note>is_team_space_folder<\/strong>: Is the root directory inside the Common Documents.<\/note>"},"drive_id":{"title":"drive_id","type":"integer","description":"Drive identifier","example":1111},"depth":{"title":"depth","type":"integer","description":"Current path depth of File","example":3},"created_by":{"title":"created_by","type":"integer","description":"The identifier of the user who first uploaded the File","nullable":true},"created_at":{"title":"created_at","type":"integer","description":"File creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp","nullable":true},"added_at":{"title":"added_at","type":"integer","description":"The timestamp (in seconds) at which the File has been uploaded for the first time","format":"timestamp"},"last_modified_at":{"title":"last_modified_at","type":"integer","description":"File creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp"},"parent_id":{"title":"parent_id","type":"integer","description":"Parent directory identifier"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp of deleted resource File, only visible when the File is trashed","format":"timestamp"},"deleted_by":{"title":"deleted_by","type":"integer","description":"User identifier of deleted resource File, only visible when the File is trashed"},"shared_root_id":{"title":"shared_root_id","type":"integer","description":"Root Directory identifier, only visible for shared user","nullable":true,"example":1},"parents":{"title":"parents","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Directory"},"description":"Get all parents directories"},"users":{"title":"users","type":"array","items":{"type":"integer","title":"users","description":"Array of users identifiers that has access to the File"},"description":"Array of users identifiers that has access to the File"},"teams":{"title":"teams","type":"array","items":{"type":"integer","title":"teams","description":"Array of teams identifiers that has access to the File"},"description":"Array of teams identifiers that has access to the File"},"is_favorite":{"title":"is_favorite","type":"boolean","description":"Is File pinned as favorite"},"activity":{"title":"activity","required":["last_accessed_at"],"type":"object","properties":{"last_accessed_at":{"title":"last_accessed_at","type":"integer","description":"Timestamp of the last user access of the File","format":"timestamp"}},"description":"Activities information about the File"},"sharelink":{"$ref":"#\/components\/schemas\/91ac10ff_ShareLink"},"capabilities":{"title":"capabilities","required":["can_become_sharelink","can_delete","can_leave","can_move","can_read","can_rename","can_share","can_show","can_use_favorite","can_use_team","can_write"],"type":"object","properties":{"can_use_favorite":{"title":"can_use_favorite","type":"boolean","description":"Right to set file as favorite"},"can_become_sharelink":{"title":"can_become_sharelink","type":"boolean","description":"Right to share file by link (share_link)"},"can_use_team":{"title":"can_use_team","type":"boolean","description":"Right to use and give team access"},"can_show":{"title":"can_show","type":"boolean","description":"Right to see File information"},"can_read":{"title":"can_read","type":"boolean","description":"Right to read File content"},"can_write":{"title":"can_write","type":"boolean","description":"Right to write File"},"can_share":{"title":"can_share","type":"boolean","description":"Right to share File or manage access to File"},"can_leave":{"title":"can_leave","type":"boolean","description":"Right to leave shared File"},"can_delete":{"title":"can_delete","type":"boolean","description":"Right to delete File"},"can_rename":{"title":"can_rename","type":"boolean","description":"Right to rename File"},"can_move":{"title":"can_move","type":"boolean","description":"Right to move File"}},"description":"Capabilities of File"},"lock":{"title":"lock","required":["description","locked_at","token","unlocked_at"],"type":"object","properties":{"locked_at":{"title":"locked_at","type":"integer","description":"When File is locked, locked timestamp","format":"timestamp","nullable":true},"unlocked_at":{"title":"unlocked_at","type":"integer","description":"When File is locked, automatic lock release timestamp","format":"timestamp","nullable":true},"description":{"title":"description","type":"string","description":"When File is locked, locked reason","nullable":true,"example":"onlyoffice"},"token":{"title":"token","type":"string","description":"When File is locked, locked token","nullable":true,"example":"onlyoffice:123456"}},"description":"When File is locked, locked information"},"categories":{"title":"categories","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_FileCategory"},"description":"File categories"},"etag":{"title":"etag","type":"string","description":"ETag of the file","nullable":true},"size":{"title":"size","type":"integer","description":"Size of File <note>The unit of size is defined in Bytes<\/note>","nullable":true,"example":1700},"has_thumbnail":{"title":"has_thumbnail","type":"boolean","description":"File has thumbnail, if so you can request thumbnail route"},"has_onlyoffice":{"title":"has_onlyoffice","type":"boolean","description":"File can be handled by OnlyOffice"},"mime_type":{"title":"mime_type","type":"string","description":"Mime-type of file","nullable":true},"extension_type":{"title":"extension_type","enum":["archive","audio","code","diagram","dir","email","font","form","image","model","pdf","presentation","spreadsheet","text","unknown","video"],"type":"string","description":"Generic file types, matching a known set of extensions and\/or mime types.<note>archive<\/strong>: Archive file.<\/note><note>audio<\/strong>: Audio only file.<\/note><note>code<\/strong>: Text file recognized as code.<\/note><note>diagram<\/strong>: Diagram file.<\/note><note>dir<\/strong>: Directory.<\/note><note>email<\/strong>: Bundled email file.<\/note><note>font<\/strong>: Text file recognized as font.<\/note><note>form<\/strong>: Form file.<\/note><note>image<\/strong>: Image file.<\/note><note>model<\/strong>: 3D file.<\/note><note>pdf<\/strong>: PDF file.<\/note><note>presentation<\/strong>: Presentation\/slides file.<\/note><note>spreadsheet<\/strong>: Spreadsheet file.<\/note><note>text<\/strong>: Generic text file.<\/note><note>unknown<\/strong>: Generic file, not recognized as any of the other type.<\/note><note>video<\/strong>: Video file; may contain other stream types such as audio or subtitles.<\/note>","example":"archive"},"scan_status":{"title":"scan_status","enum":["cannot_be_scanned","clean","error","infected","not_to_be_scanned","pua","to_be_defined","to_be_scan"],"type":"string","description":"Current state of virus scan for File.<note>cannot_be_scanned<\/strong>: This File cannot be scanned. Possibly because the File is too large.<\/note><note>clean<\/strong>: This File has been successfully scanned for known viruses.<\/note><note>error<\/strong>: An error occurred while scanning the File.<\/note><note>infected<\/strong>: This File has been detected as infected by a virus.<\/note><note>not_to_be_scanned<\/strong>: This File is not eligible to be scanned. Possibly because the File is empty.<\/note><note>pua<\/strong>: This File has been detected as Potentially Unwanted Applications (PUA).<\/note><note>to_be_defined<\/strong>: The status for this File has not yet been determined.<\/note><note>to_be_scan<\/strong>: This File will be analyzed soon.<\/note>","example":"cannot_be_scanned"},"symbolic_link":{"title":"symbolic_link","type":"string","description":"Symlink target path if the file was uploaded as a symlink"},"version":{"title":"version","required":["is_multiple","keep_forever","number","total_size"],"type":"object","properties":{"is_multiple":{"title":"is_multiple","type":"boolean","description":"File has multi-version"},"number":{"title":"number","type":"integer","description":"Get number of version"},"total_size":{"title":"total_size","type":"integer","description":"Size of the file with all version (byte unit)","nullable":true},"keep_forever":{"title":"keep_forever","type":"boolean","description":"True if the current version of this file should be kept forever, otherwise false or empty"}},"description":"Information when file has multi-version"},"conversion_capabilities":{"title":"conversion_capabilities","required":["download_extensions","onlyoffice_extension","when_downloading","when_onlyoffice_opening"],"type":"object","properties":{"when_downloading":{"title":"when_downloading","type":"boolean","description":"Whether the file may be converted upon download"},"download_extensions":{"title":"download_extensions","type":"array","items":{"type":"string","title":"download_extensions","description":"Available extensions to which the file may be converted upon download, if possible"},"description":"Available extensions to which the file may be converted upon download, if possible"},"when_onlyoffice_opening":{"title":"when_onlyoffice_opening","type":"boolean","description":"Whether the file may be converted for live edition with OnlyOffice"},"onlyoffice_extension":{"title":"onlyoffice_extension","type":"string","description":"Available extension to which the file may be converted by OnlyOffice, if possible","nullable":true,"example":"docx"}},"description":"The available ways to convert the file"},"hash":{"title":"hash","type":"string","description":"Hash of the file content","nullable":true,"example":"xxh3:00ec7bec63e548df"}}},"91ac10ff_ChartData":{"title":"Chart Data","required":["data","name","unit"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"X coordinate name"},"unit":{"title":"unit","type":"string","description":"X coordinate unit"},"data":{"title":"data","type":"object","oneOf":[{"title":"timestamp[]"},{"title":"string[]"}],"description":"X coordinate data points"},"metric":{"title":"metric","type":"string","description":"Metric of the requested chart"}}},"91ac10ff_Thirdpartydrive":{"title":"Third party drive","required":["id","name"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"string","description":"Drive identifier"},"name":{"title":"name","type":"string","description":"Drive name"}},"description":"A third party drive which may be eligible for external import"},"91ac10ff_DeletedGenericFileV2":{"title":"Deleted Generic File V2","required":["created_by","deleted_at","deleted_by","depth","id","name","parent_id","type","visibility"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Deleted Generic File V2`"},"name":{"title":"name","type":"string","description":"File name","example":"Deleted Generic File V2"},"type":{"title":"type","enum":["dir","file"],"type":"string","description":"Type of returned element either a dir (Directory) or file (File)","nullable":true,"example":"file"},"path":{"title":"path","type":"string","description":"Full path of the Deleted Generic File V2","example":"\/full\/path\/Deleted Generic File V2"},"visibility":{"title":"visibility","enum":["","is_in_private_space","is_in_shared_space","is_in_team_space_folder","is_private_space","is_root","is_shared_space","is_team_space","is_team_space_folder"],"type":"string","description":"Visibility of Deleted Generic File V2, empty string if no specific visibility. Add additional information about Deleted Generic File V2 to show different icons or more.<note><\/strong>: Empty visibility mean no special visibility.<\/note><note>is_in_private_space<\/strong>: Is a Deleted Generic File V2 inside the private directory of the user.<\/note><note>is_in_shared_space<\/strong>: Is a Deleted Generic File V2 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_in_team_space_folder<\/strong>: Is a Deleted Generic File V2 inside a Common Documents directory.<\/note><note>is_private_space<\/strong>: Is the private directory of the user.<\/note><note>is_root<\/strong>: Is the root directory of the user.<\/note><note>is_shared_space<\/strong>: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_team_space<\/strong>: Is the Common Documents directory, a special directory where the files inside are common to all users by default.<\/note><note>is_team_space_folder<\/strong>: Is the root directory inside the Common Documents.<\/note>"},"depth":{"title":"depth","type":"integer","description":"Current path depth of Deleted Generic File V2","example":3},"created_by":{"title":"created_by","type":"integer","description":"The identifier of the user who first uploaded the Deleted Generic File V2","nullable":true},"parent_id":{"title":"parent_id","type":"integer","description":"Parent directory identifier"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp of deleted resource Deleted Generic File V2, only visible when the Deleted Generic File V2 is trashed","format":"timestamp"},"deleted_by":{"title":"deleted_by","type":"integer","description":"User identifier of deleted resource Deleted Generic File V2, only visible when the Deleted Generic File V2 is trashed"},"extension_type":{"title":"extension_type","type":"string","description":"File type, properties is not returned for directory type","nullable":true,"example":"spreadsheet"}}},"91ac10ff_SanitizedActivity":{"title":"Sanitized Activity","required":["action","state"],"type":"object","properties":{"target":{"title":"target","type":"object","oneOf":[{"title":"string","type":"string"},{"title":"int","type":"integer"}],"description":"Path of the activity","example":"\/directory\/file"},"target_at":{"title":"target_at","type":"object","oneOf":[{"title":"timestamp","type":"integer","format":"timestamp"},{"title":"int","type":"integer"}],"description":"Target date of the activity"},"action":{"title":"action","enum":["archive","archive_in_trash","exclude","file_deleted","move","rename","restore","trash","update","version_deleted"],"type":"string","description":"Action to do in rewind situation.<note>archive<\/strong>: File needs to be archived in a specific directory.<\/note><note>archive_in_trash<\/strong>: File needs to be archived in trash root.<\/note><note>exclude<\/strong>: File is excluded. No actions will be performed.<\/note><note>file_deleted<\/strong>: File does not exist.<\/note><note>move<\/strong>: File needs to be moved.<\/note><note>rename<\/strong>: File needs to be renamed.<\/note><note>restore<\/strong>: File needs to be restored from trash.<\/note><note>trash<\/strong>: File needs to be trashed.<\/note><note>update<\/strong>: File content need to be updated.<\/note><note>version_deleted<\/strong>: File content does not exist.<\/note>","example":"archive"},"state":{"title":"state","enum":["not_executed","not_handled","on_conflict","on_error","success"],"type":"string","description":"State one action in the rewind process.<note>not_executed<\/strong>: Action was not executed yet.<\/note><note>not_handled<\/strong>: Action cannot be rewound.<\/note><note>on_conflict<\/strong>: Action lead to a conflict with another file\/directory, this item was moved to a specific directory.<\/note><note>on_error<\/strong>: Action lead to a fatal error, for instance the targeted version of a file was unable to be restored.<\/note><note>success<\/strong>: Action was executed correctly.<\/note>","example":"not_executed"},"special_parent_id":{"title":"special_parent_id","type":"integer","nullable":true}}},"91ac10ff_Feedbackaccessresource":{"title":"Feedback access resource","required":["access","id","message","result"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"object","oneOf":[{"title":"int","type":"integer"},{"title":"string","type":"string"}],"description":"The email,team or user identifier filled in the parameters","example":"1000"},"result":{"title":"result","type":"boolean","description":"The invitation send","example":true},"access":{"title":"access","type":"object","oneOf":[{"$ref":"#\/components\/schemas\/91ac10ff_ExternInvitationFileAccess"},{"$ref":"#\/components\/schemas\/91ac10ff_TeamFileAccess"},{"$ref":"#\/components\/schemas\/91ac10ff_Userfileaccess"}],"description":"The invitation send, null if access was not found","nullable":true},"message":{"title":"message","type":"string","description":"Additional message about why email fail to be sent","example":"error_already_exist"}}},"91ac10ff_ExternInvitationFileAccess":{"title":"Extern Invitation File Access","required":["access","color","id","name","right","status"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Extern Invitation File Access Identifier, can be team identifier, user identifier, invitation identifier"},"access":{"title":"access","enum":["invitation","team","user"],"type":"string","description":"Access type"},"name":{"title":"name","type":"string","description":"Extern Invitation File Access name"},"right":{"title":"right","type":"string","description":"Access right","nullable":true},"color":{"title":"color","type":"integer","description":"Access color","nullable":true},"status":{"title":"status","enum":["accepted","cancelled","expired","pending","rejected"],"type":"string","description":"Status of access"}}},"91ac10ff_TeamFileAccess":{"title":"Team File Access","required":["access","color","id","name","right","status"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Team File Access Identifier, can be team identifier, user identifier, invitation identifier"},"access":{"title":"access","type":"string","description":"Access type","example":"team"},"name":{"title":"name","type":"string","description":"Team File Access name"},"right":{"title":"right","type":"string","description":"Access right","nullable":true},"color":{"title":"color","type":"integer","description":"Access color","nullable":true},"status":{"title":"status","enum":["accepted","cancelled","expired","pending","rejected"],"type":"string","description":"Status of access"}}},"91ac10ff_Userfileaccess":{"title":"User file access","required":["access","color","id","name","right","status"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"User file access Identifier, can be team identifier, user identifier, invitation identifier"},"access":{"title":"access","enum":["invitation","team","user"],"type":"string","description":"Access type"},"name":{"title":"name","type":"string","description":"User file access name"},"right":{"title":"right","type":"string","description":"Access right","nullable":true},"color":{"title":"color","type":"integer","description":"Access color","nullable":true},"status":{"title":"status","enum":["accepted","cancelled","expired","pending","rejected"],"type":"string","description":"Status of access"}}},"91ac10ff_Userandteamsaccessonparentfile":{"title":"User and teams access on parent file","required":["mismatch"],"type":"object","properties":{"mismatch":{"title":"mismatch","type":"boolean","description":"Whether this file inherits the same or higher access permissions as its parent, with no downgrades."},"users":{"title":"users","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Userfileaccess"},"description":"All users that have access to the parent file"},"teams":{"title":"teams","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_TeamFileAccess"},"description":"All teams that have access to the parent file"},"name":{"title":"name","type":"string","description":"Current file's parent name"}}},"91ac10ff_Comment":{"title":"Comment","required":["body","created_at","id","is_resolved","liked","likes_count","parent_id","responses_count","updated_at"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Comment`"},"parent_id":{"title":"parent_id","type":"integer","description":"Comment parent identifier. If present, this comment is a response of another comment"},"body":{"title":"body","type":"string","description":"Comment message"},"is_resolved":{"title":"is_resolved","type":"boolean","description":"If a comment is set as resolved, solved."},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Comment` was created at","format":"timestamp"},"updated_at":{"title":"updated_at","type":"integer","description":"Timestamp `Comment` was updated at","format":"timestamp"},"liked":{"title":"liked","type":"boolean","description":"Whether current user has liked the comment"},"likes_count":{"title":"likes_count","type":"integer","description":"Number of likes"},"responses_count":{"title":"responses_count","type":"integer","description":"Number of responses for this comment"},"user":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"},"responses":{"title":"responses","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Comment"}},"likes":{"title":"likes","type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"}}}},"91ac10ff_ActivityFileV3":{"title":"Activity File V3","required":["action","created_at","file_id","id","user_id"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `Activity File V3`"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Activity File V3` was created at","format":"timestamp"},"action":{"title":"action","type":"string","description":"Activity type","example":"file_rename"},"new_path":{"title":"new_path","type":"string","description":"Current path of the activity file\/directory","example":"\/directory\/file_renamed"},"old_path":{"title":"old_path","type":"string","description":"Previous path of the activity file\/directory","example":"\/directory\/filename"},"private_path_user_id":{"title":"private_path_user_id","type":"integer","description":"get private folder user id"},"file_id":{"title":"file_id","type":"integer","description":"Logged file identifier"},"user_id":{"title":"user_id","type":"integer","description":"User identifier of the action, null if the user was not logged","nullable":true},"user":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"},"source":{"title":"source","required":["device","ip","location","name","user_agent"],"type":"object","properties":{"name":{"title":"name","enum":["api","job","webdav"],"type":"string","description":"Name of the source"},"ip":{"title":"ip","type":"string","description":"Ip of the source"},"user_agent":{"title":"user_agent","type":"string","description":"User Agent of the source"},"device":{"title":"device","type":"string","description":"Device of the source"},"location":{"title":"location","type":"string","description":"Location of the source"}},"description":"Information about where the Activity was generated"},"file":{"title":"file","type":"object","oneOf":[{"$ref":"#\/components\/schemas\/91ac10ff_FileV3"},{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"}],"description":"Associated File or Directory, null is element was deleted","nullable":true},"parent":{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"},"entity":{"title":"entity","required":["id","type"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Id of the object"},"type":{"title":"type","type":"integer","description":"Type of the object"}},"description":"Object the Activity is about"}}},"91ac10ff_ActivityV2":{"title":"Activity V2","required":["action","timestamp"],"type":"object","properties":{"action":{"title":"action","type":"string","description":"Action type"},"file_id":{"title":"file_id","type":"integer","description":"Directory\/File identifier"},"parent_id":{"title":"parent_id","type":"integer","description":"Parent directory identifier"},"file_type":{"title":"file_type","enum":["dir","file"],"type":"string","description":"Directory\/File type"},"size":{"title":"size","type":"integer","description":"Size of Activity V2 <note>The unit of size is defined in Bytes<\/note>","example":1700},"last_modified_at":{"title":"last_modified_at","type":"integer","description":"Activity V2 creation timestamp (in seconds), if available in its metadata or specified on upload","format":"timestamp"},"timestamp":{"title":"timestamp","type":"integer","description":"Time the action took place","format":"datetime"},"path":{"title":"path","type":"string","description":"Path of Directory\/File"},"destination":{"title":"destination","type":"string","description":"Destination of Directory\/File in case of move or rename action"},"created_at":{"title":"created_at","type":"integer","description":"Creation date of Directory\/File","format":"timestamp"},"symbolic_link":{"title":"symbolic_link","type":"string","description":"Symlink target path if the related file was uploaded as a symlink"}}},"91ac10ff_CursorV2":{"title":"Cursor V2","required":["activity_id","created_at","limit","page","recursive","source_id","user_id"],"type":"object","properties":{"user_id":{"title":"user_id","type":"integer","description":"ID of the user who created the cursor"},"source_id":{"title":"source_id","type":"integer","description":"ID of the directory the cursor was created in"},"activity_id":{"title":"activity_id","type":"integer","description":"ID of the last activity seen by the cursor"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp of the cursor's creation"},"recursive":{"title":"recursive","type":"boolean","description":"Whether the cursor also reads children directories"},"page":{"title":"page","type":"integer","description":"Current page of cursor data","nullable":true},"limit":{"title":"limit","type":"integer","description":"Curent limit of cursor","nullable":true}}},"91ac10ff_Uploadsegment":{"title":"Upload segment","required":["created_at","hash","number","size","status"],"type":"object","properties":{"number":{"title":"number","type":"integer","description":"Index of the chunk to compute the final object correctly"},"status":{"title":"status","enum":["error","ok","uploading"],"type":"string","description":"The chunk status during the upload.<note>error<\/strong>: Something was wrong chunk was not correctly received, retried to send the same chunk.<\/note><note>ok<\/strong>: Chunk has been received.<\/note><note>uploading<\/strong>: Chunks still uploading.<\/note>","example":"error"},"created_at":{"title":"created_at","type":"integer","description":"Timestamp `Upload segment` was created at","format":"timestamp"},"size":{"title":"size","type":"integer","description":"Chunk uploaded size, computed"},"hash":{"title":"hash","type":"string","description":"Chunk uploaded hash, computed"}}},"91ac10ff_FileDeleted":{"title":"File Deleted","required":["created_by","deleted_at","deleted_by","depth","id","name","parent_id","type","visibility"],"type":"object","properties":{"id":{"title":"Unique identifier","type":"integer","description":"Unique identifier of the resource `File Deleted`"},"name":{"title":"name","type":"string","description":"File name","example":"File Deleted"},"type":{"title":"type","enum":["dir","file"],"type":"string","description":"Type of returned element either a dir (Directory) or file (File)","nullable":true,"example":"file"},"path":{"title":"path","type":"string","description":"Full path of the File Deleted","example":"\/full\/path\/File Deleted"},"visibility":{"title":"visibility","enum":["","is_in_private_space","is_in_shared_space","is_in_team_space_folder","is_private_space","is_root","is_shared_space","is_team_space","is_team_space_folder"],"type":"string","description":"Visibility of File Deleted, empty string if no specific visibility. Add additional information about File Deleted to show different icons or more.<note><\/strong>: Empty visibility mean no special visibility.<\/note><note>is_in_private_space<\/strong>: Is a File Deleted inside the private directory of the user.<\/note><note>is_in_shared_space<\/strong>: Is a File Deleted inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_in_team_space_folder<\/strong>: Is a File Deleted inside a Common Documents directory.<\/note><note>is_private_space<\/strong>: Is the private directory of the user.<\/note><note>is_root<\/strong>: Is the root directory of the user.<\/note><note>is_shared_space<\/strong>: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.<\/note><note>is_team_space<\/strong>: Is the Common Documents directory, a special directory where the files inside are common to all users by default.<\/note><note>is_team_space_folder<\/strong>: Is the root directory inside the Common Documents.<\/note>"},"depth":{"title":"depth","type":"integer","description":"Current path depth of File Deleted","example":3},"created_by":{"title":"created_by","type":"integer","description":"The identifier of the user who first uploaded the File Deleted","nullable":true},"parent_id":{"title":"parent_id","type":"integer","description":"Parent directory identifier"},"deleted_at":{"title":"deleted_at","type":"integer","description":"Timestamp of deleted resource File Deleted, only visible when the File Deleted is trashed","format":"timestamp"},"deleted_by":{"title":"deleted_by","type":"integer","description":"User identifier of deleted resource File Deleted, only visible when the File Deleted is trashed"},"extension_type":{"title":"extension_type","type":"string","description":"File type, properties is not returned for directory type","nullable":true,"example":"spreadsheet"}}},"91ac10ff_Activity":{"title":"Activity","required":["action","executed_at"],"type":"object","properties":{"action":{"title":"action","type":"string","description":"Action type"},"file_id":{"title":"file_id","type":"integer","description":"Directory\/File identifier"},"parent_id":{"title":"parent_id","type":"integer","description":"Parent directory identifier"},"path":{"title":"path","type":"string","description":"Path of Directory\/File"},"destination":{"title":"destination","type":"string","description":"Destination of Directory\/File in case of move or rename action"},"executed_at":{"title":"executed_at","type":"integer","description":"Creation date of Directory\/File","format":"timestamp"}}},"75461840_SuccessResponseData":{"required":["data"],"type":"object","properties":{"data":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array"},{"type":"object"}],"description":"Effective response","nullable":false}}},"75461840_SuccessResponse":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"$ref":"#\/components\/schemas\/75461840_SuccessResponseData"}]},"75461840_ResponseSuccessTotalSpecific":{"required":["total"],"type":"object","properties":{"total":{"type":"integer","description":"Total number of results"}}},"75461840_TotalSuccessResponse":{"allOf":[{"$ref":"#\/components\/schemas\/75461840_SuccessResponse"},{"$ref":"#\/components\/schemas\/75461840_ResponseSuccessTotalSpecific"}]},"75461840_ResponseSuccessPaginatedSpecific":{"required":["pages","page","items_per_page"],"type":"object","properties":{"pages":{"type":"integer","description":"Total number of pages"},"page":{"type":"integer","description":"The current page"},"items_per_page":{"type":"integer","description":"Number of results per page"}}},"d26bc914_SuccessResponseData":{"required":["data"],"type":"object","properties":{"data":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array"},{"type":"object"}],"description":"Effective response","nullable":false}}},"d26bc914_SuccessResponse":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"$ref":"#\/components\/schemas\/d26bc914_SuccessResponseData"}]},"d26bc914_ResponseSuccessTotalSpecific":{"required":["total"],"type":"object","properties":{"total":{"type":"integer","description":"Total number of results"}}},"d26bc914_TotalSuccessResponse":{"allOf":[{"$ref":"#\/components\/schemas\/d26bc914_SuccessResponse"},{"$ref":"#\/components\/schemas\/d26bc914_ResponseSuccessTotalSpecific"}]},"d26bc914_ResponseSuccessPaginatedSpecific":{"required":["pages","page","items_per_page"],"type":"object","properties":{"pages":{"type":"integer","description":"Total number of pages"},"page":{"type":"integer","description":"The current page"},"items_per_page":{"type":"integer","description":"Number of results per page"}}}},"parameters":{"Return":{"description":"*Optional* : If you pass this parameter with the value `total`, then the response will be the number of items in the collection, instead of the items themselves. \nPart of the `total` capacity\n","schema":{"enum":["total"],"type":"string"},"name":"return","in":"query"},"Page":{"description":"*Optional parameter* that define the page number \nPart of the `pagination` capacity\n","schema":{"type":"integer"},"example":5,"name":"page","in":"query"},"PerPage":{"description":"*Optional parameter* that define the number of items per page \nPart of the `pagination` capacity\n","schema":{"type":"integer"},"example":10,"name":"per_page","in":"query"},"OrderBy":{"description":"*Optional parameter* that define the field used for sorting \nPart of the `sort` capacity\n","style":"form","explode":false,"schema":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"example":"id","name":"order_by","in":"query"},"Order":{"description":"*Optional parameter* that define the default sort order \nPart of the `sort` capacity\n","schema":{"enum":["asc","desc"],"type":"string","default":"asc"},"example":"asc","name":"order","in":"query"},"OrderFor":{"description":"*Optional parameter* that define the sorting order for a field \nBy default **order** is used \nPart of the `sort` capacity\n","style":"deepObject","explode":true,"schema":{"type":"object"},"name":"order_for","in":"query"},"Limit":{"description":"*Optional parameter* that define the number of items to return \nPart of the `offset` capacity\n","schema":{"type":"integer"},"example":10,"name":"limit","in":"query"},"Skip":{"description":"*Optional parameter* that define the index of the first item to return (0 = first item) \nPart of the `offset` capacity\n","schema":{"type":"integer"},"example":2,"name":"skip","in":"query"}},"securitySchemes":{"oAuth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https:\/\/login.infomaniak.com\/authorize","tokenUrl":"https:\/\/login.infomaniak.com\/token"}}},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"0":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"description":"The request is malformed."},"1":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"description":"Access to the resource is forbidden for this user."},"2":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"description":"Resource requested not found."},"3":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"description":"There was an internal error in the server."},"Forbidden":{"description":"Do not have appropriate permissions","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AppError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"error"},"error":{"type":"object","properties":{"code":{"type":"string","example":"vod_not_authorized"},"description":{"type":"string","example":"Authorization required"}}}}}],"properties":{"data":{"type":"string"}}}}}},"BadRequest":{"description":"BadRequest","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ApiError"}],"properties":{"data":{"type":"string"}}}}}},"NotFound":{"description":"NotFound","content":{"application\/json":{"schema":{"allOf":{"0":{"type":"object","properties":{"result":{"type":"string","example":"error"},"error":{"type":"object","properties":{"code":{"type":"string","example":"vod_model_not_found"},"description":{"type":"string","example":"No query results for model model 1234"},"context":{"type":"object"}}}}},"properties":{"data":{"type":"string"}}}}}}},"TooLarge":{"description":"Content too large","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AppError"}}}},"NotImplemented":{"description":"Feature is disabled","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AppError"}}}},"TooManyRequests":{"description":"Too many requests","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AppError"}}}},"InternalServerError":{"description":"Something went wrong with the server","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AppError"}}}},"a039ea57":{"description":"404 : ModelNotFoundException","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":404},"description":{"type":"string","example":"404 : ModelNotFoundException"},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"e7a7a4eb":{"description":"404 : CountHalt","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":404},"description":{"type":"string","example":"404 : CountHalt"},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"'2f952ed9'":{"description":"422 : The given data was invalid.","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":422},"description":{"type":"string","example":"422 : The given data was invalid."},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"'08d6964f'":{"description":"400 : BadRequestHttpException","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":400},"description":{"type":"string","example":"400 : BadRequestHttpException"},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"'4bc0f255'":{"description":"404 : MissingModelBehaviorException","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":404},"description":{"type":"string","example":"404 : MissingModelBehaviorException"},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"'9436319d'":{"description":"404 : InvalidImageFormatException","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":404},"description":{"type":"string","example":"404 : InvalidImageFormatException"},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"'41638d24'":{"description":"404 : FileException","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":404},"description":{"type":"string","example":"404 : FileException"},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"'556bb773'":{"description":"401 : NotAuthorized","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":401},"description":{"type":"string","example":"401 : NotAuthorized"},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"'5e128766'":{"description":"500 : Exception","content":{"application\/json":{"schema":{"allOf":[{"type":"object","properties":{"result":{"type":"string","example":"failure"},"error":{"type":"object","properties":{"code":{"type":"string","example":500},"description":{"type":"string","example":"500 : Exception"},"context":{"type":"object"}}}}}],"properties":{"data":{"type":"string"}}}}}},"GenericPaginatedOrNotPaginatedSuccessResponse":{"description":"OK","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/SuccessResponse"},{"$ref":"#\/components\/schemas\/TotalSuccessResponse"},{"$ref":"#\/components\/schemas\/PaginatedSuccessResponse"}]}}}}}}}