@stoplight/elements/__fixtures__/api-descriptions/zoomApiYaml.d.ts

UI components for composing beautiful developer documentation.

export declare const zoomApiYaml = "\nswagger: '2.0'\nschemes:\n  - https\nhost: api.zoom.us\nbasePath: /v2\ninfo:\n  contact:\n    email: developer@zoom.us\n    name: Zoom Developers\n    url: 'https://developer.zoom.us/'\n    x-twitter: zoom_us\n  description: API Description\n  license:\n    name: MIT\n    url: 'https://opensource.org/licenses/MIT'\n  title: Zoom\n  version: 2.0.0\n  x-apisguru-categories:\n    - telecom\n  x-logo:\n    url: 'https://twitter.com/zoom_us/profile_image?size=original'\n  x-origin:\n    - format: swagger\n      url: 'https://raw.githubusercontent.com/zoom/api/master/openapi.v2.json'\n      version: '2.0'\n  x-providerName: zoom.us\nexternalDocs:\n  description: Zoom API Documentation\n  url: 'https://zoom.github.io/api'\nconsumes:\n  - application/json\n  - multipart/form-data\nproduces:\n  - application/json\n  - application/xml\nsecurityDefinitions:\n  global:\n    in: query\n    name: access_token\n    type: apiKey\nsecurity:\n  - global: []\nparameters:\n  AccountId:\n    description: The account ID\n    in: path\n    name: accountId\n    required: true\n    type: string\n  FromDate:\n    description: Start Date\n    format: date\n    in: query\n    name: from\n    required: true\n    type: string\n  GroupId:\n    description: The group ID\n    in: path\n    name: groupId\n    required: true\n    type: string\n  LoginType:\n    enum:\n      - 0\n      - 1\n      - 99\n      - 100\n      - 101\n    in: query\n    name: login_type\n    type: string\n    x-enum-descriptions:\n      - Facebook\n      - Google\n      - API\n      - Zoom\n      - SSO\n  Mc:\n    default: 'false'\n    description: 'Query mc '\n    in: query\n    name: mc\n    type: string\n  MeetingId:\n    description: The meeting ID\n    in: path\n    name: meetingId\n    required: true\n    type: integer\n    enum: [0, 1, 2, 3]\n\n  MeetingId4Metrics:\n    description: 'The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.'\n    in: path\n    name: meetingId\n    required: true\n    type: integer\n  MeetingId4Recording:\n    description: 'The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.'\n    in: path\n    name: meetingId\n    required: true\n    type: integer\n  MeetingIdNumber:\n    description: The meeting ID or uuid\n    in: path\n    name: meetingId\n    required: true\n    type: string\n  MeetingType:\n    default: live\n    description: The meeting type\n    enum:\n      - scheduled\n      - live\n    in: query\n    name: type\n    type: string\n    x-enum-descriptions:\n      - all the scheduled meetings\n      - all the live meetings\n  MeetingTypePast:\n    default: live\n    description: The meeting type\n    enum:\n      - past\n      - pastOne\n      - live\n    in: query\n    name: type\n    type: string\n    x-enum-descriptions:\n      - past meetings\n      - past one user meetings\n      - live meetings\n  MeetingTypePast2:\n    default: live\n    description: The meeting type\n    enum:\n      - past\n      - live\n    in: query\n    name: type\n    type: string\n    x-enum-descriptions:\n      - past meeting\n      - live meeting\n  MeetingTypePast3:\n    default: live\n    description: The meeting type\n    enum:\n      - past\n      - pastOne\n      - live\n    in: query\n    name: type\n    type: string\n    x-enum-descriptions:\n      - past meeting\n      - past one user meeting\n      - live meeting\n  MemberId:\n    description: The member ID\n    in: path\n    name: memberId\n    required: true\n    type: string\n  NextPageToken:\n    description: 'Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.'\n    in: query\n    name: next_page_token\n    type: string\n  OccurrenceId:\n    description: The meeting occurrence ID\n    in: query\n    name: occurrence_id\n    type: string\n  PageNumber:\n    default: 1\n    description: Current page number of returned records.\n    in: query\n    name: page_number\n    type: integer\n  PageSize:\n    default: 30\n    description: 'The amount of records returns within a single API call. '\n    in: query\n    maximum: 300\n    name: page_size\n    type: integer\n  PageSize4Qos:\n    default: 1\n    description: Number of items returned per page\n    in: query\n    maximum: 10\n    name: page_size\n    type: integer\n  PageToken:\n    description: 'Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes.'\n    in: query\n    name: next_page_token\n    type: string\n  ParticipantId:\n    description: 'The participant ID, such as 16778240'\n    in: path\n    name: participantId\n    required: true\n    type: string\n  RecordingDeleteAction:\n    default: trash\n    description: The recording delete action\n    enum:\n      - trash\n      - delete\n    in: query\n    name: action\n    type: string\n    x-enum-descriptions:\n      - move recording to trash\n      - delete recording permanently\n  RecordingId:\n    description: The recording ID\n    in: path\n    name: recordingId\n    required: true\n    type: string\n  RegistrantId:\n    description: The registrant ID\n    in: path\n    name: registrantId\n    required: true\n    type: string\n  RegistrantStatus:\n    default: approved\n    description: The registrant status\n    enum:\n      - pending\n      - approved\n      - denied\n    in: query\n    name: status\n    type: string\n    x-enum-descriptions:\n      - registrants status is pending\n      - registrants status is approved\n      - registrants status is denied\n  TSPId:\n    description: TSP account index\n    in: path\n    name: tspId\n    required: true\n    type: string\n  ToDate:\n    description: End Date\n    format: date\n    in: query\n    name: to\n    required: true\n    type: string\n  Trash:\n    default: false\n    description: 'Query trash '\n    in: query\n    name: trash\n    type: boolean\n  UserId:\n    description: The user ID or email address\n    in: path\n    name: userId\n    required: true\n    type: string\n  WebhookId:\n    description: The webhook ID\n    in: path\n    name: webhookId\n    required: true\n    type: string\n  WebinarId:\n    description: The webinar ID\n    in: path\n    name: webinarId\n    required: true\n    type: integer\n  WebinarId4Metrics:\n    description: 'The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.'\n    in: path\n    name: webinarId\n    required: true\n    type: integer\n  WebinarTypePast:\n    default: live\n    description: The webinar type\n    enum:\n      - past\n      - live\n    in: query\n    name: type\n    type: string\n    x-enum-descriptions:\n      - past webinars\n      - live webinars\n  WebinarTypePast2:\n    default: live\n    description: The webinar type\n    enum:\n      - past\n      - live\n    in: query\n    name: type\n    type: string\n    x-enum-descriptions:\n      - past webinar\n      - live webinar\n  ZoomRoomId:\n    description: The Zoom Room ID\n    in: path\n    name: zoomroomId\n    required: true\n    type: integer\ntags:\n  - description: Account operations\n    name: Accounts\n  - description: Billing operations\n    name: Billing\n  - description: User operations\n    name: Users\n  - description: Meeting operations\n    name: Meetings\n  - description: Webinar operations\n    name: Webinars\n  - description: Group operations\n    name: Groups\n  - description: IM Group operations\n    name: IM Groups\n  - description: Cloud Recording operations\n    name: Cloud Recording\n  - description: Report operations\n    name: Reports\n  - description: Dashboard operations\n    name: Dashboards\n  - description: Webhook operations\n    name: Webhooks\n  - description: TSP operations\n    name: TSP\npaths:\n  /accounts:\n    get:\n      description: List all the sub accounts under the master account.\n      operationId: accounts\n      parameters:\n        - $ref: '#/parameters/PageSize'\n        - $ref: '#/parameters/PageNumber'\n      responses:\n        '200':\n          description: Account list returned\n          schema:\n            $ref: '#/definitions/AccountList'\n      summary: List sub accounts\n      tags:\n        - Accounts\n    post:\n      description: 'Create a sub account under the master account <aside>Your account must be a master account and have this privilege to create sub account. Zoom only assign this privilege to trusted partner. The created user will not receive the confirmation email.</aside>'\n      operationId: accountCreate\n      parameters:\n        - description: Account\n          in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/Account'\n      responses:\n        '201':\n          description: Account Created\n          headers:\n            Content-Location:\n              description: Location of created Account\n              type: string\n          schema:\n            properties:\n              created_at:\n                description: Account created date time\n                type: string\n              id:\n                description: Account ID\n                type: string\n              owner_email:\n                description: Account owner email\n                type: string\n              owner_id:\n                description: Account Owner ID\n                type: string\n        '409':\n          description: Account with that email already exists\n      summary: Create a sub account\n      tags:\n        - Accounts\n  '/accounts/{accountId}':\n    delete:\n      description: Disassociate a sub account from the master account\n      operationId: accountDisassociate\n      parameters:\n        - $ref: '#/parameters/AccountId'\n      responses:\n        '204':\n          description: Account deleted\n        '404':\n          description: Account not found\n      summary: Disassociate an account\n      tags:\n        - Accounts\n    get:\n      description: 'Retrieve a sub account under the master account <aside>Your account must be a master account and have this privilege to get sub account. Zoom only assign this privilege to trusted partner</aside>'\n      operationId: account\n      parameters:\n        - $ref: '#/parameters/AccountId'\n      responses:\n        '200':\n          description: Account object returned\n          schema:\n            properties:\n              created_at:\n                description: Account creation date/time\n                format: date-time\n                type: string\n              id:\n                description: Account ID\n                type: string\n              options:\n                $ref: '#/definitions/AccountOptions'\n              owner_email:\n                description: Account Owner email\n                type: string\n              owner_id:\n                description: Account Owner ID\n                type: string\n        '404':\n          description: User not found\n      summary: Retrieve a sub account\n      tags:\n        - Accounts\n  '/accounts/{accountId}/billing':\n    get:\n      description: Retrieve billing information for a sub account under the master account\n      operationId: accountBilling\n      parameters:\n        - $ref: '#/parameters/AccountId'\n      responses:\n        '200':\n          description: Account billing contact information returned\n          schema:\n            $ref: '#/definitions/BillingContactRequired'\n        '404':\n          description: Account not found\n      summary: Retrieve billing information for a sub account\n      tags:\n        - Billing\n    patch:\n      description: 'Update billing information for a sub account under the master account <aside>Only for the sub account which is a paid account and paid by master account</aside>'\n      operationId: accountBillingUpdate\n      parameters:\n        - $ref: '#/parameters/AccountId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/BillingContact'\n      responses:\n        '204':\n          description: Account billing contact information updated\n        '404':\n          description: Account not found\n      summary: Update billing information for a sub account\n      tags:\n        - Billing\n  '/accounts/{accountId}/options':\n    patch:\n      description: \"Update a sub account's options under the master account\"\n      operationId: accountOptionsUpdate\n      parameters:\n        - $ref: '#/parameters/AccountId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/AccountOptions'\n      responses:\n        '204':\n          description: Account options updated\n        '404':\n          description: Account not found\n      summary: \"Update a sub account's options\"\n      tags:\n        - Accounts\n  '/accounts/{accountId}/plans':\n    get:\n      description: 'Retrieve plan information for a sub account under the master account  <aside>Only for the sub account which is paid by master account</aside>'\n      operationId: accountPlans\n      parameters:\n        - $ref: '#/parameters/AccountId'\n      responses:\n        '200':\n          description: Account plans returned\n          schema:\n            $ref: '#/definitions/AccountPlans'\n        '404':\n          description: Account not fond\n      summary: Retrieve plan information for a sub account\n      tags:\n        - Billing\n    post:\n      description: 'Subscribe plans for a sub account of the master account <aside>Can only subscribe plans for the sub account which is a free account and paid by master account</aside>'\n      operationId: accountPlanCreate\n      parameters:\n        - $ref: '#/parameters/AccountId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            allOf:\n              - properties:\n                  contact:\n                    $ref: '#/definitions/BillingContactRequired'\n                type: object\n              - $ref: '#/definitions/AccountPlans'\n      responses:\n        '201':\n          description: Account plans updated\n          schema:\n            $ref: '#/definitions/AccountPlans'\n      summary: Subscribe plans for a sub account\n      tags:\n        - Billing\n  '/accounts/{accountId}/plans/addons':\n    post:\n      description: 'Add an additional plan for sub account <aside>Can only add an Additional plan for the sub account which is a paid account and paid by master account</aside>'\n      operationId: accountPlanAddonCreate\n      parameters:\n        - $ref: '#/parameters/AccountId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/AccountPlanRequired'\n      responses:\n        '201':\n          description: Account plans updated\n      summary: Add an additional plan for sub account\n      tags:\n        - Billing\n    put:\n      description: 'Update an additional plan for sub account<aside>Can only update an Additional plan for the sub account which is a paid account and paid by master account</aside>'\n      operationId: accountPlanAddonUpdate\n      parameters:\n        - $ref: '#/parameters/AccountId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/AccountPlanRequired'\n      responses:\n        '204':\n          description: Account plans updated\n      summary: Update an additional plan for sub account\n      tags:\n        - Billing\n  '/accounts/{accountId}/plans/base':\n    put:\n      description: 'Update a base plan for a sub account <aside>Can only update a base plan for the sub account which is a paid account and paid by master account</aside>'\n      operationId: accountPlanBaseUpdate\n      parameters:\n        - $ref: '#/parameters/AccountId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/AccountPlanBaseRequired'\n      responses:\n        '204':\n          description: Account plans updated\n      summary: Update a base plan for a sub account\n      tags:\n        - Billing\n  '/accounts/{accountId}/settings':\n    get:\n      description: \"Retrieve a sub account's settings under the master account\"\n      operationId: accountSettings\n      parameters:\n        - $ref: '#/parameters/AccountId'\n      responses:\n        '200':\n          description: Account settings returned\n          schema:\n            $ref: '#/definitions/AccountSettings'\n        '404':\n          description: Account not found\n      summary: \"Retrieve a sub account's settings\"\n      tags:\n        - Accounts\n    patch:\n      description: \"Update a sub account's settings under the master account\"\n      operationId: accountSettingsUpdate\n      parameters:\n        - $ref: '#/parameters/AccountId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/AccountSettings'\n      responses:\n        '204':\n          description: Account settings updated\n        '404':\n          description: Account not found\n      summary: \"Update a sub account's settings\"\n      tags:\n        - Accounts\n  /groups:\n    get:\n      description: List groups under your account\n      operationId: groups\n      parameters: []\n      responses:\n        '200':\n          description: List of groups returned.\n          schema:\n            $ref: '#/definitions/GroupList'\n      summary: List groups\n      tags:\n        - Groups\n    post:\n      description: Create a group under your account\n      operationId: groupCreate\n      parameters:\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              name:\n                description: Group name.\n                type: string\n      responses:\n        '201':\n          description: Group created.\n          headers:\n            Content-Location:\n              description: Location of created group\n              type: string\n          schema:\n            properties:\n              id:\n                description: Group ID\n                type: string\n              name:\n                description: Group name\n                type: string\n              total_members:\n                description: Group member count\n                type: integer\n      summary: Create a group\n      tags:\n        - Groups\n  '/groups/{groupId}':\n    delete:\n      description: Delete a group under your account\n      operationId: groupDelete\n      parameters:\n        - $ref: '#/parameters/GroupId'\n      responses:\n        '204':\n          description: Group deleted.\n        '404':\n          description: Group not found\n      summary: Delete a group\n      tags:\n        - Groups\n    get:\n      description: Retrieve a group under your account\n      operationId: group\n      parameters:\n        - $ref: '#/parameters/GroupId'\n      responses:\n        '200':\n          description: Group object returned\n          schema:\n            allOf:\n              - properties:\n                  id:\n                    description: Group ID\n                    type: string\n              - $ref: '#/definitions/Group'\n        '404':\n          description: Group not found\n      summary: Retrieve a group\n      tags:\n        - Groups\n    patch:\n      description: Update a group under your account\n      operationId: groupUpdate\n      parameters:\n        - $ref: '#/parameters/GroupId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              name:\n                description: Group name. Must be unique in one account. Character length is less than 128.\n                type: string\n      responses:\n        '204':\n          description: Group updated.\n        '404':\n          description: Group not found\n      summary: Update a group\n      tags:\n        - Groups\n  '/groups/{groupId}/members':\n    get:\n      description: \"List a group's members under your account\"\n      operationId: groupMembers\n      parameters:\n        - $ref: '#/parameters/GroupId'\n        - $ref: '#/parameters/PageSize'\n        - $ref: '#/parameters/PageNumber'\n      responses:\n        '200':\n          description: Group member list returned\n          schema:\n            $ref: '#/definitions/GroupMemberList'\n        '404':\n          description: Group not found\n      summary: \"List a group's members\"\n      tags:\n        - Groups\n    post:\n      description: Add members to a group under your account\n      operationId: groupMembersCreate\n      parameters:\n        - $ref: '#/parameters/GroupId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              members:\n                description: List of Group members\n                items:\n                  properties:\n                    email:\n                      description: 'User email. If ID given, email is ignored.'\n                      type: string\n                    id:\n                      description: User ID.\n                      type: string\n                maximum: 30\n                type: array\n      responses:\n        '201':\n          description: Member added.\n          schema:\n            properties:\n              added_at:\n                format: date-time\n                type: string\n              ids:\n                type: string\n        '404':\n          description: Group not found\n      summary: Add group members\n      tags:\n        - Groups\n  '/groups/{groupId}/members/{memberId}':\n    delete:\n      description: Delete a member from a group under your account\n      operationId: groupMembersDelete\n      parameters:\n        - $ref: '#/parameters/GroupId'\n        - $ref: '#/parameters/MemberId'\n      responses:\n        '204':\n          description: Group member deleted.\n        '404':\n          description: Group or Group member not found\n      summary: Delete a group member\n      tags:\n        - Groups\n  /im/groups:\n    get:\n      description: List IM groups under your account\n      operationId: imGroups\n      parameters: []\n      responses:\n        '200':\n          description: List of IM Groups returned.\n          schema:\n            $ref: '#/definitions/IMGroupList'\n      summary: List IM Groups\n      tags:\n        - IM Groups\n    post:\n      description: Create a IM Group under your account\n      operationId: imGroupCreate\n      parameters:\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              name:\n                description: 'Group name, must be unique in one account'\n                maxLength: 128\n                type: string\n              search_by_account:\n                description: Members can search others under same account\n                type: boolean\n              search_by_domain:\n                description: Members can search others in the same email domain\n                type: boolean\n              search_by_ma_account:\n                description: 'Members can search others under same master account, including all sub accounts'\n                type: boolean\n              type:\n                default: normal\n                description: IM Group type\n                enum:\n                  - normal\n                  - shared\n                  - restricted\n                type: string\n                x-enum-descriptions:\n                  - Only members can see the group automatically. Other people can search members in the group\n                  - All people in the account can see the group and members automatically\n                  - Nobody can see the group or search members except the members in the group\n      responses:\n        '201':\n          description: IM Group created.\n          headers:\n            Content-Location:\n              description: Location of created IM Group\n              type: string\n          schema:\n            properties:\n              id:\n                description: Group ID\n                type: string\n              name:\n                description: Group name\n                type: string\n              search_by_account:\n                description: Members can search others under same account.\n                type: boolean\n              search_by_domain:\n                description: Members can search others in the same email domain.\n                type: boolean\n              search_by_ma_account:\n                description: 'Members can search others under same master account, including all sub accounts.'\n                type: boolean\n              total_members:\n                description: Group member count\n                type: integer\n      summary: Create an IM Group\n      tags:\n        - IM Groups\n  '/im/groups/{groupId}':\n    delete:\n      description: Delete an IM Group under your account\n      operationId: imGroupDelete\n      parameters:\n        - $ref: '#/parameters/GroupId'\n      responses:\n        '204':\n          description: IM Group deleted.\n        '404':\n          description: IM Group not found\n      summary: Delete an IM Group\n      tags:\n        - IM Groups\n    get:\n      description: Retrieve an IM Group under your account\n      operationId: imGroup\n      parameters:\n        - $ref: '#/parameters/GroupId'\n      responses:\n        '200':\n          description: IM Group object returned\n          schema:\n            allOf:\n              - properties:\n                  id:\n                    description: Group ID\n                    type: string\n              - $ref: '#/definitions/IMGroup'\n        '404':\n          description: IM Group not found\n      summary: Retrieve an IM Group\n      tags:\n        - IM Groups\n    patch:\n      description: Update an IM Group under your account\n      operationId: imGroupUpdate\n      parameters:\n        - $ref: '#/parameters/GroupId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              name:\n                description: 'Group name, must be unique in one account'\n                maxLength: 128\n                type: string\n              search_by_account:\n                description: Members can search others under same account\n                type: boolean\n              search_by_domain:\n                description: Members can search others in the same email domain\n                type: boolean\n              search_by_ma_account:\n                description: 'Members can search others under same master account, including all sub accounts'\n                type: boolean\n              type:\n                description: IM Group type\n                enum:\n                  - normal\n                  - shared\n                  - restricted\n                type: string\n                x-enum-descriptions:\n                  - Only members can see the group automatically. Other people can search members in the group\n                  - All people in the account can see the group and members automatically\n                  - Nobody can see the group or search members except the members in the group\n      responses:\n        '204':\n          description: IM Group updated.\n        '404':\n          description: IM Group not found\n      summary: Update an IM Group\n      tags:\n        - IM Groups\n  '/im/groups/{groupId}/members':\n    get:\n      description: \"List an IM Group's members under your account\"\n      operationId: imGroupMembers\n      parameters:\n        - $ref: '#/parameters/GroupId'\n        - $ref: '#/parameters/PageSize'\n        - $ref: '#/parameters/PageNumber'\n      responses:\n        '200':\n          description: IM Group member list returned\n          schema:\n            $ref: '#/definitions/GroupMemberList'\n        '404':\n          description: IM Group not found\n      summary: \"List an IM Group's members\"\n      tags:\n        - IM Groups\n    post:\n      description: Add members to an IM Group under your account\n      operationId: imGroupMembersCreate\n      parameters:\n        - $ref: '#/parameters/GroupId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              members:\n                description: List of IM Group members\n                items:\n                  properties:\n                    email:\n                      description: 'User email. If ID given, email is ignored.'\n                      type: string\n                    id:\n                      description: User ID.\n                      type: string\n                maximum: 10\n                type: array\n      responses:\n        '201':\n          description: Member added.\n          schema:\n            properties:\n              added_at:\n                format: date-time\n                type: string\n              ids:\n                type: string\n        '404':\n          description: IM Group not found\n      summary: Add IM Group members\n      tags:\n        - IM Groups\n  '/im/groups/{groupId}/members/{memberId}':\n    delete:\n      description: Delete a member from an IM Group under your account\n      operationId: imGroupMembersDelete\n      parameters:\n        - $ref: '#/parameters/GroupId'\n        - $ref: '#/parameters/MemberId'\n      responses:\n        '204':\n          description: IM Group member deleted.\n        '404':\n          description: IM Group or IM Group member not found\n      summary: Delete an IM Group member\n      tags:\n        - IM Groups\n  '/meetings/{meetingId}':\n    delete:\n      description: Delete a meeting\n      operationId: meetingDelete\n      parameters:\n        - $ref: '#/parameters/MeetingId'\n        - $ref: '#/parameters/OccurrenceId'\n      responses:\n        '204':\n          description: Meeting deleted\n        '404':\n          description: Meeting not found\n      summary: Delete a meeting\n      tags:\n        - Meetings\n    get:\n      description: \"Retrieve a meeting's details\"\n      operationId: meeting\n      parameters:\n        - $ref: '#/parameters/MeetingId'\n      responses:\n        '200':\n          description: Meeting object returned\n          schema:\n            allOf:\n              - properties:\n                  host_id:\n                    description: ID of the user set as host of meeting\n                    type: string\n                  id:\n                    description: 'Meeting ID, also know as meeting number'\n                    type: string\n                  uuid:\n                    description: Meeting unique ID\n                    type: string\n                type: object\n              - $ref: '#/definitions/MeetingInfo'\n        '404':\n          description: Meeting not found\n      summary: Retrieve a meeting\n      tags:\n        - Meetings\n    patch:\n      description: \"Update a meeting's details\"\n      operationId: meetingUpdate\n      parameters:\n        - $ref: '#/parameters/MeetingId'\n        - description: Meeting\n          in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/MeetingUpdate'\n      responses:\n        '204':\n          description: Meeting Updated\n        '404':\n          description: Meeting not found\n      summary: Update a meeting\n      tags:\n        - Meetings\n  '/meetings/{meetingId}/recordings':\n    delete:\n      description: \"Delete a meeting's recordings\"\n      operationId: recordingDelete\n      parameters:\n        - $ref: '#/parameters/MeetingId4Recording'\n        - $ref: '#/parameters/RecordingDeleteAction'\n      responses:\n        '204':\n          description: Meeting recording deleted\n        '404':\n          description: Meeting recording not found\n      summary: \"Delete a meeting's recordings\"\n      tags:\n        - Cloud Recording\n    get:\n      description: Retrieve a meeting\u2019s all recordings\n      operationId: recordingGet\n      parameters:\n        - $ref: '#/parameters/MeetingId4Recording'\n      responses:\n        '200':\n          description: Recording object returned\n          schema:\n            allOf:\n              - $ref: '#/definitions/Recording'\n        '404':\n          description: Meeting recording not found\n      summary: Retrieve a meeting\u2019s all recordings\n      tags:\n        - Cloud Recording\n  '/meetings/{meetingId}/recordings/status':\n    put:\n      description: \"Recover a meeting's recordings\"\n      operationId: recordingStatusUpdate\n      parameters:\n        - $ref: '#/parameters/MeetingId4Recording'\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              action:\n                enum:\n                  - recover\n                type: string\n                x-enum-descriptions:\n                  - recover meeting recording\n      responses:\n        '204':\n          description: Meeting recording recover\n        '404':\n          description: Meeting recording not found\n      summary: \"Recover a meeting's recordings\"\n      tags:\n        - Cloud Recording\n  '/meetings/{meetingId}/recordings/{recordingId}':\n    delete:\n      description: Delete one meeting recording file\n      operationId: recordingDeleteOne\n      parameters:\n        - $ref: '#/parameters/MeetingId4Recording'\n        - $ref: '#/parameters/RecordingId'\n        - $ref: '#/parameters/RecordingDeleteAction'\n      responses:\n        '204':\n          description: Meeting recording file deleted\n        '404':\n          description: Meeting recording file not found\n      summary: Delete one meeting recording file\n      tags:\n        - Cloud Recording\n  '/meetings/{meetingId}/recordings/{recordingId}/status':\n    put:\n      description: Recover a meeting one recording\n      operationId: recordingStatusUpdateOne\n      parameters:\n        - $ref: '#/parameters/MeetingId4Recording'\n        - $ref: '#/parameters/RecordingId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              action:\n                enum:\n                  - recover\n                type: string\n                x-enum-descriptions:\n                  - recover meeting recording\n      responses:\n        '204':\n          description: Meeting recording recover\n        '404':\n          description: Meeting recording not found\n      summary: Recover a meeting one recording\n      tags:\n        - Cloud Recording\n  '/meetings/{meetingId}/registrants':\n    get:\n      description: List registrants of a meeting\n      operationId: meetingRegistrants\n      parameters:\n        - $ref: '#/parameters/MeetingId'\n        - $ref: '#/parameters/OccurrenceId'\n        - $ref: '#/parameters/RegistrantStatus'\n        - $ref: '#/parameters/PageSize'\n        - $ref: '#/parameters/PageNumber'\n      responses:\n        '200':\n          description: Success\n          schema:\n            $ref: '#/definitions/MeetingRegistrantList'\n        '404':\n          description: Meeting not found\n      summary: \"List a meeting's registrants\"\n      tags:\n        - Meetings\n    post:\n      description: Register a participant for a meeting\n      operationId: meetingRegistrantCreate\n      parameters:\n        - $ref: '#/parameters/MeetingId'\n        - description: 'Occurrence IDs, could get this value from Meeting Get API. Multiple value separated by comma.'\n          in: query\n          name: occurrence_ids\n          type: string\n        - in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/MeetingRegistrant'\n      responses:\n        '201':\n          description: Registration created\n          schema:\n            properties:\n              id:\n                description: Registrant ID\n                type: string\n              join_url:\n                description: Join URL for this registrant\n                type: string\n              registrant_id:\n                description: Registrant ID\n                type: string\n              start_time:\n                description: Start time\n                format: date-time\n                type: string\n              topic:\n                description: Topic\n                type: string\n            type: object\n        '404':\n          description: Meeting not found\n      summary: Add a meeting registrant\n      tags:\n        - Meetings\n  '/meetings/{meetingId}/registrants/status':\n    put:\n      description: \"Update a meeting registrant's status\"\n      operationId: meetingRegistrantStatus\n      parameters:\n        - $ref: '#/parameters/MeetingId'\n        - $ref: '#/parameters/OccurrenceId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            $ref: '#/definitions/RegistrantStatus'\n      responses:\n        '204':\n          description: Registrant status updated\n        '404':\n          description: Meeting or Registrant not found\n      summary: \"Update a meeting registrant's status\"\n      tags:\n        - Meetings\n  '/meetings/{meetingId}/status':\n    put:\n      description: \"Update a meeting's status\"\n      operationId: meetingStatus\n      parameters:\n        - $ref: '#/parameters/MeetingId'\n        - in: body\n          name: body\n          required: true\n          schema:\n            properties:\n              action:\n                enum:\n                  - end\n                type: string\n                x-enum-descriptions:\n                  - end a meeting\n      responses:\n        '204':\n          description: Meeting updated\n        '404':\n          description: Meeting not found\n      summary: \"Update a meeting's status\"\n      tags:\n        - Meetings\n  /metrics/crc:\n    get:\n      description: \"Get CRC Port usage hour by hour for a specified time period <aside class='notice'>We will report a maximum of one month. For example, if \"from\" is set to \"2017-08-05\" and \"to\" is \"2017-10-10\" we will adjust \"from\" to \"2017-09-10\"</aside>\"\n      operationId: dashboardCRC\n      parameters:\n        - $ref: '#/parameters/FromDate'\n        - $ref: '#/parameters/ToDate'\n      responses:\n        '200':\n          description: CRC Usage returned\n          schema:\n            allOf:\n              - properties:\n                  from:\n                    description: Start date for this report\n                    format: date\n                    type: string\n                  to:\n                    description: End date for this report\n                    format: date\n                    type: string\n              - properties:\n                  crc_ports_usage:\n                    items:\n                      properties:\n                        crc_ports_hour_usage:\n                          items:\n                            properties:\n                              hour:\n                                type: string\n                              max_usage:\n                                type: integer\n                              total_usage:\n                                type: integer\n                          type: array\n                        date_time:\n                          description: Date and time\n                          type: string\n                    type: array\n      summary: Retrieve CRC Port Usage\n      tags:\n        - Dashboards\n  /metrics/im:\n    get:\n      description: Retrieve metrics of Zoom IM\n      operationId: dashboardIM\n      parameters:\n        - $ref: '#/parameters/FromDate'\n        - $ref: '#/parameters/ToDate'\n        - $ref: '#/parameters/PageSize'\n        - $ref: '#/parameters/NextPageToken'\n      responses:\n        '200':\n          description: IM setails returned\n          schema:\n            allOf:\n              - properties:\n                  from:\n                    description: Start date for this report\n                    format: date\n                    type: string\n                  to:\n                    description: End date for this report\n                    format: date\n                    type: string\n              - $ref: '#/definitions/PaginationToken'\n              - properties:\n                  users:\n                    items:\n                      properties:\n                        calls_receive:\n                          type: integer\n                        calls_send:\n                          type: integer\n                        email:\n                          description: User email\n                          type: string\n                        emoji_receive:\n                          type: integer\n                        emoji_send:\n                          type: integer\n                        files_receive:\n                          type: integer\n                        files_send:\n                          type: integer\n                        group_receive:\n                          type: integer\n                        group_send:\n                          type: integer\n                        images_receive:\n                          type: integer\n                        images_send:\n                          type: integer\n                        total_receive:\n                          type: integer\n                        total_send:\n                          type: integer\n                        user_id:\n                          description: User ID\n                          type: string\n                        user_name:\n                          description: User display name\n                          type: string\n                        videos_receive:\n                          type: integer\n                        videos_send:\n                          type: integer\n                        voice_receive:\n                          type: integer\n                        voice_send:\n                          type: integer\n                    type: array\n      summary: Retrieve IM\n      tags:\n        - Dashboards\n  /metrics/meetings:\n    get:\n      description: List live meetings or past meetings for a specified period\n      operationId: dashboardMeetings\n      parameters:\n        - $ref: '#/parameters/MeetingTypePast'\n        - $ref: '#/parameters/FromDate'\n        - $ref: '#/parameters/ToDate'\n        - $ref: '#/parameters/PageSize'\n        - $ref: '#/parameters/NextPageToken'\n      responses:\n        '200':\n          description: Meetings Returned\n          schema:\n            allOf:\n              - properties:\n                  from:\n                    description: Start date for this report\n                    format: date\n                    type: string\n                  to:\n                    description: End date for this report\n                    format: date\n                    type: string\n              - $ref: '#/definitions/PaginationToken'\n              - properties:\n                  meetings:\n                    description: Array of meeting objects\n                    items:\n                      $ref: '#/definitions/MeetingMetric'\n                    type: array\n      summary: List meetings\n      tags:\n        - Dashboards\n  '/metrics/meetings/{meetingId}':\n    get:\n      description: Retrieve live or past meetings detail\n      operationId: dashboardMeetingDetail\n      parameters:\n        - $ref: '#/parameters/MeetingId4Metrics'\n        - $ref: '#/parameters/MeetingTypePast3'\n      responses:\n        '200':\n          description: Meeting Returned\n          schema:\n            $ref: '#/definitions/MeetingMetric'\n      summary: Retrieve meeting detail\n      tags:\n        - Dashboards\n  '/metrics/meetings/{meetingId}/participants':\n    get:\n      description: Retrieve live or past meetings participants\n      operationId: dashboardMeetingParticipants\n      parameters:\n        - $ref: '#/parameters/MeetingId4Metrics'\n        - $ref: '#/parameters/MeetingTypePast3'\n        - $ref: '#/parameters/PageSize'\n        - $ref: '#/parameters/NextPageToken'\n      responses:\n        '200':\n          description: Meeting Participants Returned\n          schema:\n            allOf:\n              - $ref: '#/definitions/PaginationToken'\n              - properties:\n                  participants:\n                    description: Array of user objects\n                    items:\n                      properties:\n                        device:\n                          description: Participant device\n                          type: string\n                        domain:\n                          description: Participant domain\n                          type: string\n                        harddisk_id:\n                          description: Participant hard disk id\n                          type: string\n                        id:\n                          description: Participant UUID\n                          format: uuid\n                          type: string\n                        ip_address:\n                          description: Participant IP Address\n                          type: string\n                        join_time:\n                          description: Participant join time\n                          format: date-time\n                          type: string\n                        leave_time:\n                          description: Participant leave time\n                          format: date-time\n                          type: string\n                        location:\n                          description: Participant location\n                          type: string\n                        mac_addr:\n                          description: Participant MAC Address\n                          type: string\n                        network_type:\n                          description: Participant network type\n                          type: string\n                        pc_name:\n                          description: Participant PC name\n                          type: string\n                        recording:\n                          description: Participant record\n                          type: boolean\n                        share_application:\n                          description: Did participant share application\n                          type: boolean\n                        share_desktop:\n                          description: Did participant share desktop\n                          type: boolean\n                        share_whiteboard:\n                          description: Did participant share whiteboard\n                          type: boolean\n                        user_id:\n                          description: Participant ID\n                          format: uuid\n                          type: string\n                        user_name:\n                          description: Participant display name\n                          type: string\n                        version:\n                          description: Participant version\n                          type: string\n                    type: array\n      summary: Retrieve meeting participants\n      tags:\n        - Dashboards\n  '/metrics/meetings/{meetingId}/participants/qos':\n    get:\n      description: Retrieve list of live or past meetings participants quality of service\n      operationId: dashboardMeetingParticipantsQOS\n      parameters:\n        - $ref: '#/parameters/MeetingId4Metrics'\n        - $ref: '#/parameters/MeetingTypePast2'\n        - $ref: '#/parameters/PageSize4Qos'\n        - $ref: '#/parameters/NextPageToken'\n      responses:\n        '200':\n          description: Meeting Participants Returned\n          schema:\n            $ref: '#/definitions/QOSParticipantList'\n      summary: List meeting participants QOS\n      tags:\n        - Dashboards\n  '/metrics/meetings/{meetingId}/participants/sharing':\n    get:\n      description: Retrieve sharing/recording details of live or past meetings participant\n      operationId: dashboardMeetingParticipantShare\n      parameters:\n        - $ref: '#/parameters/MeetingId4Metrics'\n        - $ref: '#/parameters/MeetingTypePast2'\n        - $ref: '#/parameters/PageSize'\n        - $ref: '#/parameters/PageToken'\n      responses:\n        '200':\n          description: Meeting Participants Returned\n          schema:\n            allOf:\n              - $ref: '#/definitions/PaginationToken'\n              - properties:\n                  participants:\n                    description: Array of participants\n                    items:\n                      properties:\n                        details:\n                          description: Array of sharing and recording details\n                          items:\n                            properties:\n                              content:\n                                description: Type of content shared\n                                type: string\n                              end_time:\n                                description: End time of sharing\n