n8n-nodes-infomaniak-api 0.1.0

package/dist/api/infomaniak_api_kchat.json

@@ -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":{"\/api\/v4\/teams\/{team_id}\/top\/reactions":{"get":{"tags":["insights"],"summary":"Get a list of the top reactions for a team.","description":"Get a list of the top reactions across all public and private channels (the user is a member of) for a given team.\n##### Permissions\nMust have `view_team` permission for the team.\n","operationId":"GetTopReactionsForTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"time_range","in":"query","description":"Time range can be \"today\", \"7_day\", or \"28_day\".\n- `today`: reactions posted on the current day.\n- `7_day`: reactions posted in the last 7 days.\n- `28_day`: reactions posted in the last 28 days.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of items per page, up to a maximum of 200.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Top reactions retrieved successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TopReactionList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/me\/top\/reactions":{"get":{"tags":["insights"],"summary":"Get a list of the top reactions for a user.","description":"Get a list of the top reactions across all public and private channels (the user is a member of) for a given user.\nIf no `team_id` is provided, this will also include reactions posted by the given user in direct and group messages.\n##### Permissions\nMust be logged in as the user.\n","operationId":"GetTopReactionsForUser","parameters":[{"name":"time_range","in":"query","description":"Time range can be \"today\", \"7_day\", or \"28_day\".\n- `today`: reactions posted on the current day.\n- `7_day`: reactions posted in the last 7 days.\n- `28_day`: reactions posted in the last 28 days.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of items per page, up to a maximum of 200.","schema":{"type":"integer","default":60}},{"name":"team_id","in":"query","description":"Team ID will scope the response to a given team and exclude direct and group messages.\n##### Permissions\nMust have `view_team` permission for the team.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Top reactions retrieved successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TopReactionList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/teams\/{team_id}\/top\/channels":{"get":{"tags":["insights"],"summary":"Get a list of the top channels for a team.","description":"Get a list of the top public and private channels (the user is a member of) for a given team.\n##### Permissions\nMust have `view_team` permission for the team.\n","operationId":"GetTopChannelsForTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"time_range","in":"query","description":"Time range can be \"today\", \"7_day\", or \"28_day\".\n- `today`: channels with posts on the current day.\n- `7_day`: channels with posts in the last 7 days.\n- `28_day`: channels with posts in the last 28 days.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of items per page, up to a maximum of 200.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Top channels retrieved successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TopChannelList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/me\/top\/channels":{"get":{"tags":["insights"],"summary":"Get a list of the top channels for a user.","description":"Get a list of the top public and private channels (the user is a member of) for a given user.\n##### Permissions\nMust be logged in as the user.\n","operationId":"GetTopChannelsForUser","parameters":[{"name":"time_range","in":"query","description":"Time range can be \"today\", \"7_day\", or \"28_day\".\n- `today`: channels with posts on the current day.\n- `7_day`: channels with posts in the last 7 days.\n- `28_day`: channels with posts in the last 28 days.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of items per page, up to a maximum of 200.","schema":{"type":"integer","default":60}},{"name":"team_id","in":"query","description":"Team ID will scope the response to a given team.\n##### Permissions\nMust have `view_team` permission for the team.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Top channels retrieved successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TopChannelList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/teams\/{team_id}\/top\/team_members":{"get":{"tags":["insights"],"summary":"Get a list of new team members.","description":"Get a list of all of the new team members that have joined the given team during the given time period.\n##### Permissions\nMust have `view_team` permission for the team.\n","operationId":"GetNewTeamMembers","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"time_range","in":"query","description":"Time range can be \"today\", \"7_day\", or \"28_day\".\n- `today`: team members who joined during the current day.\n- `7_day`: team members who joined in the last 7 days.\n- `28_day`: team members who joined in the last 28 days.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of items per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"New team members retrieved successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_NewTeamMembersList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/teams\/{team_id}\/top\/threads":{"get":{"tags":["insights"],"summary":"Get a list of the top threads for a team.","description":"Get a list of the top threads from public and private channels (the user is a member of) for a given team.\n##### Permissions\nMust have `view_team` permission for the team.\n","operationId":"GetTopThreadsForTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"time_range","in":"query","description":"Time range can be \"today\", \"7_day\", or \"28_day\".\n- `today`: threads with activity on the current day.\n- `7_day`: threads with activity in the last 7 days.\n- `28_day`: threads with activity in the last 28 days.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of items per page, up to a maximum of 200.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Top threads retrieved successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TopThreadList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/me\/top\/threads":{"get":{"tags":["insights"],"summary":"Get a list of the top threads for a user.","description":"Get a list of the top threads from public and private channels (the user is a member of and participating in the thread) for a given user.\n##### Permissions\nMust be logged in as the user.\n","operationId":"GetTopThreadsForUser","parameters":[{"name":"time_range","in":"query","description":"Time range can be \"today\", \"7_day\", or \"28_day\".\n- `today`: threads with activity on the current day.\n- `7_day`: threads with activity in the last 7 days.\n- `28_day`: threads with activity in the last 28 days.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of items per page, up to a maximum of 200.","schema":{"type":"integer","default":60}},{"name":"team_id","in":"query","description":"Team ID will scope the response to a given team.\n##### Permissions\nMust have `view_team` permission for the team.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Top threads retrieved successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TopThreadList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/me\/top\/dms":{"get":{"tags":["insights"],"summary":"Get a list of the top dms for a user.","description":"Get a list of the top dms for a given user.\n##### Permissions\nMust be logged in as the user.\n","operationId":"GetTopDMsForUser","parameters":[{"name":"time_range","in":"query","description":"Time range can be \"today\", \"7_day\", or \"28_day\".\n- `today`: threads with activity on the current day.\n- `7_day`: threads with activity in the last 7 days.\n- `28_day`: threads with activity in the last 28 days.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of items per page, up to a maximum of 200.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Top dms retrieved successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TopDMList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users":{"get":{"tags":["users"],"summary":"Get users","description":"Get a page of a list of users. Based on query string parameters, select users from a team, channel, or select users not in a specific channel.\n\nSome basic sorting is available using the `sort` query parameter. Sorting is currently only supported when selecting users on a team.\n##### Permissions\nRequires an active session and (if specified) membership to the channel or team being selected from.\n","operationId":"GetUsers","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page. There is a maximum limit of 200 users per page.","schema":{"type":"integer","default":60}},{"name":"in_team","in":"query","description":"The ID of the team to get users for.","schema":{"type":"string"}},{"name":"not_in_team","in":"query","description":"The ID of the team to exclude users for. Must not be used with \"in_team\" query parameter.","schema":{"type":"string"}},{"name":"in_channel","in":"query","description":"The ID of the channel to get users for.","schema":{"type":"string"}},{"name":"not_in_channel","in":"query","description":"The ID of the channel to exclude users for. Must be used with \"in_channel\" query parameter.","schema":{"type":"string"}},{"name":"in_group","in":"query","description":"The ID of the group to get users for. Must have `manage_system` permission.","schema":{"type":"string"}},{"name":"group_constrained","in":"query","description":"When used with `not_in_channel` or `not_in_team`, returns only the users that are allowed to join the channel or team based on its group constrains.","schema":{"type":"boolean"}},{"name":"without_team","in":"query","description":"Whether or not to list users that are not on any team. This option takes precendence over `in_team`, `in_channel`, and `not_in_channel`.","schema":{"type":"boolean"}},{"name":"active","in":"query","description":"Whether or not to list only users that are active. This option cannot be used along with the `inactive` option.","schema":{"type":"boolean"}},{"name":"inactive","in":"query","description":"Whether or not to list only users that are deactivated. This option cannot be used along with the `active` option.","schema":{"type":"boolean"}},{"name":"role","in":"query","description":"Returns users that have this role.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort is only available in conjunction with certain options below. The paging parameter is also always available.\n\n##### `in_team`\nCan be \"\", \"last_activity_at\" or \"create_at\".\nWhen left blank, sorting is done by username.\n##### `in_channel`\nCan be \"\", \"status\".\nWhen left blank, sorting is done by username. `status` will sort by User's current status (Online, Away, DND, Offline), then by Username.\n","schema":{"type":"string"}},{"name":"roles","in":"query","description":"Comma separated string used to filter users based on any of the specified system roles\n\nExample: `?roles=system_admin,system_user` will return users that are either system admins or system users\n\n","schema":{"type":"string"}},{"name":"channel_roles","in":"query","description":"Comma separated string used to filter users based on any of the specified channel roles, can only be used in conjunction with `in_channel`\n\nExample: `?in_channel=4eb6axxw7fg3je5iyasnfudc5y&channel_roles=channel_user` will return users that are only channel users and not admins or guests\n\n","schema":{"type":"string"}},{"name":"team_roles","in":"query","description":"Comma separated string used to filter users based on any of the specified team roles, can only be used in conjunction with `in_team`\n\nExample: `?in_team=4eb6axxw7fg3je5iyasnfudc5y&team_roles=team_user` will return users that are only team users and not admins or guests\n\n","schema":{"type":"string"}}],"responses":{"200":{"description":"User page retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/ids":{"post":{"tags":["users"],"summary":"Get users by ids","description":"Get a list of users based on a provided list of user ids.\n##### Permissions\nRequires an active session but no other permissions.\n","operationId":"GetUsersByIds","parameters":[{"name":"since","in":"query","description":"Only return users that have been modified since the given Unix timestamp (in milliseconds).\n\n","schema":{"type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user ids","required":true},"responses":{"200":{"description":"User list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/users\/group_channels":{"post":{"tags":["users"],"summary":"Get users by group channels ids","description":"Get an object containing a key per group channel id in the\nquery and its value as a list of users members of that group\nchannel.\n\nThe user must be a member of the group ids in the query, or\nthey will be omitted from the response.\n##### Permissions\nRequires an active session but no other permissions.\n\n","operationId":"GetUsersByGroupChannelIds","requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of group channel ids","required":true},"responses":{"200":{"description":"User list retrieval successful","content":{"application\/json":{"schema":{"type":"object","properties":{"<CHANNEL_ID>":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/users\/usernames":{"post":{"tags":["users"],"summary":"Get users by usernames","description":"Get a list of users based on a provided list of usernames.\n##### Permissions\nRequires an active session but no other permissions.\n","operationId":"GetUsersByUsernames","requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of usernames","required":true},"responses":{"200":{"description":"User list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/users\/search":{"post":{"tags":["users"],"summary":"Search users","description":"Get a list of users based on search criteria provided in the request body. Searches are typically done against username, full name, nickname and email unless otherwise configured by the server.\n##### Permissions\nRequires an active session and `read_channel` and\/or `view_team` permissions for any channels or teams specified in the request body.\n","operationId":"SearchUsers","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The term to match against username, full name, nickname and email","type":"string"},"team_id":{"description":"If provided, only search users on this team","type":"string"},"not_in_team_id":{"description":"If provided, only search users not on this team","type":"string"},"in_channel_id":{"description":"If provided, only search users in this channel","type":"string"},"not_in_channel_id":{"description":"If provided, only search users not in this channel. Must specifiy `team_id` when using this option","type":"string"},"in_group_id":{"description":"If provided, only search users in this group. Must have `manage_system` permission.","type":"string"},"group_constrained":{"description":"When used with `not_in_channel_id` or `not_in_team_id`, returns only the users that are allowed to join the channel or team based on its group constrains.","type":"boolean"},"allow_inactive":{"description":"When `true`, include deactivated users in the results","type":"boolean"},"without_team":{"type":"boolean","description":"Set this to `true` if you would like to search for users that are not on a team. This option takes precendence over `team_id`, `in_channel_id`, and `not_in_channel_id`."},"limit":{"description":"The maximum number of users to return in the results\n\n__Defaults to `100` if not provided.__\n","type":"integer","default":100}}}}},"description":"Search criteria","required":true},"responses":{"200":{"description":"User list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/autocomplete":{"get":{"tags":["users"],"summary":"Autocomplete users","description":"Get a list of users for the purpose of autocompleting based on the provided search term. Specify a combination of `team_id` and `channel_id` to filter results further.\n##### Permissions\nRequires an active session and `view_team` and `read_channel` on any teams or channels used to filter the results further.\n","operationId":"AutocompleteUsers","parameters":[{"name":"team_id","in":"query","description":"Team ID","schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID","schema":{"type":"string"}},{"name":"name","in":"query","description":"Username, nickname first name or last name","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of users to return in each subresult\n\n__Defaults to `100` if not provided.__\n","schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"User autocomplete successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_UserAutocomplete"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}":{"get":{"tags":["users"],"summary":"Get a user","description":"Get a user a object. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session but no other permissions.\n","operationId":"GetUser","parameters":[{"name":"user_id","in":"path","description":"User GUID. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/patch":{"put":{"tags":["users"],"summary":"Patch a user","description":"Partially update a user by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","operationId":"PatchUser","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"username":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"nickname":{"type":"string"},"locale":{"type":"string"},"position":{"type":"string"},"props":{"type":"object"},"notify_props":{"$ref":"#\/components\/schemas\/38cb7293_UserNotifyProps"}}}}},"description":"User object that is to be updated","required":true},"responses":{"200":{"description":"User patch successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/roles":{"put":{"tags":["users"],"summary":"Update a user's roles","description":"Update a user's system-level roles. Valid user roles are \"system_user\", \"system_admin\" or both of them. Overwrites any previously assigned system-level roles.\n##### Permissions\nMust have the `manage_roles` permission.\n","operationId":"UpdateUserRoles","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["roles"],"properties":{"roles":{"type":"string"}}}}},"description":"Space-delimited system roles to assign to the user","required":true},"responses":{"200":{"description":"User roles update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/image":{"get":{"tags":["users"],"summary":"Get user's profile image","description":"Get a user's profile image based on user_id string parameter.\n##### Permissions\nMust be logged in.\n","operationId":"GetProfileImage","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"_","in":"query","description":"Not used by the server. Clients can pass in the last picture update time of the user to potentially take advantage of caching","required":false,"schema":{"type":"number"}}],"responses":{"200":{"description":"User's profile image","content":{"image\/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/users\/{user_id}\/image\/default":{"get":{"tags":["users"],"summary":"Return user's default (generated) profile image","description":"Returns the default (generated) user profile image based on user_id string parameter.\n##### Permissions\nMust be logged in.\n","operationId":"GetDefaultProfileImage","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Default profile image","content":{"image\/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/users\/username\/{username}":{"get":{"tags":["users"],"summary":"Get a user by username","description":"Get a user object by providing a username. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session but no other permissions.\n","operationId":"GetUserByUsername","parameters":[{"name":"username","in":"path","description":"Username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/email\/{email}":{"get":{"tags":["users"],"summary":"Get a user by email","description":"Get a user object by providing a user email. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session and for the current session to be able to view another user's email based on the server's privacy settings.\n","operationId":"GetUserByEmail","parameters":[{"name":"email","in":"path","description":"User Email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/typing":{"post":{"tags":["users"],"summary":"Publish a user typing websocket event.","description":"Notify users in the given channel via websocket that the given user is typing.\n##### Permissions\nMust have `manage_system` permission to publish for any user other than oneself.\n","operationId":"PublishUserTyping","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["channel_id"],"properties":{"channel_id":{"description":"The id of the channel to which to direct the typing event.","type":"string"},"parent_id":{"description":"The optional id of the root post of the thread to which the user is replying. If unset, the typing event is directed at the entire channel.","type":"string"}}}}}},"responses":{"200":{"description":"User typing websocket event accepted for publishing.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/channel_members":{"get":{"tags":["users"],"summary":"Get all channel members for a user","description":"Get all channel members for a user.\n\n##### Permissions\nLogged in as the user, or have `edit_other_users` permission.\n","operationId":"GetChannelMembersWithTeamDataForUser","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page specifies which part of the results to return, by PageSize.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"PageSize specifies the size of the returned chunk of results.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"User's uploads retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_ChannelMemberWithTeamData"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/threads":{"get":{"tags":["threads"],"summary":"Get all threads that user is following","description":"Get all threads that user is following\n\n\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.\n","operationId":"GetUserThreads","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"The ID of the team in which the thread is.","required":true,"schema":{"type":"string"}},{"name":"since","in":"query","description":"Since filters the threads based on their LastUpdateAt timestamp.","required":false,"schema":{"type":"integer"}},{"name":"deleted","in":"query","description":"Deleted will specify that even deleted threads should be returned (For mobile sync).","required":false,"schema":{"type":"boolean","default":false}},{"name":"extended","in":"query","description":"Extended will enrich the response with participant details.","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Page specifies which part of the results to return, by PageSize.","required":false,"schema":{"type":"integer","default":0}},{"name":"pageSize","in":"query","description":"PageSize specifies the size of the returned chunk of results.","required":false,"schema":{"default":30,"type":"integer"}},{"name":"totalsOnly","in":"query","description":"Setting this to true will only return the total counts.","required":false,"schema":{"type":"boolean","default":false}},{"name":"threadsOnly","in":"query","description":"Setting this to true will only return threads.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"User's thread retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_UserThreads"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/threads\/read":{"put":{"tags":["threads"],"summary":"Mark all threads that user is following as read","description":"Mark all threads that user is following as read\n\n\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.\n","operationId":"UpdateThreadsReadForUser","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"The ID of the team in which the thread is.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User's thread update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/threads\/{thread_id}\/read\/{timestamp}":{"put":{"tags":["threads"],"summary":"Mark a thread that user is following read state to the timestamp","description":"Mark a thread that user is following as read\n\n\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.\n","operationId":"UpdateThreadReadForUser","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"The ID of the team in which the thread is.","required":true,"schema":{"type":"string"}},{"name":"thread_id","in":"path","description":"The ID of the thread to update","required":true,"schema":{"type":"string"}},{"name":"timestamp","in":"path","description":"The timestamp to which the thread's \"last read\" state will be reset.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User's thread update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_UserThread"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/threads\/{thread_id}\/set_unread\/{post_id}":{"put":{"tags":["threads"],"summary":"Mark a thread that user is following as unread based on a post id","description":"Mark a thread that user is following as unread\n\n##### Permissions\nMust have `read_channel` permission for the channel the thread is in or if the channel is public, have the `read_public_channels` permission for the team.\n\nMust have `edit_other_users` permission if the user is not the one marking the thread for himself.\n","operationId":"SetThreadUnreadByPostId","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"The ID of the team in which the thread is.","required":true,"schema":{"type":"string"}},{"name":"thread_id","in":"path","description":"The ID of the thread to update","required":true,"schema":{"type":"string"}},{"name":"post_id","in":"path","description":"The ID of a post belonging to the thread to mark as unread.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User's thread update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_UserThread"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/threads\/{thread_id}\/following":{"put":{"tags":["threads"],"summary":"Start following a thread","description":"Start following a thread\n\n\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.\n","operationId":"StartFollowingThread","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"The ID of the team in which the thread is.","required":true,"schema":{"type":"string"}},{"name":"thread_id","in":"path","description":"The ID of the thread to follow","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User's thread update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"delete":{"tags":["threads"],"summary":"Stop following a thread","description":"Stop following a thread\n\n\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.\n","operationId":"StopFollowingThread","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"The ID of the team in which the thread is.","required":true,"schema":{"type":"string"}},{"name":"thread_id","in":"path","description":"The ID of the thread to update","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User's thread update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/threads\/{thread_id}":{"get":{"tags":["threads"],"summary":"Get a thread followed by the user","description":"Get a thread\n\n\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.\n","operationId":"GetUserThread","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"The ID of the team in which the thread is.","required":true,"schema":{"type":"string"}},{"name":"thread_id","in":"path","description":"The ID of the thread to follow","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get was successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_UserThread"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/status":{"get":{"tags":["status"],"summary":"Get user status","description":"Get user status by id from the server.\n##### Permissions\nMust be authenticated.\n","operationId":"GetUserStatus","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User status retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Status"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}},"put":{"tags":["status"],"summary":"Update user status","description":"Manually set a user's status. When setting a user's status, the status will remain that value until set \"online\" again, which will return the status to being automatically updated based on user activity.\n##### Permissions\nMust have `edit_other_users` permission for the team.\n","operationId":"UpdateUserStatus","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["status","user_id"],"properties":{"user_id":{"type":"string","description":"User ID"},"status":{"type":"string","description":"User status, can be `online`, `away`, `offline` and `dnd`"},"dnd_end_time":{"type":"integer","description":"Time in epoch seconds at which a dnd status would be unset."}}}}},"description":"Status object that is to be updated","required":true},"responses":{"200":{"description":"User status update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Status"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/users\/status\/ids":{"post":{"tags":["status"],"summary":"Get user statuses by id","description":"Get a list of user statuses by id from the server.\n##### Permissions\nMust be authenticated.\n","operationId":"GetUsersStatusesByIds","requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user ids to fetch","required":true},"responses":{"200":{"description":"User statuses retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Status"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/users\/{user_id}\/status\/custom":{"put":{"tags":["status"],"summary":"Update user custom status","description":"Updates a user's custom status by setting the value in the user's props and updates the user. Also save the given custom status to the recent custom statuses in the user's props\n##### Permissions\nMust be logged in as the user whose custom status is being updated.\n","operationId":"UpdateUserCustomStatus","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["emoji","text"],"properties":{"emoji":{"type":"string","description":"Any emoji"},"text":{"type":"string","description":"Any custom status text"},"duration":{"type":"string","description":"Duration of custom status, can be `thirty_minutes`, `one_hour`, `four_hours`, `today`, `this_week` or `date_and_time`"},"expires_at":{"type":"string","description":"The time at which custom status should be expired. It should be in ISO format."}}}}},"description":"Custom status object that is to be updated","required":true},"responses":{"200":{"description":"User custom status update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}},"delete":{"tags":["status"],"summary":"Unsets user custom status","description":"Unsets a user's custom status by updating the user's props and updates the user\n##### Permissions\nMust be logged in as the user whose custom status is being removed.\n","operationId":"UnsetUserCustomStatus","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User custom status delete successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/users\/{user_id}\/status\/custom\/recent\/delete":{"post":{"tags":["status"],"summary":"Delete user's recent custom status","description":"Deletes a user's recent custom status by removing the specific status from the recentCustomStatuses in the user's props and updates the user.\n##### Permissions\nMust be logged in as the user whose recent custom status is being deleted.\n","operationId":"PostUserRecentCustomStatusDelete","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["emoji","text","duration","expires_at"],"properties":{"emoji":{"type":"string","description":"Any emoji"},"text":{"type":"string","description":"Any custom status text"},"duration":{"type":"string","description":"Duration of custom status, can be `thirty_minutes`, `one_hour`, `four_hours`, `today`, `this_week` or `date_and_time`"},"expires_at":{"type":"string","description":"The time at which custom status should be expired. It should be in ISO format."}}}}},"description":"Custom Status object that is to be removed from the recent custom statuses.","required":true},"responses":{"200":{"description":"User recent custom status delete successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/teams":{"get":{"tags":["teams"],"summary":"Get teams","description":"For regular users only returns open teams. Users with the \"manage_system\" permission will return teams regardless of type. The result is based on query string parameters - page and per_page.\n##### Permissions\nMust be authenticated.\n","operationId":"GetAllTeams","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of teams per page.","schema":{"type":"integer","default":60}},{"name":"include_total_count","description":"Appends a total count of returned teams inside the response object - ex: `{ \"teams\": [], \"total_count\" : 0 }`.      ","in":"query","schema":{"type":"boolean","default":false}},{"name":"exclude_policy_constrained","in":"query","schema":{"type":"boolean","default":false},"description":"If set to true, teams which are part of a data retention policy will be excluded. The `sysconsole_read_compliance` permission is required to use this parameter.\n"}],"responses":{"200":{"description":"Team list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Team"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/teams\/{team_id}":{"get":{"tags":["teams"],"summary":"Get a team","description":"Get a team on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","operationId":"GetTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Team"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/name\/{name}":{"get":{"tags":["teams"],"summary":"Get a team by name","description":"Get a team based on provided name string\n##### Permissions\nMust be authenticated, team type is open and have the `view_team` permission.\n","operationId":"GetTeamByName","parameters":[{"name":"name","in":"path","description":"Team Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Team"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams":{"get":{"tags":["teams"],"summary":"Get a user's teams","description":"Get a list of teams that a user is on.\n##### Permissions\nMust be authenticated as the user or have the `manage_system` permission.\n","operationId":"GetTeamsForUser","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Team"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/teams\/{team_id}\/members":{"get":{"tags":["teams"],"summary":"Get team members","description":"Get a page team members list based on query string parameters - team id, page and per page.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","operationId":"GetTeamMembers","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Team members retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_TeamMember"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/members":{"get":{"tags":["teams"],"summary":"Get team members for a user","description":"Get a list of team members for a user. Useful for getting the ids of teams the user is on and the roles they have in those teams.\n##### Permissions\nMust be logged in as the user or have the `edit_other_users` permission.\n","operationId":"GetTeamMembersForUser","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team members retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_TeamMember"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/members\/{user_id}":{"get":{"tags":["teams"],"summary":"Get a team member","description":"Get a team member on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","operationId":"GetTeamMember","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team member retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TeamMember"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/members\/ids":{"post":{"tags":["teams"],"summary":"Get team members by ids","description":"Get a list of team members based on a provided array of user ids.\n##### Permissions\nMust have `view_team` permission for the team.\n","operationId":"GetTeamMembersByIds","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user ids","required":true},"responses":{"200":{"description":"Team members retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_TeamMember"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/teams\/{team_id}\/stats":{"get":{"tags":["teams"],"summary":"Get a team stats","description":"Get a team stats on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","operationId":"GetTeamStats","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team stats retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TeamStats"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/members\/{user_id}\/roles":{"put":{"tags":["teams"],"summary":"Update a team member roles","description":"Update a team member roles. Valid team roles are \"team_user\", \"team_admin\" or both of them. Overwrites any previously assigned team roles.\n##### Permissions\nMust be authenticated and have the `manage_team_roles` permission.\n","operationId":"UpdateTeamMemberRoles","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["roles"],"properties":{"roles":{"type":"string"}}}}},"description":"Space-delimited team roles to assign to the user","required":true},"responses":{"200":{"description":"Team member roles update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/unread":{"get":{"tags":["teams"],"summary":"Get team unreads for a user","description":"Get the count for unread messages and mentions in the teams the user is a member of.\n##### Permissions\nMust be logged in.\n","operationId":"GetTeamsUnreadForUser","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"exclude_team","in":"query","description":"Optional team id to be excluded from the results","required":true,"schema":{"type":"string"}},{"name":"include_collapsed_threads","in":"query","description":"Boolean to determine whether the collapsed threads should be included or not","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Team unreads retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_TeamUnread"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/unread":{"get":{"tags":["teams"],"summary":"Get unreads for a team","description":"Get the unread mention and message counts for a team for the specified user.\n##### Permissions\nMust be the user or have `edit_other_users` permission and have `view_team` permission for the team.\n","operationId":"GetTeamUnread","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team unread count retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_TeamUnread"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/invite-guests\/email":{"post":{"tags":["teams"],"summary":"Invite guests to the team by email","description":"Invite guests to existing team channels usign the user's email.\n\nThe number of emails that can be sent is rate limited to 20 per hour with a burst of 20 emails. If the rate limit exceeds, the error message contains details on when to retry and when the timer will be reset.\n\n##### Permissions\nMust have `invite_guest` permission for the team.\n","operationId":"InviteGuestsToTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["emails","channels"],"properties":{"emails":{"type":"array","items":{"type":"string"},"description":"List of emails"},"channels":{"type":"array","items":{"type":"string"},"description":"List of channel ids"},"message":{"type":"string","description":"Message to include in the invite"}}}}},"description":"Guests invite information","required":true},"responses":{"200":{"description":"Guests invite successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"413":{"$ref":"#\/components\/responses\/TooLarge"}}}},"\/api\/v4\/channels":{"get":{"tags":["channels"],"summary":"Get a list of all channels","description":"##### Permissions\n`manage_system`\n","operationId":"GetAllChannels","parameters":[{"name":"not_associated_to_group","in":"query","description":"A group id to exclude channels that are associated with that group via GroupChannel records. This can also be left blank with `not_associated_to_group=`.","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of channels per page.","schema":{"type":"integer","default":0}},{"name":"exclude_default_channels","in":"query","description":"Whether to exclude default channels (ex Town Square, Off-Topic) from the results.","schema":{"type":"boolean","default":false}},{"name":"include_deleted","in":"query","description":"Include channels that have been archived. This correlates to the `DeleteAt` flag being set in the database.","schema":{"type":"boolean","default":false}},{"name":"include_total_count","in":"query","description":"Appends a total count of returned channels inside the response object - ex: `{ \"channels\": [], \"total_count\" : 0 }`.      ","schema":{"type":"boolean","default":false}},{"name":"exclude_policy_constrained","in":"query","schema":{"type":"boolean","default":false},"description":"If set to true, channels which are part of a data retention policy will be excluded. The `sysconsole_read_compliance` permission is required to use this parameter.\n"}],"responses":{"200":{"description":"Channel list retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_ChannelListWithTeamData"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"post":{"tags":["channels"],"summary":"Create a channel","description":"Create a new channel.\n##### Permissions\nIf creating a public channel, `create_public_channel` permission is required. If creating a private channel, `create_private_channel` permission is required.\n","operationId":"CreateChannel","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["name","display_name","type","team_id"],"properties":{"team_id":{"type":"string","description":"The team ID of the team to create the channel on"},"name":{"type":"string","description":"The unique handle for the channel, will be present in the channel URL"},"display_name":{"type":"string","description":"The non-unique UI name for the channel"},"purpose":{"type":"string","description":"A short description of the purpose of the channel"},"header":{"type":"string","description":"Markdown-formatted text to display in the header of the channel"},"type":{"type":"string","description":"'O' for a public channel, 'P' for a private channel"}}}}},"description":"Channel object to be created","required":true},"responses":{"201":{"description":"Channel creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/direct":{"post":{"tags":["channels"],"summary":"Create a direct message channel","description":"Create a new direct message channel between two users.\n##### Permissions\nMust be one of the two users and have `create_direct_channel` permission. Having the `manage_system` permission voids the previous requirements.\n","operationId":"CreateDirectChannel","requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2}}},"description":"The two user ids to be in the direct message","required":true},"responses":{"201":{"description":"Direct channel creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/group":{"post":{"tags":["channels"],"summary":"Create a group message channel","description":"Create a new group message channel to group of users. If the logged in user's id is not included in the list, it will be appended to the end.\n##### Permissions\nMust have `create_group_channel` permission.\n","operationId":"CreateGroupChannel","requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"User ids to be in the group message channel","required":true},"responses":{"201":{"description":"Group channel creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/search":{"post":{"tags":["channels"],"summary":"Search all private and open type channels","description":"Returns all private and open type channels where 'term' matches on the name, display name, or purpose of\nthe channel.\n\nConfigured 'default' channels (ex Town Square and Off-Topic) can be excluded from the results\nwith the `exclude_default_channels` boolean parameter.\n\nChannels that are associated (via GroupChannel records) to a given group can be excluded from the results\nwith the `not_associated_to_group` parameter and a group id string.\n","operationId":"SearchAllChannels","parameters":[{"name":"system_console","in":"query","description":"Is the request from system_console. If this is set to true, it filters channels by the logged in user.\n","required":false,"schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"type":"string","description":"The string to search in the channel name, display name, and purpose."},"not_associated_to_group":{"type":"string","description":"A group id to exclude channels that are associated to that group via GroupChannel records."},"exclude_default_channels":{"type":"boolean","description":"Exclude default channels from the results by setting this parameter to true."},"team_ids":{"type":"array","items":{"type":"string"},"description":"Filters results to channels belonging to the given team ids\n\n"},"group_constrained":{"type":"boolean","description":"Filters results to only return channels constrained to a group\n\n"},"exclude_group_constrained":{"type":"boolean","description":"Filters results to exclude channels constrained to a group\n\n"},"public":{"type":"boolean","description":"Filters results to only return Public \/ Open channels, can be used in conjunction with `private` to return both `public` and `private` channels\n\n"},"private":{"type":"boolean","description":"Filters results to only return Private channels, can be used in conjunction with `public` to return both `private` and `public` channels\n\n"},"deleted":{"type":"boolean","description":"Filters results to only return deleted \/ archived channels\n\n"},"page":{"type":"integer","description":"The page number to return, if paginated. If this parameter is not present with the `per_page` parameter then the results will be returned un-paged."},"per_page":{"type":"integer","description":"The number of entries to return per page, if paginated. If this parameter is not present with the `page` parameter then the results will be returned un-paged."},"exclude_policy_constrained":{"type":"boolean","default":false,"description":"If set to true, only channels which do not have a granular retention policy assigned to them will be returned. The `sysconsole_read_compliance_data_retention` permission is required to use this parameter.\n\n"},"include_search_by_id":{"type":"boolean","default":false,"description":"If set to true, returns channels where given search 'term' matches channel ID.\n\n"}}}}},"description":"The search terms and logic to use in the search.","required":true},"responses":{"200":{"description":"Paginated channel response. (Note that the non-paginated response\u2014returned if the request body does not contain both `page` and `per_page` fields\u2014is a simple array of channels.)","content":{"application\/json":{"schema":{"type":"object","properties":{"channels":{"type":"array","description":"The channels that matched the query.","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}},"total_count":{"type":"number","description":"The total number of results, regardless of page and per_page requested."}}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/channels\/group\/search":{"post":{"tags":["channels"],"summary":"Search Group Channels","description":"Get a list of group channels for a user which members' usernames match the search term.\n\n","operationId":"SearchGroupChannels","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The search term to match against the members' usernames of the group channels","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"200":{"description":"Channels search successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/teams\/{team_id}\/channels\/ids":{"post":{"tags":["channels"],"summary":"Get a list of channels by ids","description":"Get a list of public channels on a team by id.\n##### Permissions\n`view_team` for the team the channels are on.\n","operationId":"GetPublicChannelsByIdsForTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of channel ids","required":true},"responses":{"200":{"description":"Channel list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}":{"get":{"tags":["channels"],"summary":"Get a channel","description":"Get channel from the provided channel id string.\n##### Permissions\n`read_channel` permission for the channel.\n","operationId":"GetChannel","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"put":{"tags":["channels"],"summary":"Update a channel","description":"Update a channel. The fields that can be updated are listed as parameters. Omitted fields will be treated as blanks.\n##### Permissions\nIf updating a public channel, `manage_public_channel_members` permission is required. If updating a private channel, `manage_private_channel_members` permission is required.\n","operationId":"UpdateChannel","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The channel's id, not updatable"},"name":{"type":"string","description":"The unique handle for the channel, will be present in the channel URL"},"display_name":{"type":"string","description":"The non-unique UI name for the channel"},"purpose":{"type":"string","description":"A short description of the purpose of the channel"},"header":{"type":"string","description":"Markdown-formatted text to display in the header of the channel"}}}}},"description":"Channel object to be updated","required":true},"responses":{"200":{"description":"Channel update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"delete":{"tags":["channels"],"summary":"Delete a channel","description":"Archives a channel. This will set the `deleteAt` to the current timestamp in the database. Soft deleted channels may not be accessible in the user interface. They can be viewed and unarchived in the **System Console > User Management > Channels** based on your license. Direct and group message channels cannot be deleted.\n\n##### Permissions\n`delete_public_channel` permission if the channel is public,\n`delete_private_channel` permission if the channel is private,\nor have `manage_system` permission.\n","operationId":"DeleteChannel","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel deletion successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/{channel_id}\/patch":{"put":{"tags":["channels"],"summary":"Patch a channel","description":"Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nIf updating a public channel, `manage_public_channel_members` permission is required. If updating a private channel, `manage_private_channel_members` permission is required.\n","operationId":"PatchChannel","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The unique handle for the channel, will be present in the channel URL"},"display_name":{"type":"string","description":"The non-unique UI name for the channel"},"purpose":{"type":"string","description":"A short description of the purpose of the channel"},"header":{"type":"string","description":"Markdown-formatted text to display in the header of the channel"}}}}},"description":"Channel object to be updated","required":true},"responses":{"200":{"description":"Channel patch successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}\/privacy":{"put":{"tags":["channels"],"summary":"Update channel's privacy","description":"Updates channel's privacy allowing changing a channel from Public to Private and back.\n\n##### Permissions\n`convert_public_channel_to_private` permission for the channel if updating privacy to 'P'. `convert_private_channel_to_public` permission for the channel if updating privacy to 'O'.\n","operationId":"UpdateChannelPrivacy","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["privacy"],"properties":{"privacy":{"type":"string","description":"Channel privacy setting: 'O' for a public channel, 'P' for a private channel"}}}}},"required":true},"responses":{"200":{"description":"Channel conversion successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}\/restore":{"post":{"tags":["channels"],"summary":"Restore a channel","description":"Restore channel from the provided channel id string.\n\n##### Permissions\n`manage_team` permission for the team of the channel.\n","operationId":"RestoreChannel","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel restore successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}\/move":{"post":{"tags":["channels"],"summary":"Move a channel","description":"Move a channel to another team.\n\n\n##### Permissions\n\nMust have `manage_system` permission.\n","operationId":"MoveChannel","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["team_id"],"properties":{"team_id":{"type":"string"},"force":{"description":"Remove members those are not member of target team before moving the channel.","type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Channel move successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}\/stats":{"get":{"tags":["channels"],"summary":"Get channel statistics","description":"Get statistics for a channel.\n##### Permissions\nMust have the `read_channel` permission.\n","operationId":"GetChannelStats","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel statistics retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_ChannelStats"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/{channel_id}\/pinned":{"get":{"tags":["channels"],"summary":"Get a channel's pinned posts","description":"Get a list of pinned posts for channel.","operationId":"GetPinnedPosts","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of channel pinned posts","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_PostList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/teams\/{team_id}\/channels":{"get":{"tags":["channels"],"summary":"Get public channels","description":"Get a page of public channels on a team based on query string parameters - page and per_page.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"GetPublicChannelsForTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of public channels per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Channels retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/channels\/private":{"get":{"tags":["channels"],"summary":"Get private channels","description":"Get a page of private channels on a team based on query string\nparameters - team_id, page and per_page.\n\n\n##### Permissions\nMust have `manage_system` permission.\n","operationId":"GetPrivateChannelsForTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of private channels per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Channels retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/channels\/deleted":{"get":{"tags":["channels"],"summary":"Get deleted channels","description":"Get a page of deleted channels on a team based on query string parameters - team_id, page and per_page.\n\n","operationId":"GetDeletedChannelsForTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of public channels per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Channels retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/channels\/autocomplete":{"get":{"tags":["channels"],"summary":"Autocomplete channels","description":"Autocomplete public channels on a team based on the search term provided in the request URL.\n\n##### Permissions\nMust have the `list_team_channels` permission.\n","operationId":"AutocompleteChannelsForTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Name or display name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channels autocomplete successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/channels\/search_autocomplete":{"get":{"tags":["channels"],"summary":"Autocomplete channels for search","description":"Autocomplete your channels on a team based on the search term provided in the request URL.\n\n##### Permissions\nMust have the `list_team_channels` permission.\n","operationId":"AutocompleteChannelsForTeamForSearch","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Name or display name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channels autocomplete successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/channels\/search":{"post":{"tags":["channels"],"summary":"Search channels","description":"Search public channels on a team based on the search term provided in the request body.\n##### Permissions\nMust have the `list_team_channels` permission.\n\nA user without the `list_team_channels` permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.\n","operationId":"SearchChannels","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The search term to match against the name or display name of channels","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"201":{"description":"Channels search successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/channels\/search_archived":{"post":{"tags":["channels"],"summary":"Search archived channels","description":"Search archived channels on a team based on the search term provided in the request body.\n\n##### Permissions\nMust have the `list_team_channels` permission.\n\nA user without the `list_team_channels` permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.\n","operationId":"SearchArchivedChannels","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The search term to match against the name or display name of archived channels","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"201":{"description":"Channels search successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/{team_id}\/channels\/name\/{channel_name}":{"get":{"tags":["channels"],"summary":"Get a channel by name","description":"Gets channel from the provided team id and channel name strings.\n##### Permissions\n`read_channel` permission for the channel.\n","operationId":"GetChannelByName","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"channel_name","in":"path","description":"Channel Name","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Defines if deleted channels should be returned or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Channel retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/teams\/name\/{team_name}\/channels\/name\/{channel_name}":{"get":{"tags":["channels"],"summary":"Get a channel by name and team name","description":"Gets a channel from the provided team name and channel name strings.\n##### Permissions\n`read_channel` permission for the channel.\n","operationId":"GetChannelByNameForTeamName","parameters":[{"name":"team_name","in":"path","description":"Team Name","required":true,"schema":{"type":"string"}},{"name":"channel_name","in":"path","description":"Channel Name","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Defines if deleted channels should be returned or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Channel retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}\/members":{"get":{"tags":["channels"],"summary":"Get channel members","description":"Get a page of members for a channel.\n##### Permissions\n`read_channel` permission for the channel.\n","operationId":"GetChannelMembers","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of members per page. There is a maximum limit of 200 members.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Channel members retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_ChannelMember"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}},"post":{"tags":["channels"],"summary":"Add user(s) to channel","description":"Add a user(s) to a channel by creating a channel member object(s).","operationId":"AddChannelMember","parameters":[{"name":"channel_id","in":"path","description":"The channel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of user to add into the channel, for backwards compatibility."},"user_ids":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":1000,"description":"The IDs of users to add into the channel, required if 'user_id' doess not exist."},"post_root_id":{"type":"string","description":"The ID of root post where link to add channel member originates"}}}}},"required":true},"responses":{"201":{"description":"Channel member creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_ChannelMember"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/{channel_id}\/members\/ids":{"post":{"tags":["channels"],"summary":"Get channel members by ids","description":"Get a list of channel members based on the provided user ids.\n##### Permissions\nMust have the `read_channel` permission.\n","operationId":"GetChannelMembersByIds","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user ids","required":true},"responses":{"200":{"description":"Channel member list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_ChannelMember"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}\/members\/{user_id}":{"get":{"tags":["channels"],"summary":"Get channel member","description":"Get a channel member.\n##### Permissions\n`read_channel` permission for the channel.\n","operationId":"GetChannelMember","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel member retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_ChannelMember"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}},"delete":{"tags":["channels"],"summary":"Remove user from channel","description":"Delete a channel member, effectively removing them from a channel.\n\nChannel members can only be deleted from public or private channels.\n##### Permissions\n`manage_public_channel_members` permission if the channel is public.\n`manage_private_channel_members` permission if the channel is private.\n","operationId":"RemoveUserFromChannel","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel member deletion successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/{channel_id}\/members\/{user_id}\/roles":{"put":{"tags":["channels"],"summary":"Update channel roles","description":"Update a user's roles for a channel.\n##### Permissions\nMust have `manage_channel_roles` permission for the channel.\n","operationId":"UpdateChannelRoles","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["roles"],"properties":{"roles":{"type":"string"}}}}},"description":"Space-delimited channel roles to assign to the user","required":true},"responses":{"200":{"description":"Channel roles update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/{channel_id}\/members\/{user_id}\/schemeRoles":{"put":{"tags":["channels"],"summary":"Update the scheme-derived roles of a channel member.","description":"Update a channel member's scheme_admin\/scheme_user properties. Typically this should either be `scheme_admin=false, scheme_user=true` for ordinary channel member, or `scheme_admin=true, scheme_user=true` for a channel admin.\n##### Permissions\nMust be authenticated and have the `manage_channel_roles` permission.\n","operationId":"UpdateChannelMemberSchemeRoles","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["scheme_admin","scheme_user"],"properties":{"scheme_admin":{"type":"boolean"},"scheme_user":{"type":"boolean"}}}}},"description":"Scheme properties.","required":true},"responses":{"200":{"description":"Channel member's scheme-derived roles updated successfully.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}\/members\/{user_id}\/notify_props":{"put":{"tags":["channels"],"summary":"Update channel notifications","description":"Update a user's notification properties for a channel. Only the provided fields are updated.\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.\n","operationId":"UpdateChannelNotifyProps","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_ChannelNotifyProps"}}},"required":true},"responses":{"200":{"description":"Channel notification properties update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/members\/{user_id}\/view":{"post":{"tags":["channels"],"summary":"View channel","description":"Perform all the actions involved in viewing a channel. This includes marking channels as read, clearing push notifications, and updating the active channel.\n","operationId":"ViewChannel","parameters":[{"in":"path","name":"user_id","description":"User ID to perform the view action for","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["channel_id"],"properties":{"channel_id":{"type":"string","description":"The channel ID that is being viewed. Use a blank string to indicate that all channels have lost focus.","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"prev_channel_id":{"type":"string","description":"The channel ID of the previous channel, used when switching channels. Providing this ID will cause push notifications to clear on the channel being switched to.","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}}},"description":"Paremeters affecting how and which channels to view","required":true},"responses":{"200":{"description":"Channel view successful","content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Value should be \"OK\" if successful"},"last_viewed_at_times":{"type":"object","description":"A JSON object mapping channel IDs to the channel view times"}}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/channels\/members":{"get":{"tags":["channels"],"summary":"Get channel memberships and roles for a user","description":"Get all channel memberships and associated membership roles (i.e. `channel_user`, `channel_admin`) for a user on a specific team.\n##### Permissions\nLogged in as the user and `view_team` permission for the team. Having `manage_system` permission voids the previous requirements.\n","operationId":"GetChannelMembersForUser","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel members retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_ChannelMember"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/channels":{"get":{"tags":["channels"],"summary":"Get channels for user","description":"Get all the channels on a team for a user.\n##### Permissions\nLogged in as the user, or have `edit_other_users` permission, and `view_team` permission for the team.\n","operationId":"GetChannelsForTeamForUser","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Defines if deleted channels should be returned or not","schema":{"type":"boolean","default":false}},{"name":"last_delete_at","in":"query","description":"Filters the deleted channels by this time in epoch format. Does not have any effect if include_deleted is set to false.","schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Channels retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/channels":{"get":{"tags":["channels"],"summary":"Get all channels","description":"Get all channels that a user is a member of.\n\n##### Permissions\n\nLogged in as the user, or have `edit_other_users` permission.\n","operationId":"GetChannelsForUser","parameters":[{"name":"user_id","in":"path","description":"The ID of the user. This can also be \"me\" which will point to the current user.","required":true,"schema":{"type":"string"}},{"name":"last_delete_at","in":"query","description":"Filters the deleted channels by this time in epoch format. Does not have any effect if include_deleted is set to false.","schema":{"type":"integer","default":0}},{"name":"include_deleted","in":"query","description":"Defines if deleted channels should be returned or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Channels retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Channel"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/channels\/{channel_id}\/unread":{"get":{"tags":["channels"],"summary":"Get unread messages","description":"Get the total unread messages and mentions for a channel for a user.\n##### Permissions\nMust be logged in as user and have the `read_channel` permission, or have `edit_other_usrs` permission.\n","operationId":"GetChannelUnread","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel unreads retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_ChannelUnread"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/channels\/{channel_id}\/scheme":{"put":{"tags":["channels"],"summary":"Set a channel's scheme","description":"Set a channel's scheme, more specifically sets the scheme_id value of a channel record.\n\n##### Permissions\nMust have `manage_system` permission.\n\n","operationId":"UpdateChannelScheme","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["scheme_id"],"properties":{"scheme_id":{"type":"string","description":"The ID of the scheme."}}}}},"description":"Scheme GUID","required":true},"responses":{"200":{"description":"Update channel scheme successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/channels\/{channel_id}\/moderations":{"get":{"tags":["channels"],"summary":"Get information about channel's moderation.","description":"##### Permissions\nMust have `manage_system` permission.\n\n","operationId":"GetChannelModerations","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Retreived successfully","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_ChannelModeration"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/{channel_id}\/moderations\/patch":{"put":{"tags":["channels"],"summary":"Update a channel's moderation settings.","description":"##### Permissions\nMust have `manage_system` permission.\n\n","operationId":"PatchChannelModerations","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_ChannelModerationPatch"}}}},"parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Patched successfully","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_ChannelModeration"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/channels\/categories":{"get":{"tags":["channels"],"summary":"Get user's sidebar categories","description":"Get a list of sidebar categories that will appear in the user's sidebar on the given team, including a list of channel IDs in each category.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"GetSidebarCategoriesForTeamForUser","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Category retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_OrderedSidebarCategories"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"post":{"tags":["channels"],"summary":"Create user's sidebar category","description":"Create a custom sidebar category for the user on the given team.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"CreateSidebarCategoryForTeamForUser","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategory"}}},"required":true},"responses":{"200":{"description":"Category creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategory"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"put":{"tags":["channels"],"summary":"Update user's sidebar categories","description":"Update any number of sidebar categories for the user on the given team. This can be used to reorder the channels in these categories.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"UpdateSidebarCategoriesForTeamForUser","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategory"}}}},"required":true},"responses":{"200":{"description":"Category update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategory"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/channels\/categories\/order":{"get":{"tags":["channels"],"summary":"Get user's sidebar category order","description":"Returns the order of the sidebar categories for a user on the given team as an array of IDs.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"GetSidebarCategoryOrderForTeamForUser","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Order retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"put":{"tags":["channels"],"summary":"Update user's sidebar category order","description":"Updates the order of the sidebar categories for a user on the given team. The provided array must include the IDs of all categories on the team.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"UpdateSidebarCategoryOrderForTeamForUser","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Order update successful","content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/teams\/{team_id}\/channels\/categories\/{category_id}":{"get":{"tags":["channels"],"summary":"Get sidebar category","description":"Returns a single sidebar category for the user on the given team.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"GetSidebarCategoryForTeamForUser","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","description":"Category GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Category retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategory"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"put":{"tags":["channels"],"summary":"Update sidebar category","description":"Updates a single sidebar category for the user on the given team.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"UpdateSidebarCategoryForTeamForUser","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","description":"Category GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategoryWithChannels"}}},"required":true},"responses":{"200":{"description":"Category update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategoryWithChannels"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"delete":{"tags":["channels"],"summary":"Delete sidebar category","description":"Deletes a single sidebar category for the user on the given team. Only custom categories can be deleted.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","operationId":"RemoveSidebarCategoryForTeamForUser","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","description":"Category GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Category delete successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategory"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/posts":{"post":{"tags":["posts"],"summary":"Create a post","description":"Create a new post in a channel. To create the post as a comment on another post, provide `root_id`.\n##### Permissions\nMust have `create_post` permission for the channel the post is being created in.\n","operationId":"CreatePost","parameters":[{"name":"set_online","in":"query","description":"Whether to set the user status as online or not.","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["channel_id","message"],"properties":{"channel_id":{"type":"string","description":"The channel ID to post in","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"message":{"type":"string","description":"The message contents, can be formatted with Markdown"},"root_id":{"type":"string","description":"The post ID to comment on","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"file_ids":{"type":"array","description":"A list of file IDs to associate with the post. Note that posts are limited to 5 files maximum. Please use additional posts for more files.","items":{"type":"string"},"example":"['xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx']"},"props":{"description":"A general JSON property bag to attach to the post","type":"object"}}}}},"description":"Post object to create","required":true},"responses":{"201":{"description":"Post creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Post"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/ephemeral":{"post":{"tags":["posts"],"summary":"Create a ephemeral post","description":"Create a new ephemeral post in a channel.\n##### Permissions\nMust have `create_post_ephemeral` permission (currently only given to system admin)\n","operationId":"CreatePostEphemeral","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["user_id","post"],"properties":{"user_id":{"type":"string","description":"The target user id for the ephemeral post"},"post":{"type":"object","required":["channel_id","message"],"description":"Post object to create","properties":{"channel_id":{"type":"string","description":"The channel ID to post in","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"message":{"type":"string","description":"The message contents, can be formatted with Markdown"}}}}}}},"description":"Ephemeral Post object to send","required":true},"responses":{"201":{"description":"Post creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Post"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/{post_id}":{"get":{"tags":["posts"],"summary":"Get a post","description":"Get a single post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.\n","operationId":"GetPost","parameters":[{"name":"post_id","in":"path","description":"ID of the post to get","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Defines if result should include deleted posts, must have 'manage_system' (admin) permission.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Post retrieval successful","headers":{"Has-Inaccessible-Posts":{"schema":{"type":"boolean"},"description":"This header is included with the value \"true\" if the post is past the cloud's plan limit."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Post"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}},"delete":{"tags":["posts"],"summary":"Delete a post","description":"Soft deletes a post, by marking the post as deleted in the database. Soft deleted posts will not be returned in post queries.\n##### Permissions\nMust be logged in as the user or have `delete_others_posts` permission.\n","operationId":"DeletePost","parameters":[{"name":"post_id","in":"path","description":"ID of the post to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Post deletion successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/posts\/{post_id}\/set_unread":{"post":{"tags":["posts"],"summary":"Mark as unread from a post.","description":"Mark a channel as being unread from a given post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.\nMust have `edit_other_users` permission if the user is not the one marking the post for himself.\n\n","operationId":"SetPostUnread","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Post marked as unread successfully","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_ChannelUnreadAt"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/posts\/{post_id}\/patch":{"put":{"tags":["posts"],"summary":"Patch a post","description":"Partially update a post by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have the `edit_post` permission.\n","operationId":"PatchPost","parameters":[{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"is_pinned":{"description":"Set to `true` to pin the post to the channel it is in","type":"boolean"},"message":{"description":"The message text of the post","type":"string"},"file_ids":{"description":"The list of files attached to this post","type":"array","items":{"type":"string"}}}}}},"description":"Post object that is to be updated","required":true},"responses":{"200":{"description":"Post patch successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Post"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/{post_id}\/thread":{"get":{"tags":["posts"],"summary":"Get a thread","description":"Get a post and the rest of the posts in the same thread.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.\n","operationId":"GetPostThread","parameters":[{"name":"post_id","in":"path","description":"ID of a post in the thread","required":true,"schema":{"type":"string"}},{"name":"perPage","in":"query","description":"The number of posts per page","schema":{"type":"integer","default":0}},{"name":"fromPost","in":"query","description":"The post_id to return the next page of posts from","schema":{"type":"string","default":""}},{"name":"fromCreateAt","in":"query","description":"The create_at timestamp to return the next page of posts from","schema":{"type":"integer","default":0}},{"name":"direction","in":"query","description":"The direction to return the posts. Either up or down.","schema":{"type":"string","default":""}},{"name":"skipFetchThreads","in":"query","description":"Whether to skip fetching threads or not","schema":{"type":"boolean","default":false}},{"name":"collapsedThreads","in":"query","description":"Whether the client uses CRT or not","schema":{"type":"boolean","default":false}},{"name":"collapsedThreadsExtended","in":"query","description":"Whether to return the associated users as part of the response or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Post list retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_PostList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/posts\/flagged":{"get":{"tags":["posts"],"summary":"Get a list of flagged posts","description":"Get a page of flagged posts of a user provided user id string. Selects from a channel, team, or all flagged posts by a user. Will only return posts from channels in which the user is member.\n##### Permissions\nMust be user or have `manage_system` permission.\n","operationId":"GetFlaggedPostsForUser","parameters":[{"name":"user_id","in":"path","description":"ID of the user","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"query","description":"Team ID","schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of posts per page","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Post list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_PostList"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/{post_id}\/files\/info":{"get":{"tags":["posts"],"summary":"Get file info for post","description":"Gets a list of file information objects for the files attached to a post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.\n","operationId":"GetFileInfosForPost","parameters":[{"name":"post_id","in":"path","description":"ID of the post","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Defines if result should include deleted posts, must have 'manage_system' (admin) permission.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"File info retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_FileInfo"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/channels\/{channel_id}\/posts":{"get":{"tags":["posts"],"summary":"Get posts for a channel","description":"Get a page of posts in a channel. Use the query parameters to modify the behaviour of this endpoint. The parameter `since` must not be used with any of `before`, `after`, `page`, and `per_page` parameters.\nIf `since` is used, it will always return all posts modified since that time, ordered by their create time limited till 1000. A caveat with this parameter is that there is no guarantee that the returned posts will be consecutive. It is left to the clients to maintain state and fill any missing holes in the post order.\n##### Permissions\nMust have `read_channel` permission for the channel.\n","operationId":"GetPostsForChannel","parameters":[{"name":"channel_id","in":"path","description":"The channel ID to get the posts for","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of posts per page","schema":{"type":"integer","default":60}},{"name":"since","in":"query","description":"Provide a non-zero value in Unix time milliseconds to select posts modified after that time","schema":{"type":"integer"}},{"name":"before","in":"query","description":"A post id to select the posts that came before this one","schema":{"type":"string"}},{"name":"after","in":"query","description":"A post id to select the posts that came after this one","schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Whether to include deleted posts or not. Must have system admin permissions.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Post list retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_PostList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/channels\/{channel_id}\/posts\/unread":{"get":{"tags":["posts"],"summary":"Get posts around oldest unread","description":"Get the oldest unread post in the channel for the given user as well as the posts around it. The returned list is sorted in descending order (most recent post first).\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission, and must have `read_channel` permission for the channel.\n","operationId":"GetPostsAroundLastUnread","parameters":[{"name":"user_id","in":"path","description":"ID of the user","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"path","description":"The channel ID to get the posts for","required":true,"schema":{"type":"string"}},{"name":"limit_before","in":"query","description":"Number of posts before the oldest unread posts. Maximum is 200 posts if limit is set greater than that.","schema":{"type":"integer","default":60,"maximum":200,"minimum":0}},{"name":"limit_after","in":"query","description":"Number of posts after and including the oldest unread post. Maximum is 200 posts if limit is set greater than that.","schema":{"type":"integer","default":60,"maximum":200,"minimum":1}},{"name":"skipFetchThreads","in":"query","description":"Whether to skip fetching threads or not","schema":{"type":"boolean","default":false}},{"name":"collapsedThreads","in":"query","description":"Whether the client uses CRT or not","schema":{"type":"boolean","default":false}},{"name":"collapsedThreadsExtended","in":"query","description":"Whether to return the associated users as part of the response or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Post list retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_PostList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/teams\/{team_id}\/posts\/search":{"post":{"tags":["posts"],"summary":"Search for team posts","description":"Search posts in the team and from the provided terms string.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","operationId":"SearchPosts","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["terms","is_or_search"],"properties":{"terms":{"type":"string","description":"The search terms as inputed by the user. To search for posts from a user include `from:someusername`, using a user's username. To search in a specific channel include `in:somechannel`, using the channel name (not the display name)."},"is_or_search":{"type":"boolean","description":"Set to true if an Or search should be performed vs an And search."},"time_zone_offset":{"type":"integer","default":0,"description":"Offset from UTC of user timezone for date searches."},"include_deleted_channels":{"type":"boolean","description":"Set to true if deleted channels should be included in the search. (archived channels)"},"page":{"type":"integer","default":0,"description":"The page to select. (Only works with Elasticsearch)"},"per_page":{"type":"integer","default":60,"description":"The number of posts per page. (Only works with Elasticsearch)"}}}}},"description":"The search terms and logic to use in the search.","required":true},"responses":{"200":{"description":"Post list retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_PostListWithSearchMatches"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/{post_id}\/pin":{"post":{"tags":["posts"],"summary":"Pin a post to the channel","description":"Pin a post to a channel it is in based from the provided post id string.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.\n","operationId":"PinPost","parameters":[{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Pinned post successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/{post_id}\/unpin":{"post":{"tags":["posts"],"summary":"Unpin a post to the channel","description":"Unpin a post to a channel it is in based from the provided post id string.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.\n","operationId":"UnpinPost","parameters":[{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Unpinned post successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/{post_id}\/actions\/{action_id}":{"post":{"tags":["posts"],"summary":"Perform a post action","description":"Perform a post action, which allows users to interact with integrations through posts.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.\n","operationId":"DoPostAction","parameters":[{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}},{"name":"action_id","in":"path","description":"Action GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Post action successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/ids":{"post":{"tags":["posts"],"summary":"Get posts by a list of ids","description":"Fetch a list of posts based on the provided postIDs\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.\n","operationId":"getPostsByIds","requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of post ids","required":true},"responses":{"200":{"description":"Post list retrieval successful","headers":{"Has-Inaccessible-Posts":{"schema":{"type":"boolean"},"description":"Indicates whether the posts have been truncated as per the cloud's plan limit."}},"content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Post"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/posts\/{post_id}\/reminder":{"post":{"tags":["posts"],"summary":"Set a post reminder","description":"Set a reminder for the user for the post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.\n\n","operationId":"SetPostReminder","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["target_time"],"properties":{"target_time":{"type":"integer","description":"Target time for the reminder"}}}}},"description":"Target time for the reminder","required":true},"responses":{"200":{"description":"Reminder set successfully","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/preferences":{"get":{"tags":["preferences"],"summary":"Get the user's preferences","description":"Get a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","operationId":"GetPreferences","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User preferences retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Preference"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}},"put":{"tags":["preferences"],"summary":"Save the user's preferences","description":"Save a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","operationId":"UpdatePreferences","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"List of preference objects","required":true,"content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Preference"}}}}},"responses":{"200":{"description":"User preferences saved successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/users\/{user_id}\/preferences\/delete":{"post":{"tags":["preferences"],"summary":"Delete user's preferences","description":"Delete a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","operationId":"DeletePreferences","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"List of preference objects","required":true,"content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Preference"}}}}},"responses":{"200":{"description":"User preferences saved successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/preferences\/{category}":{"get":{"tags":["preferences"],"summary":"List a user's preferences by category","description":"Lists the current user's stored preferences in the given category.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","operationId":"GetPreferencesByCategory","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"category","in":"path","description":"The category of a group of preferences","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of all of the current user's preferences in the given category","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Preference"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/preferences\/{category}\/name\/{preference_name}":{"get":{"tags":["preferences"],"summary":"Get a specific user preference","description":"Gets a single preference for the current user with the given category and name.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","operationId":"GetPreferencesByCategoryByName","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"category","in":"path","description":"The category of a group of preferences","required":true,"schema":{"type":"string"}},{"name":"preference_name","in":"path","description":"The name of the preference","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A single preference for the current user in the current categorylist of all of the current user's preferences in the given category.\n","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Preference"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"}}}},"\/api\/v4\/files":{"post":{"tags":["files"],"summary":"Upload a file","description":"Uploads a file that can later be attached to a post.\n\nThis request can either be a multipart\/form-data request with a channel_id, files and optional\nclient_ids defined in the FormData, or it can be a request with the channel_id and filename\ndefined as query parameters with the contents of a single file in the body of the request.","operationId":"UploadFile","requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","required":["files"],"properties":{"files":{"type":"string","format":"binary","description":"The file to upload"}}}}}},"parameters":[{"name":"channel_id","in":"query","description":"The ID of the channel that this file will be uploaded to","required":false,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"The name of the file to be uploaded","required":false,"schema":{"type":"string"}}],"content":"application\/octet-stream","responses":{"201":{"description":"Corresponding lists of the provided client_ids and the metadata that has been stored in the database for each one","content":{"application\/json":{"schema":{"type":"object","properties":{"file_infos":{"description":"A list of file metadata that has been stored in the database","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_FileInfo"}},"client_ids":{"description":"A list of the client_ids that were provided in the request","type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"413":{"$ref":"#\/components\/responses\/TooLarge"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/files\/{file_id}":{"get":{"tags":["files"],"summary":"Get a file","description":"Gets a file that has been uploaded previously.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","operationId":"GetFile","parameters":[{"name":"file_id","in":"path","description":"The ID of the file to get","required":true,"schema":{"type":"string"}}],"responses":{"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"description":"Do not have appropriate permissions","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_AppError"}}},"headers":{"First-Inaccessible-File-Time":{"schema":{"type":"integer"},"description":"This header is included with the value \"1\" if the file is past the cloud's plan limit."}}},"404":{"$ref":"#\/components\/responses\/NotFound"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/files\/{file_id}\/thumbnail":{"get":{"tags":["files"],"summary":"Get a file's thumbnail","description":"Gets a file's thumbnail.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","operationId":"GetFileThumbnail","parameters":[{"name":"file_id","in":"path","description":"The ID of the file to get","required":true,"schema":{"type":"string"}}],"responses":{"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"description":"Do not have appropriate permissions","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_AppError"}}},"headers":{"First-Inaccessible-File-Time":{"schema":{"type":"integer"},"description":"This header is included with the value \"1\" if the file is past the cloud's plan limit."}}},"404":{"$ref":"#\/components\/responses\/NotFound"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/files\/{file_id}\/preview":{"get":{"tags":["files"],"summary":"Get a file's preview","description":"Gets a file's preview.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","operationId":"GetFilePreview","parameters":[{"name":"file_id","in":"path","description":"The ID of the file to get","required":true,"schema":{"type":"string"}}],"responses":{"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"description":"Do not have appropriate permissions","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_AppError"}}},"headers":{"First-Inaccessible-File-Time":{"schema":{"type":"integer"},"description":"This header is included with the value \"1\" if the file is past the cloud's plan limit."}}},"404":{"$ref":"#\/components\/responses\/NotFound"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/files\/{file_id}\/info":{"get":{"tags":["files"],"summary":"Get metadata for a file","description":"Gets a file's info.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","operationId":"GetFileInfo","parameters":[{"name":"file_id","in":"path","description":"The ID of the file info to get","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The stored metadata for the given file","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_FileInfo"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"description":"Do not have appropriate permissions","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_AppError"}}},"headers":{"First-Inaccessible-File-Time":{"schema":{"type":"integer"},"description":"This header is included with the value \"1\" if the file is past the cloud's plan limit."}}},"404":{"$ref":"#\/components\/responses\/NotFound"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/teams\/{team_id}\/files\/search":{"post":{"tags":["teams","files","search"],"summary":"Search files in a team","description":"Search for files in a team based on file name, extention and file content (if file content extraction is enabled and supported for the files).\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","operationId":"SearchFiles","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["terms","is_or_search"],"properties":{"terms":{"type":"string","description":"The search terms as inputed by the user. To search for files from a user include `from:someusername`, using a user's username. To search in a specific channel include `in:somechannel`, using the channel name (not the display name). To search for specific extensions included `ext:extension`."},"is_or_search":{"type":"boolean","description":"Set to true if an Or search should be performed vs an And search."},"time_zone_offset":{"type":"integer","default":0,"description":"Offset from UTC of user timezone for date searches."},"include_deleted_channels":{"type":"boolean","description":"Set to true if deleted channels should be included in the search. (archived channels)"},"page":{"type":"integer","default":0,"description":"The page to select. (Only works with Elasticsearch)"},"per_page":{"type":"integer","default":60,"description":"The number of posts per page. (Only works with Elasticsearch)"}}}}},"description":"The search terms and logic to use in the search.","required":true},"responses":{"200":{"description":"Files list retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_FileInfoList"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/config\/client":{"get":{"tags":["system"],"summary":"Get client configuration","description":"Get a subset of the server configuration needed by the client.\n##### Permissions\nNo permission required.\n","operationId":"GetClientConfig","parameters":[{"name":"format","in":"query","required":true,"description":"Must be `old`, other formats not implemented yet","schema":{"type":"string"}}],"responses":{"200":{"description":"Configuration retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/emoji":{"post":{"tags":["emoji"],"summary":"Create a custom emoji","description":"Create a custom emoji for the team.\n##### Permissions\nMust be authenticated.\n","operationId":"CreateEmoji","requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"image":{"description":"A file to be uploaded","type":"string","format":"binary"},"emoji":{"description":"A JSON object containing a `name` field with the name of the emoji and a `creator_id` field with the id of the authenticated user.","type":"string"}},"required":["image","emoji"]}}}},"responses":{"201":{"description":"Emoji creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Emoji"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"413":{"$ref":"#\/components\/responses\/TooLarge"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}},"get":{"tags":["emoji"],"summary":"Get a list of custom emoji","description":"Get a page of metadata for custom emoji on the system.##### Permissions\nMust be authenticated.\n","operationId":"GetEmojiList","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of emojis per page.","schema":{"type":"integer","default":60}},{"name":"sort","in":"query","description":"Either blank for no sorting or \"name\" to sort by emoji names.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Emoji list retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Emoji"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/emoji\/{emoji_id}":{"get":{"tags":["emoji"],"summary":"Get a custom emoji","description":"Get some metadata for a custom emoji.\n##### Permissions\nMust be authenticated.\n","operationId":"GetEmoji","parameters":[{"name":"emoji_id","in":"path","description":"Emoji GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Emoji"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}},"delete":{"tags":["emoji"],"summary":"Delete a custom emoji","description":"Delete a custom emoji.\n##### Permissions\nMust have the `manage_team` or `manage_system` permissions or be the user who created the emoji.\n","operationId":"DeleteEmoji","parameters":[{"name":"emoji_id","in":"path","description":"Emoji GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji delete successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Emoji"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/emoji\/name\/{emoji_name}":{"get":{"tags":["emoji"],"summary":"Get a custom emoji by name","description":"Get some metadata for a custom emoji using its name.\n##### Permissions\nMust be authenticated.\n\n","operationId":"GetEmojiByName","parameters":[{"name":"emoji_name","in":"path","description":"Emoji name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Emoji"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/emoji\/{emoji_id}\/image":{"get":{"tags":["emoji"],"summary":"Get custom emoji image","description":"Get the image for a custom emoji.\n##### Permissions\nMust be authenticated.\n","operationId":"GetEmojiImage","parameters":[{"name":"emoji_id","in":"path","description":"Emoji GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji image retrieval successful","content":{"image\/png":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"500":{"$ref":"#\/components\/responses\/InternalServerError"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/emoji\/search":{"post":{"tags":["emoji"],"summary":"Search custom emoji","description":"Search for custom emoji by name based on search criteria provided in the request body. A maximum of 200 results are returned.\n##### Permissions\nMust be authenticated.\n\n","operationId":"SearchEmoji","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The term to match against the emoji name.","type":"string"},"prefix_only":{"description":"Set to only search for names starting with the search term.","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"200":{"description":"Emoji list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Emoji"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/emoji\/autocomplete":{"get":{"tags":["emoji"],"summary":"Autocomplete custom emoji","description":"Get a list of custom emoji with names starting with or matching the provided name. Returns a maximum of 100 results.\n##### Permissions\nMust be authenticated.\n\n","operationId":"AutocompleteEmoji","parameters":[{"name":"name","in":"query","description":"The emoji name to search.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji list retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Emoji"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/hooks\/incoming":{"post":{"tags":["webhooks"],"summary":"Create an incoming webhook","description":"Create an incoming webhook for a channel.\n##### Permissions\n`manage_webhooks` for the team the webhook is in.\n\n`manage_others_incoming_webhooks` for the team the webhook is in if the user is different than the requester.\n","operationId":"CreateIncomingWebhook","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["channel_id"],"properties":{"channel_id":{"type":"string","description":"The ID of a public channel or private group that receives the webhook payloads."},"user_id":{"type":"string","description":"The ID of the owner of the webhook if different than the requester."},"display_name":{"type":"string","description":"The display name for this incoming webhook"},"description":{"type":"string","description":"The description for this incoming webhook"},"username":{"type":"string","description":"The username this incoming webhook will post as."},"icon_url":{"type":"string","description":"The profile picture this incoming webhook will use when posting."}}}}},"description":"Incoming webhook to be created","required":true},"responses":{"201":{"description":"Incoming webhook creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_IncomingWebhook"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}},"get":{"tags":["webhooks"],"summary":"List incoming webhooks","description":"Get a page of a list of incoming webhooks. Optionally filter for a specific team using query parameters.\n##### Permissions\n`manage_webhooks` for the system or `manage_webhooks` for the specific team.\n","operationId":"GetIncomingWebhooks","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of hooks per page.","schema":{"type":"integer","default":60}},{"name":"team_id","in":"query","description":"The ID of the team to get hooks for.","schema":{"type":"string"}}],"responses":{"200":{"description":"Incoming webhooks retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_IncomingWebhook"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/hooks\/incoming\/{hook_id}":{"get":{"tags":["webhooks"],"summary":"Get an incoming webhook","description":"Get an incoming webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","operationId":"GetIncomingWebhook","parameters":[{"name":"hook_id","in":"path","description":"Incoming Webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_IncomingWebhook"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"delete":{"tags":["webhooks"],"summary":"Delete an incoming webhook","description":"Delete an incoming webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","operationId":"DeleteIncomingWebhook","parameters":[{"name":"hook_id","in":"path","description":"Incoming webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook deletion successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"put":{"tags":["webhooks"],"summary":"Update an incoming webhook","description":"Update an incoming webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","operationId":"UpdateIncomingWebhook","parameters":[{"name":"hook_id","in":"path","description":"Incoming Webhook GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["id","channel_id","display_name","description"],"properties":{"id":{"type":"string","description":"Incoming webhook GUID"},"channel_id":{"type":"string","description":"The ID of a public channel or private group that receives the webhook payloads."},"display_name":{"type":"string","description":"The display name for this incoming webhook"},"description":{"type":"string","description":"The description for this incoming webhook"},"username":{"type":"string","description":"The username this incoming webhook will post as."},"icon_url":{"type":"string","description":"The profile picture this incoming webhook will use when posting."}}}}},"description":"Incoming webhook to be updated","required":true},"responses":{"200":{"description":"Webhook update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_IncomingWebhook"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/hooks\/outgoing":{"post":{"tags":["webhooks"],"summary":"Create an outgoing webhook","description":"Create an outgoing webhook for a team.\n##### Permissions\n`manage_webhooks` for the team the webhook is in.\n\n`manage_others_outgoing_webhooks` for the team the webhook is in if the user is different than the requester.\n","operationId":"CreateOutgoingWebhook","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["team_id","display_name","trigger_words","callback_urls"],"properties":{"team_id":{"description":"The ID of the team that the webhook watchs","type":"string"},"channel_id":{"description":"The ID of a public channel that the webhook watchs","type":"string"},"creator_id":{"description":"The ID of the owner of the webhook if different than the requester.","type":"string"},"description":{"description":"The description for this outgoing webhook","type":"string"},"display_name":{"description":"The display name for this outgoing webhook","type":"string"},"trigger_words":{"description":"List of words for the webhook to trigger on","type":"array","items":{"type":"string"}},"trigger_when":{"description":"When to trigger the webhook, `0` when a trigger word is present at all and `1` if the message starts with a trigger word","type":"integer"},"callback_urls":{"description":"The URLs to POST the payloads to when the webhook is triggered","type":"array","items":{"type":"string"}},"content_type":{"description":"The format to POST the data in, either `application\/json` or `application\/x-www-form-urlencoded`","default":"application\/x-www-form-urlencoded","type":"string"}}}}},"description":"Outgoing webhook to be created","required":true},"responses":{"201":{"description":"Outgoing webhook creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_OutgoingWebhook"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"get":{"tags":["webhooks"],"summary":"List outgoing webhooks","description":"Get a page of a list of outgoing webhooks. Optionally filter for a specific team or channel using query parameters.\n##### Permissions\n`manage_webhooks` for the system or `manage_webhooks` for the specific team\/channel.\n","operationId":"GetOutgoingWebhooks","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of hooks per page.","schema":{"type":"integer","default":60}},{"name":"team_id","in":"query","description":"The ID of the team to get hooks for.","schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"The ID of the channel to get hooks for.","schema":{"type":"string"}}],"responses":{"200":{"description":"Outgoing webhooks retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_OutgoingWebhook"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/hooks\/outgoing\/{hook_id}":{"get":{"tags":["webhooks"],"summary":"Get an outgoing webhook","description":"Get an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","operationId":"GetOutgoingWebhook","parameters":[{"name":"hook_id","in":"path","description":"Outgoing webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Outgoing webhook retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_OutgoingWebhook"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"delete":{"tags":["webhooks"],"summary":"Delete an outgoing webhook","description":"Delete an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","operationId":"DeleteOutgoingWebhook","parameters":[{"name":"hook_id","in":"path","description":"Outgoing webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook deletion successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"put":{"tags":["webhooks"],"summary":"Update an outgoing webhook","description":"Update an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","operationId":"UpdateOutgoingWebhook","parameters":[{"name":"hook_id","in":"path","description":"outgoing Webhook GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["id","channel_id","display_name","description"],"properties":{"id":{"type":"string","description":"Outgoing webhook GUID"},"channel_id":{"type":"string","description":"The ID of a public channel or private group that receives the webhook payloads."},"display_name":{"type":"string","description":"The display name for this incoming webhook"},"description":{"type":"string","description":"The description for this incoming webhook"}}}}},"description":"Outgoing webhook to be updated","required":true},"responses":{"200":{"description":"Webhook update successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_OutgoingWebhook"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/hooks\/outgoing\/{hook_id}\/regen_token":{"post":{"tags":["webhooks"],"summary":"Regenerate the token for the outgoing webhook.","description":"Regenerate the token for the outgoing webhook.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","operationId":"RegenOutgoingHookToken","parameters":[{"name":"hook_id","in":"path","description":"Outgoing webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook token regenerate successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/groups":{"get":{"tags":["groups"],"summary":"Get groups","description":"Retrieve a list of all groups not associated to a particular channel or team.\n\n`not_associated_to_team` **OR** `not_associated_to_channel` is required.\n\nIf you use `not_associated_to_team`, you must be a team admin for that particular team (permission to manage that team).\n\nIf you use `not_associated_to_channel`, you must be a channel admin for that particular channel (permission to manage that channel).\n\nn","operationId":"GetGroups","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of groups per page.","schema":{"type":"integer","default":60}},{"name":"q","in":"query","description":"String to pattern match the `name` and `display_name` field. Will return all groups whose `name` and `display_name` field match any of the text.","schema":{"type":"string"}},{"name":"include_member_count","in":"query","description":"Boolean which adds the `member_count` attribute to each group JSON object","schema":{"type":"boolean"}},{"name":"not_associated_to_team","in":"query","description":"Team GUID which is used to return all the groups not associated to this team","required":true,"schema":{"type":"string"}},{"name":"not_associated_to_channel","in":"query","description":"Group GUID which is used to return all the groups not associated to this channel","required":true,"schema":{"type":"string"}},{"name":"since","in":"query","description":"Only return groups that have been modified since the given Unix timestamp (in milliseconds). All modified groups, including deleted and created groups, will be returned.\nn","schema":{"type":"integer"}},{"name":"filter_allow_reference","in":"query","description":"Boolean which filters the group entries with the `allow_reference` attribute set.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Group list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Group"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/channels\/{channel_id}\/groups":{"get":{"tags":["groups"],"summary":"Get channel groups","description":"Retrieve the list of groups associated with a given channel.\n\n##### Permissions\nMust have `manage_system` permission.\n\n","operationId":"GetGroupsByChannel","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of groups per page.","schema":{"type":"integer","default":60}},{"name":"filter_allow_reference","in":"query","description":"Boolean which filters the group entries with the `allow_reference` attribute set.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Group list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Group"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"500":{"$ref":"#\/components\/responses\/InternalServerError"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/teams\/{team_id}\/groups":{"get":{"tags":["groups"],"summary":"Get team groups","description":"Retrieve the list of groups associated with a given team.\n\n","operationId":"GetGroupsByTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of groups per page.","schema":{"type":"integer","default":60}},{"name":"filter_allow_reference","in":"query","description":"Boolean which filters in the group entries with the `allow_reference` attribute set.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Group list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Group"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"500":{"$ref":"#\/components\/responses\/InternalServerError"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/teams\/{team_id}\/groups_by_channels":{"get":{"tags":["groups"],"summary":"Get team groups by channels","description":"Retrieve the set of groups associated with the channels in the given team grouped by channel.\n\n##### Permissions\nMust have `manage_system` permission or can access only for current user\n\n","operationId":"GetGroupsAssociatedToChannelsByTeam","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of groups per page.","schema":{"type":"integer","default":60}},{"name":"filter_allow_reference","in":"query","description":"Boolean which filters in the group entries with the `allow_reference` attribute set.","schema":{"type":"boolean","default":false}},{"name":"paginate","in":"query","description":"Boolean to determine whether the pagination should be applied or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Group list retrieval successful","content":{"application\/json":{"schema":{"type":"object","items":{"$ref":"#\/components\/schemas\/38cb7293_GroupsAssociatedToChannels"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"500":{"$ref":"#\/components\/responses\/InternalServerError"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/users\/{user_id}\/groups":{"get":{"tags":["groups"],"summary":"Get groups for a userId","description":"Retrieve the list of groups associated to the user\n\n","operationId":"GetGroupsByUserId","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Group list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Group"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/commands":{"post":{"tags":["commands"],"summary":"Create a command","description":"Create a command for a team.\n##### Permissions\n`manage_slash_commands` for the team the command is in.\n","operationId":"CreateCommand","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["team_id","method","trigger","url"],"properties":{"team_id":{"type":"string","description":"Team ID to where the command should be created"},"method":{"type":"string","description":"`'P'` for post request, `'G'` for get request"},"trigger":{"type":"string","description":"Activation word to trigger the command"},"url":{"type":"string","description":"The URL that the command will make the request"}}}}},"description":"command to be created","required":true},"responses":{"201":{"description":"Command creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Command"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}},"get":{"tags":["commands"],"summary":"List commands for a team","description":"List commands for a team.\n##### Permissions\n`manage_slash_commands` if need list custom commands.\n","operationId":"ListCommands","parameters":[{"name":"team_id","in":"query","description":"The team id.","schema":{"type":"string"}},{"name":"custom_only","in":"query","description":"To get only the custom commands. If set to false will get the custom\nif the user have access plus the system commands, otherwise just the system commands.\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List Commands retrieve successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Command"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/teams\/{team_id}\/commands\/autocomplete":{"get":{"tags":["commands"],"summary":"List autocomplete commands","description":"List autocomplete commands in the team.\n##### Permissions\n`view_team` for the team.\n","operationId":"ListAutocompleteCommands","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Autocomplete commands retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Command"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/teams\/{team_id}\/commands\/autocomplete_suggestions":{"get":{"tags":["commands"],"summary":"List commands' autocomplete data","description":"List commands' autocomplete data for the team.\n##### Permissions\n`view_team` for the team.\n","operationId":"ListCommandAutocompleteSuggestions","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_input","in":"query","description":"String inputted by the user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Commands' autocomplete data retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_AutocompleteSuggestion"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/commands\/{command_id}":{"get":{"tags":["commands"],"summary":"Get a command","description":"Get a command definition based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.\n\n","operationId":"GetCommandById","parameters":[{"in":"path","name":"command_id","description":"ID of the command to get","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Command get successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Command"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}},"put":{"tags":["commands"],"summary":"Update a command","description":"Update a single command based on command id string and Command struct.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"command_id","description":"ID of the command to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Command"}}},"required":true},"responses":{"200":{"description":"Command updated successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Command"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}},"delete":{"tags":["commands"],"summary":"Delete a command","description":"Delete a command based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"command_id","description":"ID of the command to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Command deletion successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/commands\/{command_id}\/regen_token":{"put":{"tags":["commands"],"summary":"Generate a new token","description":"Generate a new token for the command based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.\n","operationId":"RegenCommandToken","parameters":[{"in":"path","name":"command_id","description":"ID of the command to generate the new token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token generation successful","content":{"application\/json":{"schema":{"type":"object","properties":{"token":{"description":"The new token","type":"string"}}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/commands\/execute":{"post":{"tags":["commands"],"summary":"Execute a command","description":"Execute a command on a team.\n##### Permissions\nMust have `use_slash_commands` permission for the team the command is in.\n","operationId":"ExecuteCommand","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["channel_id","command"],"properties":{"channel_id":{"type":"string","description":"Channel Id where the command will execute"},"command":{"type":"string","description":"The slash command to execute, including parameters. Eg, `'\/echo bounces around the room'`"}}}}},"description":"command to be executed","required":true},"responses":{"200":{"description":"Command execution successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_CommandResponse"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"501":{"$ref":"#\/components\/responses\/NotImplemented"}}}},"\/api\/v4\/roles":{"get":{"tags":["roles"],"summary":"Get a list of all the roles","description":"##### Permissions\n\n`manage_system` permission is required.\n\n","operationId":"GetAllRoles","responses":{"200":{"description":"Roles retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Role"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/roles\/{role_id}":{"get":{"tags":["roles"],"summary":"Get a role","description":"Get a role from the provided role id.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n","operationId":"GetRole","parameters":[{"name":"role_id","in":"path","description":"Role GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Role retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Role"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/roles\/name\/{role_name}":{"get":{"tags":["roles"],"summary":"Get a role by name","description":"Get a role from the provided role name.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n","operationId":"GetRoleByName","parameters":[{"name":"role_name","in":"path","description":"Role Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Role retrieval successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Role"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/roles\/names":{"post":{"tags":["roles"],"summary":"Get a list of roles by name","description":"Get a list of roles from their names.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n","operationId":"GetRolesByNames","requestBody":{"content":{"application\/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of role names","required":true},"responses":{"200":{"description":"Role list retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Role"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"}}}},"\/api\/v4\/reactions":{"post":{"tags":["reactions"],"summary":"Create a reaction","description":"Create a reaction.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.\n","operationId":"SaveReaction","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Reaction"}}},"description":"The user's reaction with its post_id, user_id, and emoji_name fields set","required":true},"responses":{"201":{"description":"Reaction creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Reaction"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/posts\/{post_id}\/reactions":{"get":{"tags":["reactions"],"summary":"Get a list of reactions to a post","description":"Get a list of reactions made by all users to a given post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.\n","operationId":"GetReactions","parameters":[{"name":"post_id","in":"path","description":"ID of a post","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List reactions retrieve successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Reaction"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/users\/{user_id}\/posts\/{post_id}\/reactions\/{emoji_name}":{"delete":{"tags":["reactions"],"summary":"Remove a reaction from a post","description":"Deletes a reaction made by a user from the given post.\n##### Permissions\nMust be user or have `manage_system` permission.\n","operationId":"DeleteReaction","parameters":[{"name":"user_id","in":"path","description":"ID of the user","required":true,"schema":{"type":"string"}},{"name":"post_id","in":"path","description":"ID of the post","required":true,"schema":{"type":"string"}},{"name":"emoji_name","in":"path","description":"emoji name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Reaction deletion successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_StatusOK"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/bots":{"post":{"tags":["bots"],"summary":"Create a bot","description":"Create a new bot account on the system. Username is required.\n##### Permissions\nMust have `create_bot` permission.\n","operationId":"CreateBot","requestBody":{"description":"Bot to be created","required":true,"content":{"application\/json":{"schema":{"type":"object","required":["username"],"properties":{"username":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"Bot creation successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Bot"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}},"get":{"tags":["bots"],"summary":"Get bots","description":"Get a page of a list of bots.\n##### Permissions\nMust have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing.\n","operationId":"GetBots","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page. There is a maximum limit of 200 users per page.","schema":{"type":"integer","default":60}},{"name":"include_deleted","in":"query","description":"If deleted bots should be returned.","schema":{"type":"boolean"}},{"name":"only_orphaned","in":"query","description":"When true, only orphaned bots will be returned. A bot is consitered orphaned if it's owner has been deactivated.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Bot page retrieval successful","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_Bot"}}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/bots\/{bot_user_id}":{"put":{"tags":["bots"],"summary":"Patch a bot","description":"Partially update a bot by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have `manage_bots` permission. \n","operationId":"PatchBot","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Bot to be created","required":true,"content":{"application\/json":{"schema":{"type":"object","required":["username"],"properties":{"username":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"200":{"description":"Bot patch successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Bot"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}},"get":{"tags":["bots"],"summary":"Get a bot","description":"Get a bot specified by its bot id.\n##### Permissions\nMust have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing.\n","operationId":"GetBot","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"If deleted bots should be returned.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Bot successfully retrieved.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Bot"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/bots\/{bot_user_id}\/disable":{"post":{"tags":["bots"],"summary":"Disable a bot","description":"Disable a bot.\n##### Permissions\nMust have `manage_bots` permission. \n","operationId":"DisableBot","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Bot successfully disabled.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Bot"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}},"\/api\/v4\/bots\/{bot_user_id}\/enable":{"post":{"tags":["bots"],"summary":"Enable a bot","description":"Enable a bot.\n##### Permissions\nMust have `manage_bots` permission. \n","operationId":"EnableBot","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Bot successfully enabled.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/38cb7293_Bot"}}}},"400":{"$ref":"#\/components\/responses\/BadRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"}}}}},"components":{"schemas":{"38cb7293_TopReactionList":{"type":"object","properties":{"has_next":{"description":"Indicates if there is another page of reactions that can be fetched.","type":"boolean"},"items":{"description":"List of reactions.","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_TopReaction"}}}},"38cb7293_TopChannelList":{"type":"object","properties":{"has_next":{"description":"Indicates if there is another page of channels that can be fetched.","type":"boolean"},"items":{"description":"List of channels.","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_TopChannel"}}}},"38cb7293_NewTeamMembersList":{"type":"object","properties":{"has_next":{"description":"Indicates if there is another page of new team members that can be fetched.","type":"boolean"},"items":{"description":"List of new team members.","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_NewTeamMember"}},"total_count":{"description":"The total count of new team members for the given time range.","type":"integer"}}},"38cb7293_TopThreadList":{"type":"object","properties":{"has_next":{"description":"Indicates if there is another page of top threads that can be fetched.","type":"boolean"},"items":{"description":"List of top threads.","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_TopThread"}}}},"38cb7293_TopDMList":{"type":"object","properties":{"has_next":{"description":"Indicates if there is another page of top DMs that can be fetched.","type":"boolean"},"items":{"description":"List of top DMs.","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_TopDM"}}}},"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_UserAutocomplete":{"type":"object","properties":{"users":{"description":"A list of users that are the main result of the query","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_User"}},"out_of_channel":{"description":"A special case list of users returned when autocompleting in a specific channel. Omitted when empty or not relevant","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_User"}}}},"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_StatusOK":{"type":"object","properties":{"status":{"description":"Will contain \"ok\" if the request was successful and there was nothing else to return","type":"string"}}},"38cb7293_ChannelMemberWithTeamData":{"allOf":[{"$ref":"#\/components\/schemas\/38cb7293_ChannelMember"},{"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."}}}]},"38cb7293_UserThreads":{"type":"object","properties":{"total":{"description":"Total number of threads (used for paging)","type":"integer"},"threads":{"description":"Array of threads","type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_UserThread"}}}},"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"}}},"38cb7293_Status":{"type":"object","properties":{"user_id":{"type":"string"},"status":{"type":"string"},"manual":{"type":"boolean"},"last_activity_at":{"type":"integer","format":"int64"}}},"38cb7293_Team":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a team was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a team was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a team was deleted","type":"integer","format":"int64"},"display_name":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"email":{"type":"string"},"type":{"type":"string"},"allowed_domains":{"type":"string"},"invite_id":{"type":"string"},"allow_open_invite":{"type":"boolean"},"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_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_TeamStats":{"type":"object","properties":{"team_id":{"type":"string"},"total_member_count":{"type":"integer"},"active_member_count":{"type":"integer"}}},"38cb7293_TeamUnread":{"type":"object","properties":{"team_id":{"type":"string"},"msg_count":{"type":"integer"},"mention_count":{"type":"integer"}}},"38cb7293_ChannelListWithTeamData":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_ChannelWithTeamData"}},"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_ChannelStats":{"type":"object","properties":{"channel_id":{"type":"string"},"member_count":{"type":"integer"}}},"38cb7293_PostList":{"type":"object","properties":{"order":{"type":"array","items":{"type":"string"}},"posts":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/38cb7293_Post"}},"next_post_id":{"type":"string","description":"The ID of next post. Not omitted when empty or not relevant."},"prev_post_id":{"type":"string","description":"The ID of previous post. Not omitted when empty or not relevant."},"has_next":{"type":"boolean","description":"Whether there are more items after this page."}}},"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_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_ChannelUnread":{"type":"object","properties":{"team_id":{"type":"string"},"channel_id":{"type":"string"},"msg_count":{"type":"integer"},"mention_count":{"type":"integer"}}},"38cb7293_ChannelModeration":{"type":"object","properties":{"name":{"type":"string"},"roles":{"$ref":"#\/components\/schemas\/38cb7293_ChannelModeratedRoles"}}},"38cb7293_ChannelModerationPatch":{"type":"object","properties":{"name":{"type":"string"},"roles":{"$ref":"#\/components\/schemas\/38cb7293_ChannelModeratedRolesPatch"}}},"38cb7293_OrderedSidebarCategories":{"description":"List of user's categories with their channels","type":"object","properties":{"order":{"type":"array","items":{"type":"string"}},"categories":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_SidebarCategoryWithChannels"}}}},"38cb7293_SidebarCategory":{"description":"User's sidebar category","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"]}}},"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_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_ChannelUnreadAt":{"type":"object","properties":{"team_id":{"description":"The ID of the team the channel belongs to.","type":"string"},"channel_id":{"description":"The ID of the channel the user has access to..","type":"string"},"msg_count":{"description":"No. of messages the user has already read.","type":"integer"},"mention_count":{"description":"No. of mentions the user has within the unread posts of the channel.","type":"integer"},"last_viewed_at":{"description":"time in milliseconds when the user last viewed the channel.","type":"integer"}}},"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_PostListWithSearchMatches":{"type":"object","properties":{"order":{"type":"array","items":{"type":"string"}},"posts":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/38cb7293_Post"}},"matches":{"description":"A mapping of post IDs to a list of matched terms within the post.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"38cb7293_Preference":{"type":"object","properties":{"user_id":{"description":"The ID of the user that owns this preference","type":"string"},"category":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}},"38cb7293_AppError":{"type":"object","properties":{"status_code":{"type":"integer"},"id":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"}}},"38cb7293_FileInfoList":{"type":"object","properties":{"order":{"type":"array","items":{"type":"string"}},"file_infos":{"type":"object","additionalProperties":{"$ref":"#\/components\/schemas\/38cb7293_FileInfo"}},"next_file_id":{"type":"string","description":"The ID of next file info. Not omitted when empty or not relevant."},"prev_file_id":{"type":"string","description":"The ID of previous file info. Not omitted when empty or not relevant."}}},"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_IncomingWebhook":{"type":"object","properties":{"id":{"description":"The unique identifier for this incoming webhook","type":"string"},"create_at":{"description":"The time in milliseconds a incoming webhook was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a incoming webhook was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a incoming webhook was deleted","type":"integer","format":"int64"},"channel_id":{"description":"The ID of a public channel or private group that receives the webhook payloads","type":"string"},"description":{"description":"The description for this incoming webhook","type":"string"},"display_name":{"description":"The display name for this incoming webhook","type":"string"}}},"38cb7293_OutgoingWebhook":{"type":"object","properties":{"id":{"description":"The unique identifier for this outgoing webhook","type":"string"},"create_at":{"description":"The time in milliseconds a outgoing webhook was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a outgoing webhook was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a outgoing webhook was deleted","type":"integer","format":"int64"},"creator_id":{"description":"The Id of the user who created the webhook","type":"string"},"team_id":{"description":"The ID of the team that the webhook watchs","type":"string"},"channel_id":{"description":"The ID of a public channel that the webhook watchs","type":"string"},"description":{"description":"The description for this outgoing webhook","type":"string"},"display_name":{"description":"The display name for this outgoing webhook","type":"string"},"trigger_words":{"description":"List of words for the webhook to trigger on","type":"array","items":{"type":"string"}},"trigger_when":{"description":"When to trigger the webhook, `0` when a trigger word is present at all and `1` if the message starts with a trigger word","type":"integer"},"callback_urls":{"description":"The URLs to POST the payloads to when the webhook is triggered","type":"array","items":{"type":"string"}},"content_type":{"description":"The format to POST the data in, either `application\/json` or `application\/x-www-form-urlencoded`","default":"application\/x-www-form-urlencoded","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_GroupsAssociatedToChannels":{"description":"a map of channel id(s) to the set of groups that constrain the corresponding channel in a team","type":"object","additionalProperties":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_GroupWithSchemeAdmin"}}},"38cb7293_Command":{"type":"object","properties":{"id":{"description":"The ID of the slash command","type":"string"},"token":{"description":"The token which is used to verify the source of the payload","type":"string"},"create_at":{"description":"The time in milliseconds the command was created","type":"integer"},"update_at":{"description":"The time in milliseconds the command was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds the command was deleted, 0 if never deleted","type":"integer","format":"int64"},"creator_id":{"description":"The user id for the commands creator","type":"string"},"team_id":{"description":"The team id for which this command is configured","type":"string"},"trigger":{"description":"The string that triggers this command","type":"string"},"method":{"description":"Is the trigger done with HTTP Get ('G') or HTTP Post ('P')","type":"string"},"username":{"description":"What is the username for the response post","type":"string"},"icon_url":{"description":"The url to find the icon for this users avatar","type":"string"},"auto_complete":{"description":"Use auto complete for this command","type":"boolean"},"auto_complete_desc":{"description":"The description for this command shown when selecting the command","type":"string"},"auto_complete_hint":{"description":"The hint for this command","type":"string"},"display_name":{"description":"Display name for the command","type":"string"},"description":{"description":"Description for this command","type":"string"},"url":{"description":"The URL that is triggered","type":"string"}}},"38cb7293_AutocompleteSuggestion":{"type":"object","properties":{"Complete":{"description":"Completed suggestion","type":"string"},"Suggestion":{"description":"Predicted text user might want to input","type":"string"},"Hint":{"description":"Hint about suggested input","type":"string"},"Description":{"description":"Description of the suggested command","type":"string"},"IconData":{"description":"Base64 encoded svg image","type":"string"}}},"38cb7293_CommandResponse":{"type":"object","properties":{"ResponseType":{"description":"The response type either in_channel or ephemeral","type":"string"},"Text":{"type":"string"},"Username":{"type":"string"},"IconURL":{"type":"string"},"GotoLocation":{"type":"string"},"Attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/38cb7293_SlackAttachment"}}}},"38cb7293_Role":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the role."},"name":{"type":"string","description":"The unique name of the role, used when assigning roles to users\/groups in contexts."},"display_name":{"type":"string","description":"The human readable name for the role."},"description":{"type":"string","description":"A human readable description of the role."},"permissions":{"type":"array","items":{"type":"string"},"description":"A list of the unique names of the permissions this role grants."},"scheme_managed":{"type":"boolean","description":"indicates if this role is managed by a scheme (true), or is a custom stand-alone role (false)."}}},"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_Bot":{"description":"A bot account","type":"object","properties":{"user_id":{"description":"The user id of the associated user entry.","type":"string"},"create_at":{"description":"The time in milliseconds a bot was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a bot was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a bot was deleted","type":"integer","format":"int64"},"username":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"owner_id":{"description":"The user id of the user that currently owns this bot.","type":"string"}}},"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_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_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_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_GroupWithSchemeAdmin":{"description":"group augmented with scheme admin information","type":"object","properties":{"group":{"$ref":"#\/components\/schemas\/38cb7293_Group"},"scheme_admin":{"type":"boolean"}}},"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><strong>folder<\/strong>: Folder model<\/note><note><strong>file<\/strong>: File model<\/note>"},"description":"<note><strong>folder<\/strong>: Folder model<\/note><note><strong>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><strong>audio<\/strong>: Media has an audio stream<\/note><note><strong>video<\/strong>: Media has a video stream<\/note>"},"description":"File Excerpt streams (only applies to media)<note><strong>audio<\/strong>: Media has an audio stream<\/note><note><strong>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><strong>cwd<\/strong>: Change Working Directory (navigate to a different directory)<\/note><note><strong>list<\/strong>: List files and directories in the current directory<\/note><note><strong>retr<\/strong>: Retrieve (download) a file from the server<\/note><note><strong>appe<\/strong>: Append data to an existing file on the server<\/note><note><strong>dele<\/strong>: Delete a file on the server<\/note><note><strong>rnfr<\/strong>: Rename From (specify the original name when renaming a file)<\/note><note><strong>mkd<\/strong>: Make Directory (create a new directory)<\/note><note><strong>stor<\/strong>: Store (upload) a file to the server<\/note><note><strong>chmod<\/strong>: Change the permissions of a file or directory<\/note><note><strong>mfmt<\/strong>: Modify the modification time of a file<\/note>"},"description":"User permissions<note><strong>cwd<\/strong>: Change Working Directory (navigate to a different directory)<\/note><note><strong>list<\/strong>: List files and directories in the current directory<\/note><note><strong>retr<\/strong>: Retrieve (download) a file from the server<\/note><note><strong>appe<\/strong>: Append data to an existing file on the server<\/note><note><strong>dele<\/strong>: Delete a file on the server<\/note><note><strong>rnfr<\/strong>: Rename From (specify the original name when renaming a file)<\/note><note><strong>mkd<\/strong>: Make Directory (create a new directory)<\/note><note><strong>stor<\/strong>: Store (upload) a file to the server<\/note><note><strong>chmod<\/strong>: Change the permissions of a file or directory<\/note><note><strong>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><strong>pre_roll<\/strong>: Advertisement displayed before the main content<\/note><note><strong>mid_roll<\/strong>: Advertisement displayed during the main content<\/note><note><strong>pst_roll<\/strong>: Advertisement displayed after the main content<\/note>"},"description":"The type of Ad<note><strong>pre_roll<\/strong>: Advertisement displayed before the main content<\/note><note><strong>mid_roll<\/strong>: Advertisement displayed during the main content<\/note><note><strong>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><strong>overlay<\/strong>: The logo is added on top of the video by a player configuration<\/note><note><strong>embed<\/strong>: The logo is directly encoded in the video<\/note>"},"description":"The Logo mode<note><strong>overlay<\/strong>: The logo is added on top of the video by a player configuration<\/note><note><strong>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><strong>top_left<\/strong>: Positioned at the top left corner<\/note><note><strong>top_middle<\/strong>: Positioned at the top middle<\/note><note><strong>top_right<\/strong>: Positioned at the top right corner<\/note><note><strong>center_left<\/strong>: Positioned at the center left<\/note><note><strong>center_middle<\/strong>: Positioned at the center middle<\/note><note><strong>center_right<\/strong>: Positioned at the center right<\/note><note><strong>bottom_left<\/strong>: Positioned at the bottom left corner<\/note><note><strong>bottom_middle<\/strong>: Positioned at the bottom middle<\/note><note><strong>bottom_right<\/strong>: Positioned at the bottom right corner<\/note>"},"description":"The anchor of the Logo<note><strong>top_left<\/strong>: Positioned at the top left corner<\/note><note><strong>top_middle<\/strong>: Positioned at the top middle<\/note><note><strong>top_right<\/strong>: Positioned at the top right corner<\/note><note><strong>center_left<\/strong>: Positioned at the center left<\/note><note><strong>center_middle<\/strong>: Positioned at the center middle<\/note><note><strong>center_right<\/strong>: Positioned at the center right<\/note><note><strong>bottom_left<\/strong>: Positioned at the bottom left corner<\/note><note><strong>bottom_middle<\/strong>: Positioned at the bottom middle<\/note><note><strong>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><strong>flv<\/strong>: Adobe Flash Video container format<\/note><note><strong>m4a<\/strong>: MPEG-4 Audio container format<\/note><note><strong>mkv<\/strong>: Matroska Multimedia container format<\/note><note><strong>mp4<\/strong>: MPEG-4 Multimedia container format<\/note><note><strong>webm<\/strong>: WebM Multimedia container format<\/note><note><strong>mp3<\/strong>: MPEG-1 or MPEG-2 Audio Layer III audio container<\/note><note><strong>copy<\/strong>: Uncompressed, lossless container format<\/note><note><strong>aac<\/strong>: Advanced Audio Coding container format<\/note>"},"description":"The Encoding container<note><strong>flv<\/strong>: Adobe Flash Video container format<\/note><note><strong>m4a<\/strong>: MPEG-4 Audio container format<\/note><note><strong>mkv<\/strong>: Matroska Multimedia container format<\/note><note><strong>mp4<\/strong>: MPEG-4 Multimedia container format<\/note><note><strong>webm<\/strong>: WebM Multimedia container format<\/note><note><strong>mp3<\/strong>: MPEG-1 or MPEG-2 Audio Layer III audio container<\/note><note><strong>copy<\/strong>: Uncompressed, lossless container format<\/note><note><strong>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><strong>h264<\/strong>: Efficient video compression standard<\/note><note><strong>hevc<\/strong>: High-efficiency video coding technology<\/note><note><strong>theora<\/strong>: Open-source video compression format<\/note><note><strong>vp8<\/strong>: Google's video compression standard<\/note><note><strong>vp9<\/strong>: High-quality video compression codec<\/note><note><strong>copy<\/strong>: Uncompressed, lossless video codec<\/note><note><strong>h263<\/strong>: Video compression standard for low bitrates<\/note>"},"description":"The video codec<note><strong>h264<\/strong>: Efficient video compression standard<\/note><note><strong>hevc<\/strong>: High-efficiency video coding technology<\/note><note><strong>theora<\/strong>: Open-source video compression format<\/note><note><strong>vp8<\/strong>: Google's video compression standard<\/note><note><strong>vp9<\/strong>: High-quality video compression codec<\/note><note><strong>copy<\/strong>: Uncompressed, lossless video codec<\/note><note><strong>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><strong>letterbox<\/strong>: Preserves aspect ratio with black bars<\/note><note><strong>stretch<\/strong>: Stretches content to fill screen<\/note><note><strong>fill<\/strong>: Expands content to fit screen<\/note><note><strong>keep_ratio<\/strong>: Maintains original aspect ratio<\/note><note><strong>copy<\/strong>: Matches aspect ratio of the source<\/note>"},"description":"The audio aspect<note><strong>letterbox<\/strong>: Preserves aspect ratio with black bars<\/note><note><strong>stretch<\/strong>: Stretches content to fill screen<\/note><note><strong>fill<\/strong>: Expands content to fit screen<\/note><note><strong>keep_ratio<\/strong>: Maintains original aspect ratio<\/note><note><strong>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><strong>aac<\/strong>: Advanced Audio Coding<\/note><note><strong>he_aac<\/strong>: High-Efficiency Advanced Audio Coding<\/note><note><strong>flac<\/strong>: Free Lossless Audio Codec<\/note><note><strong>mp3<\/strong>: MPEG-1 Audio Layer III<\/note><note><strong>vorbis<\/strong>: Open-source audio compression format<\/note><note><strong>copy<\/strong>: Uncompressed, lossless audio codec<\/note><note><strong>opus<\/strong>: Versatile audio codec<\/note>"},"description":"The audio codec<note><strong>aac<\/strong>: Advanced Audio Coding<\/note><note><strong>he_aac<\/strong>: High-Efficiency Advanced Audio Coding<\/note><note><strong>flac<\/strong>: Free Lossless Audio Codec<\/note><note><strong>mp3<\/strong>: MPEG-1 Audio Layer III<\/note><note><strong>vorbis<\/strong>: Open-source audio compression format<\/note><note><strong>copy<\/strong>: Uncompressed, lossless audio codec<\/note><note><strong>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><strong>mono_1_0<\/strong>: Single-channel audio<\/note><note><strong>stereo_2_0<\/strong>: Two-channel audio<\/note><note><strong>stereo_2_1<\/strong>: Two-channel audio with subwoofer<\/note><note><strong>surround_4_1<\/strong>: Four-channel audio with subwoofer<\/note><note><strong>surround_5_1<\/strong>: Six-channel audio (5 speakers + subwoofer)<\/note><note><strong>surround_6_1<\/strong>: Seven-channel audio (6 speakers + subwoofer)<\/note><note><strong>surround_7_1<\/strong>: Eight-channel audio (7 speakers + subwoofer)<\/note>"},"description":"The audio channel<note><strong>mono_1_0<\/strong>: Single-channel audio<\/note><note><strong>stereo_2_0<\/strong>: Two-channel audio<\/note><note><strong>stereo_2_1<\/strong>: Two-channel audio with subwoofer<\/note><note><strong>surround_4_1<\/strong>: Four-channel audio with subwoofer<\/note><note><strong>surround_5_1<\/strong>: Six-channel audio (5 speakers + subwoofer)<\/note><note><strong>surround_6_1<\/strong>: Seven-channel audio (6 speakers + subwoofer)<\/note><note><strong>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><strong>merge<\/strong>: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media<\/note><note><strong>split<\/strong>: Each media will be played individually: the progress-bar will be independent for each media<\/note><note><strong>live<\/strong>: The playlist will act as a live streaming: no scrubbing will be allowed<\/note>"},"description":"Playlist settings mode (changes progressbar behaviour)<note><strong>merge<\/strong>: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media<\/note><note><strong>split<\/strong>: Each media will be played individually: the progress-bar will be independent for each media<\/note><note><strong>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><strong>above<\/strong>: Controls are placed above the playlist<\/note><note><strong>below<\/strong>: Controls are placed below the playlist<\/note>"},"description":"Playlist settings nav position<note><strong>above<\/strong>: Controls are placed above the playlist<\/note><note><strong>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><strong>dark<\/strong>: Darker colors<\/note><note><strong>light<\/strong>: Lighter colors<\/note>"},"description":"Playlist settings chapter style<note><strong>dark<\/strong>: Darker colors<\/note><note><strong>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><strong>flv<\/strong>: Adobe Flash Video container format<\/note><note><strong>m4a<\/strong>: MPEG-4 Audio container format<\/note><note><strong>mkv<\/strong>: Matroska Multimedia container format<\/note><note><strong>mp4<\/strong>: MPEG-4 Multimedia container format<\/note><note><strong>webm<\/strong>: WebM Multimedia container format<\/note><note><strong>mp3<\/strong>: MPEG-1 or MPEG-2 Audio Layer III audio container<\/note><note><strong>copy<\/strong>: Uncompressed, lossless container format<\/note><note><strong>aac<\/strong>: Advanced Audio Coding container format<\/note>"},"description":"The Stream container<note><strong>flv<\/strong>: Adobe Flash Video container format<\/note><note><strong>m4a<\/strong>: MPEG-4 Audio container format<\/note><note><strong>mkv<\/strong>: Matroska Multimedia container format<\/note><note><strong>mp4<\/strong>: MPEG-4 Multimedia container format<\/note><note><strong>webm<\/strong>: WebM Multimedia container format<\/note><note><strong>mp3<\/strong>: MPEG-1 or MPEG-2 Audio Layer III audio container<\/note><note><strong>copy<\/strong>: Uncompressed, lossless container format<\/note><note><strong>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><strong>h264<\/strong>: Efficient video compression standard<\/note><note><strong>hevc<\/strong>: High-efficiency video coding technology<\/note><note><strong>theora<\/strong>: Open-source video compression format<\/note><note><strong>vp8<\/strong>: Google's video compression standard<\/note><note><strong>vp9<\/strong>: High-quality video compression codec<\/note><note><strong>copy<\/strong>: Uncompressed, lossless video codec<\/note><note><strong>h263<\/strong>: Video compression standard for low bitrates<\/note>"},"description":"The video codec<note><strong>h264<\/strong>: Efficient video compression standard<\/note><note><strong>hevc<\/strong>: High-efficiency video coding technology<\/note><note><strong>theora<\/strong>: Open-source video compression format<\/note><note><strong>vp8<\/strong>: Google's video compression standard<\/note><note><strong>vp9<\/strong>: High-quality video compression codec<\/note><note><strong>copy<\/strong>: Uncompressed, lossless video codec<\/note><note><strong>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><strong>letterbox<\/strong>: Preserves aspect ratio with black bars<\/note><note><strong>stretch<\/strong>: Stretches content to fill screen<\/note><note><strong>fill<\/strong>: Expands content to fit screen<\/note><note><strong>keep_ratio<\/strong>: Maintains original aspect ratio<\/note><note><strong>copy<\/strong>: Matches aspect ratio of the source<\/note>"},"description":"The audio aspect<note><strong>letterbox<\/strong>: Preserves aspect ratio with black bars<\/note><note><strong>stretch<\/strong>: Stretches content to fill screen<\/note><note><strong>fill<\/strong>: Expands content to fit screen<\/note><note><strong>keep_ratio<\/strong>: Maintains original aspect ratio<\/note><note><strong>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><strong>aac<\/strong>: Advanced Audio Coding<\/note><note><strong>he_aac<\/strong>: High-Efficiency Advanced Audio Coding<\/note><note><strong>flac<\/strong>: Free Lossless Audio Codec<\/note><note><strong>mp3<\/strong>: MPEG-1 Audio Layer III<\/note><note><strong>vorbis<\/strong>: Open-source audio compression format<\/note><note><strong>copy<\/strong>: Uncompressed, lossless audio codec<\/note><note><strong>opus<\/strong>: Versatile audio codec<\/note>"},"description":"The audio codec<note><strong>aac<\/strong>: Advanced Audio Coding<\/note><note><strong>he_aac<\/strong>: High-Efficiency Advanced Audio Coding<\/note><note><strong>flac<\/strong>: Free Lossless Audio Codec<\/note><note><strong>mp3<\/strong>: MPEG-1 Audio Layer III<\/note><note><strong>vorbis<\/strong>: Open-source audio compression format<\/note><note><strong>copy<\/strong>: Uncompressed, lossless audio codec<\/note><note><strong>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><strong>mono_1_0<\/strong>: Single-channel audio<\/note><note><strong>stereo_2_0<\/strong>: Two-channel audio<\/note><note><strong>stereo_2_1<\/strong>: Two-channel audio with subwoofer<\/note><note><strong>surround_4_1<\/strong>: Four-channel audio with subwoofer<\/note><note><strong>surround_5_1<\/strong>: Six-channel audio (5 speakers + subwoofer)<\/note><note><strong>surround_6_1<\/strong>: Seven-channel audio (6 speakers + subwoofer)<\/note><note><strong>surround_7_1<\/strong>: Eight-channel audio (7 speakers + subwoofer)<\/note>"},"description":"The audio channel<note><strong>mono_1_0<\/strong>: Single-channel audio<\/note><note><strong>stereo_2_0<\/strong>: Two-channel audio<\/note><note><strong>stereo_2_1<\/strong>: Two-channel audio with subwoofer<\/note><note><strong>surround_4_1<\/strong>: Four-channel audio with subwoofer<\/note><note><strong>surround_5_1<\/strong>: Six-channel audio (5 speakers + subwoofer)<\/note><note><strong>surround_6_1<\/strong>: Seven-channel audio (6 speakers + subwoofer)<\/note><note><strong>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><strong>static<\/strong>: Allows only media to be added to the playlist<\/note><note><strong>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><strong>merge<\/strong>: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media<\/note><note><strong>split<\/strong>: Each media will be played individually: the progress-bar will be independent for each media<\/note><note><strong>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><strong>auto<\/strong>: Sorted automatically<\/note><note><strong>created_asc<\/strong>: By creation date in ascending order<\/note><note><strong>created_desc<\/strong>: By creation date in descending order<\/note><note><strong>name_asc<\/strong>: By name in ascending order<\/note><note><strong>name_desc<\/strong>: By name in descending order<\/note><note><strong>duration_asc<\/strong>: By duration in ascending order<\/note><note><strong>duration_desc<\/strong>: By duration in descending order<\/note><note><strong>views_asc<\/strong>: By views in ascending order<\/note><note><strong>views_desc<\/strong>: By views in descending order<\/note><note><strong>random<\/strong>: Randomly sorted<\/note><note><strong>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><strong>above<\/strong>: Controls are placed above the playlist<\/note><note><strong>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><strong>dark<\/strong>: Darker colors<\/note><note><strong>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><strong>acpm<\/strong>: Certified by ACPM<\/note><note><strong>mediapulse<\/strong>: Certified by Mediapulse<\/note><note><strong>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_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_Listedsenders":{"title":"Listed senders","required":["email","locked"],"type":"object","properties":{"email":{"title":"email","type":"string","description":"Email"},"locked":{"title":"locked","type":"string"}}},"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_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><strong>0<\/strong>: Only moderator and subscriber can send email through the mailing list.<\/note><note><strong>1<\/strong>: Only moderator can send email through the mailing list.<\/note><note><strong>2<\/strong>: Everyone can send email through the mailing list but requires a moderator validation.<\/note><note><strong>3<\/strong>: Only moderator and subscriber can send email through the mailing list but requires a moderator validation.<\/note><note><strong>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><strong>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><strong>0<\/strong>: Anybody can subscribe.<\/note><note><strong>1<\/strong>: Any new subscription should be confirmed by the owner.<\/note><note><strong>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><strong>de<\/strong>: German language.<\/note><note><strong>en<\/strong>: English language.<\/note><note><strong>es<\/strong>: Spanish language.<\/note><note><strong>fr<\/strong>: French language.<\/note><note><strong>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_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_Singlemailboxfolder":{"title":"Single mailbox folder","required":["name"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Mailbox folder's name"}}},"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><strong>draft<\/strong>: The signature is in draft mode and cannot be used until it has been validated.<\/note><note><strong>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":[]}}},"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_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><strong>bottom<\/strong>: The signature is placed at the bottom of the email.<\/note><note><strong>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_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_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_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_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><strong>healthy<\/strong>: The access is healthy.<\/note><note><strong>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_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_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"}}},"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><strong>computer<\/strong>: The device is a computer.<\/note><note><strong>legacy<\/strong>: The device'password is a legacy password used by all users before the feature of multiples password.<\/note><note><strong>other<\/strong>: The device is an other type.<\/note><note><strong>phone<\/strong>: The device is a phone.<\/note><note><strong>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_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><strong>imap<\/strong>: The protocol is imap.<\/note><note><strong>pop3<\/strong>: The protocol is pop3.<\/note><note><strong>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><strong>healthy<\/strong>: The password is healthy.<\/note><note><strong>leaked<\/strong>: The password was leaked.<\/note><note><strong>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"}}}}},"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><strong>demo_end<\/strong>: The demonstration period of the Drive has come to an end.<\/note><note><strong>invoice_overdue<\/strong>: An invoice for this Drive is currently unpaid.<\/note><note><strong>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><strong>365<\/strong>: The 365 application.<\/note><note><strong>collabora<\/strong>: The collabora application.<\/note><note><strong>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><strong>365<\/strong>: The 365 application.<\/note><note><strong>collabora<\/strong>: The collabora application.<\/note><note><strong>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><strong>365<\/strong>: The 365 application.<\/note><note><strong>collabora<\/strong>: The collabora application.<\/note><note><strong>onlyoffice<\/strong>: The onlyoffice application.<\/note>","example":"365"},"default_mode":{"title":"default_mode","enum":["desktop","embedded","mobile"],"type":"string","description":"OnlyOffice display mode.<note><strong>desktop<\/strong>: Optimized for the display in desktop computer browsers.<\/note><note><strong>embedded<\/strong>: Optimized for embedding the documents into a website page.<\/note><note><strong>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><strong>canceled<\/strong>: Rewind was canceled by the user and deleted.<\/note><note><strong>done<\/strong>: Rewind completed successfully.<\/note><note><strong>drive_not_ready<\/strong>: Rewind cannot start because the drive was not ready (uploads or actions in progress).<\/note><note><strong>expired<\/strong>: Rewind has expired and deleted.<\/note><note><strong>failed<\/strong>: Rewind completed with errors.<\/note><note><strong>in_progress<\/strong>: Rewind is currently in progress.<\/note><note><strong>new<\/strong>: Rewind did not start.<\/note><note><strong>sanitizing<\/strong>: Rewind find the activity to sanitize.<\/note><note><strong>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><strong>directory<\/strong>: Rewind only a directory.<\/note><note><strong>drive<\/strong>: Rewind all the drive.<\/note><note><strong>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><strong>all<\/strong>: Keep in an archive folder the current or trashed files.<\/note><note><strong>current<\/strong>: Keep in an archive folder the current files.<\/note><note><strong>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><strong>one_month<\/strong>: 30 days.<\/note><note><strong>one_year<\/strong>: A year.<\/note><note><strong>six_months<\/strong>: 180 days.<\/note><note><strong>three_months<\/strong>: 90 days.<\/note><note><strong>two_months<\/strong>: 60 days.<\/note>"},"description":"Available options for setting trash retention.<note><strong>one_month<\/strong>: 30 days.<\/note><note><strong>one_year<\/strong>: A year.<\/note><note><strong>six_months<\/strong>: 180 days.<\/note><note><strong>three_months<\/strong>: 90 days.<\/note><note><strong>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><strong>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><strong>ok<\/strong>: Directory V3 is available.<\/note><note><strong>trash_inherited<\/strong>: Directory V3 is currently in trash because a parent directory was trashed.<\/note><note><strong>trashed<\/strong>: Directory V3 is currently in trash and specifically trashed by the user.<\/note><note><strong>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><\/strong>: Empty visibility mean no special visibility.<\/note><note><strong>is_in_private_space<\/strong>: Is a Directory V3 inside the private directory of the user.<\/note><note><strong>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><strong>is_in_team_space_folder<\/strong>: Is a Directory V3 inside a Common Documents directory.<\/note><note><strong>is_private_space<\/strong>: Is the private directory of the user.<\/note><note><strong>is_root<\/strong>: Is the root directory of the user.<\/note><note><strong>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><strong>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><strong>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><strong>365<\/strong>: The 365 application.<\/note><note><strong>external_import<\/strong>: The external_import application.<\/note><note><strong>internal_copy<\/strong>: The internal_copy application.<\/note><note><strong>internal_import<\/strong>: The internal_import application.<\/note><note><strong>onlyoffice<\/strong>: The onlyoffice application.<\/note><note><strong>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><strong>inherit<\/strong>: Share link is accessible only by users of the drive.<\/note><note><strong>password<\/strong>: Share link is public but protected by a password.<\/note><note><strong>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><strong>dropbox<\/strong>: Import from Dropbox.<\/note><note><strong>google<\/strong>: (deprecated) Import from Google Drive.<\/note><note><strong>google_drive<\/strong>: Import from Google Drive.<\/note><note><strong>kdrive<\/strong>: Import from another kDrive.<\/note><note><strong>kdrive_sharelink<\/strong>: Import from a kDrive sharelink.<\/note><note><strong>nextcloud<\/strong>: Import from Nextcloud.<\/note><note><strong>onedrive<\/strong>: Import from Microsoft OneDrive.<\/note><note><strong>owncloud<\/strong>: Import from ownCloud.<\/note><note><strong>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><strong>canceled<\/strong>: External import was canceled.<\/note><note><strong>canceling<\/strong>: External import is being canceled.<\/note><note><strong>done<\/strong>: External import is finished.<\/note><note><strong>failed<\/strong>: External import failed.<\/note><note><strong>in_progress<\/strong>: External import is currently in progress.<\/note><note><strong>queued<\/strong>: External import is waiting for a process to handle it.<\/note><note><strong>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><strong>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><strong>ok<\/strong>: Directory is available.<\/note><note><strong>trash_inherited<\/strong>: Directory is currently in trash because a parent directory was trashed.<\/note><note><strong>trashed<\/strong>: Directory is currently in trash and specifically trashed by the user.<\/note><note><strong>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><\/strong>: Empty visibility mean no special visibility.<\/note><note><strong>is_in_team_space_folder<\/strong>: Is a Directory inside a Common Documents directory.<\/note><note><strong>is_root<\/strong>: Is the root directory of the user.<\/note><note><strong>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><strong>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><strong>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><strong>main<\/strong>: User has access to the drive.<\/note><note><strong>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><strong>active<\/strong>: User has access to the Drive.<\/note><note><strong>deleted_kept<\/strong>: User has been removed but his data remain in the drive.<\/note><note><strong>deleted_removed<\/strong>: User has been removed.<\/note><note><strong>deleted_transferred<\/strong>: User has been removed and his data has been transferred to another user.<\/note><note><strong>deleted_transferring<\/strong>: User has been removed and is being transferred to another user.<\/note><note><strong>locked<\/strong>: User has been locked, user can no longer access to the drive.<\/note><note><strong>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><strong>admin<\/strong>: Administrator of the drive, can manage the drive (settings, invitations and users) and the files.<\/note><note><strong>external<\/strong>: External user can only access the files given by the others roles.<\/note><note><strong>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><strong>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><strong>ok<\/strong>: File V3 is available.<\/note><note><strong>trash_inherited<\/strong>: File V3 is currently in trash because a parent directory was trashed.<\/note><note><strong>trashed<\/strong>: File V3 is currently in trash and specifically trashed by the user.<\/note><note><strong>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><\/strong>: Empty visibility mean no special visibility.<\/note><note><strong>is_in_private_space<\/strong>: Is a File V3 inside the private directory of the user.<\/note><note><strong>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><strong>is_in_team_space_folder<\/strong>: Is a File V3 inside a Common Documents directory.<\/note><note><strong>is_private_space<\/strong>: Is the private directory of the user.<\/note><note><strong>is_root<\/strong>: Is the root directory of the user.<\/note><note><strong>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><strong>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><strong>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><strong>365<\/strong>: The 365 application.<\/note><note><strong>external_import<\/strong>: The external_import application.<\/note><note><strong>internal_copy<\/strong>: The internal_copy application.<\/note><note><strong>internal_import<\/strong>: The internal_import application.<\/note><note><strong>onlyoffice<\/strong>: The onlyoffice application.<\/note><note><strong>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><strong>archive<\/strong>: Archive file.<\/note><note><strong>audio<\/strong>: Audio only file.<\/note><note><strong>code<\/strong>: Text file recognized as code.<\/note><note><strong>diagram<\/strong>: Diagram file.<\/note><note><strong>dir<\/strong>: Directory.<\/note><note><strong>email<\/strong>: Bundled email file.<\/note><note><strong>font<\/strong>: Text file recognized as font.<\/note><note><strong>form<\/strong>: Form file.<\/note><note><strong>image<\/strong>: Image file.<\/note><note><strong>model<\/strong>: 3D file.<\/note><note><strong>pdf<\/strong>: PDF file.<\/note><note><strong>presentation<\/strong>: Presentation\/slides file.<\/note><note><strong>spreadsheet<\/strong>: Spreadsheet file.<\/note><note><strong>text<\/strong>: Generic text file.<\/note><note><strong>unknown<\/strong>: Generic file, not recognized as any of the other type.<\/note><note><strong>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><strong>cannot_be_scanned<\/strong>: This File V3 cannot be scanned. Possibly because the File V3 is too large.<\/note><note><strong>clean<\/strong>: This File V3 has been successfully scanned for known viruses.<\/note><note><strong>error<\/strong>: An error occurred while scanning the File V3.<\/note><note><strong>infected<\/strong>: This File V3 has been detected as infected by a virus.<\/note><note><strong>not_to_be_scanned<\/strong>: This File V3 is not eligible to be scanned. Possibly because the File V3 is empty.<\/note><note><strong>pua<\/strong>: This File V3 has been detected as Potentially Unwanted Applications (PUA).<\/note><note><strong>to_be_defined<\/strong>: The status for this File V3 has not yet been determined.<\/note><note><strong>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><strong>365<\/strong>: The 365 application.<\/note><note><strong>drawio<\/strong>: The drawio application.<\/note><note><strong>kmail<\/strong>: The kmail application.<\/note><note><strong>onlyoffice<\/strong>: The onlyoffice application.<\/note><note><strong>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><strong>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><strong>ok<\/strong>: File is available.<\/note><note><strong>trash_inherited<\/strong>: File is currently in trash because a parent directory was trashed.<\/note><note><strong>trashed<\/strong>: File is currently in trash and specifically trashed by the user.<\/note><note><strong>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><\/strong>: Empty visibility mean no special visibility.<\/note><note><strong>is_in_team_space_folder<\/strong>: Is a File inside a Common Documents directory.<\/note><note><strong>is_root<\/strong>: Is the root directory of the user.<\/note><note><strong>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><strong>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><strong>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><strong>archive<\/strong>: Archive file.<\/note><note><strong>audio<\/strong>: Audio only file.<\/note><note><strong>code<\/strong>: Text file recognized as code.<\/note><note><strong>diagram<\/strong>: Diagram file.<\/note><note><strong>dir<\/strong>: Directory.<\/note><note><strong>email<\/strong>: Bundled email file.<\/note><note><strong>font<\/strong>: Text file recognized as font.<\/note><note><strong>form<\/strong>: Form file.<\/note><note><strong>image<\/strong>: Image file.<\/note><note><strong>model<\/strong>: 3D file.<\/note><note><strong>pdf<\/strong>: PDF file.<\/note><note><strong>presentation<\/strong>: Presentation\/slides file.<\/note><note><strong>spreadsheet<\/strong>: Spreadsheet file.<\/note><note><strong>text<\/strong>: Generic text file.<\/note><note><strong>unknown<\/strong>: Generic file, not recognized as any of the other type.<\/note><note><strong>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><strong>cannot_be_scanned<\/strong>: This File cannot be scanned. Possibly because the File is too large.<\/note><note><strong>clean<\/strong>: This File has been successfully scanned for known viruses.<\/note><note><strong>error<\/strong>: An error occurred while scanning the File.<\/note><note><strong>infected<\/strong>: This File has been detected as infected by a virus.<\/note><note><strong>not_to_be_scanned<\/strong>: This File is not eligible to be scanned. Possibly because the File is empty.<\/note><note><strong>pua<\/strong>: This File has been detected as Potentially Unwanted Applications (PUA).<\/note><note><strong>to_be_defined<\/strong>: The status for this File has not yet been determined.<\/note><note><strong>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><\/strong>: Empty visibility mean no special visibility.<\/note><note><strong>is_in_private_space<\/strong>: Is a Deleted Generic File V2 inside the private directory of the user.<\/note><note><strong>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><strong>is_in_team_space_folder<\/strong>: Is a Deleted Generic File V2 inside a Common Documents directory.<\/note><note><strong>is_private_space<\/strong>: Is the private directory of the user.<\/note><note><strong>is_root<\/strong>: Is the root directory of the user.<\/note><note><strong>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><strong>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><strong>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><strong>archive<\/strong>: File needs to be archived in a specific directory.<\/note><note><strong>archive_in_trash<\/strong>: File needs to be archived in trash root.<\/note><note><strong>exclude<\/strong>: File is excluded. No actions will be performed.<\/note><note><strong>file_deleted<\/strong>: File does not exist.<\/note><note><strong>move<\/strong>: File needs to be moved.<\/note><note><strong>rename<\/strong>: File needs to be renamed.<\/note><note><strong>restore<\/strong>: File needs to be restored from trash.<\/note><note><strong>trash<\/strong>: File needs to be trashed.<\/note><note><strong>update<\/strong>: File content need to be updated.<\/note><note><strong>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><strong>not_executed<\/strong>: Action was not executed yet.<\/note><note><strong>not_handled<\/strong>: Action cannot be rewound.<\/note><note><strong>on_conflict<\/strong>: Action lead to a conflict with another file\/directory, this item was moved to a specific directory.<\/note><note><strong>on_error<\/strong>: Action lead to a fatal error, for instance the targeted version of a file was unable to be restored.<\/note><note><strong>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><strong>error<\/strong>: Something was wrong chunk was not correctly received, retried to send the same chunk.<\/note><note><strong>ok<\/strong>: Chunk has been received.<\/note><note><strong>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><\/strong>: Empty visibility mean no special visibility.<\/note><note><strong>is_in_private_space<\/strong>: Is a File Deleted inside the private directory of the user.<\/note><note><strong>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><strong>is_in_team_space_folder<\/strong>: Is a File Deleted inside a Common Documents directory.<\/note><note><strong>is_private_space<\/strong>: Is the private directory of the user.<\/note><note><strong>is_root<\/strong>: Is the root directory of the user.<\/note><note><strong>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><strong>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><strong>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"}}},"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"}}},"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":{"from":{"schema":{"type":"string"},"in":"query","format":"string","name":"from","example":"1640390400","description":"begin date timestamp"},"medias":{"schema":{"type":"string"},"in":"query","format":"string","name":"medias","example":"1jhvl2uq8p2vt,1jhvl2uq8p2w9","description":"medias separated with comma"},"perhisto":{"schema":{"type":"string"},"in":"query","format":"string","name":"per","example":"1d","description":"Histogram grouped by 1d,1h,1m .."},"maketoken":{"strategy":{"type":"string","description":"Array","example":"HLS","enum":["DASH","HLS","BEST","SINGLE"],"format":"string"},"start_time":{"type":"string","description":"default NOW","example":"NOW()","format":"date"},"end_time":{"type":"string","description":"default NOW","example":"NOW()","format":"date"},"window":{"type":"number","description":"secondes","example":127,"format":"int","minimum":"1"},"allowed_domains":{"type":"array","description":"array","example":"[\"https:\/\/player.vod2.infomaniak.com\",\"https:\/\/api.vod2.infomaniak.com\",\"https:\/\/yourdomain.ch\"]"},"restricted_domains":{"type":"array","description":"array","example":"[url1,url2]"}},"cut":[],"Page":{"description":"*Optional parameter* that define the page number<br \/>\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<br \/>\nPart of the `pagination` capacity\n","schema":{"type":"integer"},"example":10,"name":"per_page","in":"query"},"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.<br \/>\nPart of the `total` capacity\n","schema":{"enum":["total"],"type":"string"},"name":"return","in":"query"},"OrderBy":{"description":"*Optional parameter* that define the field used for sorting<br \/>\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<br \/>\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<br \/>\nBy default **order** is used<br \/>\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<br \/>\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)<br \/>\nPart of the `offset` capacity\n","schema":{"type":"integer"},"example":2,"name":"skip","in":"query"},"Total":{"description":"If set to true, return the total number of items. Total pages (<strong>pages<\/strong>) in response is also returned.\n<note>You can also use ?with=total parameter<\/note>\n","style":"form","explode":true,"schema":{"type":"boolean"},"name":"total","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"}]}}}}}}}