swagger: '2.0'
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Agent Assistants Web Deployments API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
host: api.mypurecloud.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Web Deployments
  description: Web Deployments
  externalDocs:
    description: Web Deployments Documentation
    url: https://developer.genesys.cloud/commdigital/digital/webchat/webdeployments-apis
paths:
  /api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}:
    get:
      tags:
      - Web Deployments
      summary: Retrieves a cobrowse session
      description: ''
      operationId: getWebdeploymentsDeploymentCobrowseSessionId
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: WebMessaging deployment ID
        required: true
        type: string
      - name: sessionId
        in: path
        description: Cobrowse session id or join code
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/CobrowseWebMessagingSession'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      x-purecloud-method-name: getWebdeploymentsDeploymentCobrowseSessionId
    delete:
      tags:
      - Web Deployments
      summary: Deletes a cobrowse session
      description: ''
      operationId: deleteWebdeploymentsDeploymentCobrowseSessionId
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: WebMessaging deployment ID
        required: true
        type: string
      - name: sessionId
        in: path
        description: Cobrowse session id or join code
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Empty'
        '204':
          description: No Content
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      x-purecloud-method-name: deleteWebdeploymentsDeploymentCobrowseSessionId
  /api/v2/webdeployments/token/refresh:
    post:
      tags:
      - Web Deployments
      summary: Refresh a JWT.
      description: ''
      operationId: postWebdeploymentsTokenRefresh
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/WebDeploymentsRefreshJWTRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SignedData'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            parameters.missing: Parameters are missing
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      x-purecloud-method-name: postWebdeploymentsTokenRefresh
  /api/v2/webdeployments/token/oauthcodegrantjwtexchange:
    post:
      tags:
      - Web Deployments
      summary: Exchange an oAuth code (obtained using the Authorization Code Flow or Implicit flow) for a JWT that can be used by webdeployments.
      description: ''
      operationId: postWebdeploymentsTokenOauthcodegrantjwtexchange
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: webDeploymentsOAuthExchangeRequest
        required: true
        schema:
          $ref: '#/definitions/WebDeploymentsOAuthExchangeRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentsAuthorizationResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            parameters.missing: Parameters are missing
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      x-purecloud-method-name: postWebdeploymentsTokenOauthcodegrantjwtexchange
  /api/v2/webdeployments/configurations/{configurationId}:
    delete:
      tags:
      - Web Deployments
      summary: Delete all versions of a configuration
      description: ''
      operationId: deleteWebdeploymentsConfiguration
      produces:
      - application/json
      parameters:
      - name: configurationId
        in: path
        description: The configuration version ID
        required: true
        type: string
      responses:
        '204':
          description: The configuration versions were deleted successfully
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            illegal.operation: Unable to perform the requested operation
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
            resource.conflict: Resource is used by another
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:configuration:delete
      x-purecloud-method-name: deleteWebdeploymentsConfiguration
  /api/v2/webdeployments/configurations:
    get:
      tags:
      - Web Deployments
      summary: View configuration drafts
      description: ''
      operationId: getWebdeploymentsConfigurations
      produces:
      - application/json
      parameters:
      - name: pageSize
        in: query
        description: Number of entities to return. Defaults to 300.
        required: false
        type: string
      - name: before
        in: query
        description: The cursor that points to the start of the set of entities that has been returned.
        required: false
        type: string
      - name: after
        in: query
        description: The cursor that points to the end of the set of entities that has been returned.
        required: false
        type: string
      - name: showOnlyPublished
        in: query
        description: Filter by published status.
        required: false
        type: boolean
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentConfigurationVersionEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
        - webdeployments:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:configuration:view
      x-purecloud-method-name: getWebdeploymentsConfigurations
    post:
      tags:
      - Web Deployments
      summary: Create a configuration draft
      description: ''
      operationId: postWebdeploymentsConfigurations
      produces:
      - application/json
      parameters:
      - in: body
        name: configurationVersion
        required: true
        schema:
          $ref: '#/definitions/WebDeploymentConfigurationVersion'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentConfigurationVersion'
        '201':
          description: The configuration version draft was created successfully
          schema:
            $ref: '#/definitions/WebDeploymentConfigurationVersion'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            resource.limit.exceeded: The maximum number of resources has been exceeded
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:configuration:add
      x-purecloud-method-name: postWebdeploymentsConfigurations
  /api/v2/webdeployments/configurations/{configurationId}/versions:
    get:
      tags:
      - Web Deployments
      summary: Get the versions of a configuration
      description: ''
      operationId: getWebdeploymentsConfigurationVersions
      produces:
      - application/json
      parameters:
      - name: configurationId
        in: path
        description: The configuration version ID
        required: true
        type: string
      - name: pageSize
        in: query
        description: Number of entities to return. Defaults to 300.
        required: false
        type: string
      - name: before
        in: query
        description: The cursor that points to the start of the set of entities that has been returned.
        required: false
        type: string
      - name: after
        in: query
        description: The cursor that points to the end of the set of entities that has been returned.
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentConfigurationVersionEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
        - webdeployments:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:configuration:view
      x-purecloud-method-name: getWebdeploymentsConfigurationVersions
  /api/v2/webdeployments/configurations/{configurationId}/versions/{versionId}:
    get:
      tags:
      - Web Deployments
      summary: Get a configuration version
      description: ''
      operationId: getWebdeploymentsConfigurationVersion
      produces:
      - application/json
      parameters:
      - name: configurationId
        in: path
        description: The configuration version ID
        required: true
        type: string
      - name: versionId
        in: path
        description: The version of the configuration to get
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentConfigurationVersion'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
        - webdeployments:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:configuration:view
      x-purecloud-method-name: getWebdeploymentsConfigurationVersion
  /api/v2/webdeployments/configurations/{configurationId}/versions/draft:
    get:
      tags:
      - Web Deployments
      summary: Get the configuration draft
      description: ''
      operationId: getWebdeploymentsConfigurationVersionsDraft
      produces:
      - application/json
      parameters:
      - name: configurationId
        in: path
        description: The configuration version ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentConfigurationVersion'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
        - webdeployments:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:configuration:view
      x-purecloud-method-name: getWebdeploymentsConfigurationVersionsDraft
    put:
      tags:
      - Web Deployments
      summary: Update the configuration draft
      description: ''
      operationId: putWebdeploymentsConfigurationVersionsDraft
      produces:
      - application/json
      parameters:
      - name: configurationId
        in: path
        description: The configuration version ID
        required: true
        type: string
      - in: body
        name: configurationVersion
        required: true
        schema:
          $ref: '#/definitions/WebDeploymentConfigurationVersion'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentConfigurationVersion'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:configuration:edit
      x-purecloud-method-name: putWebdeploymentsConfigurationVersionsDraft
  /api/v2/webdeployments/configurations/{configurationId}/versions/draft/publish:
    post:
      tags:
      - Web Deployments
      summary: Publish the configuration draft and create a new version
      description: ''
      operationId: postWebdeploymentsConfigurationVersionsDraftPublish
      produces:
      - application/json
      parameters:
      - name: configurationId
        in: path
        description: The configuration version ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentConfigurationVersion'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:configuration:edit
        - webDeployments:configuration:add
      x-purecloud-method-name: postWebdeploymentsConfigurationVersionsDraftPublish
  /api/v2/webdeployments/deployments/{deploymentId}/identityresolution:
    get:
      tags:
      - Web Deployments
      summary: Get a deployment identity resolution setting.
      description: ''
      operationId: getWebdeploymentsDeploymentIdentityresolution
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The deployment ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DeploymentIdentityResolutionConfig'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
        - webdeployments:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:deployment:view
        - webDeployments:identityResolution:view
      x-purecloud-method-name: getWebdeploymentsDeploymentIdentityresolution
    put:
      tags:
      - Web Deployments
      summary: Update identity resolution settings for a deployment.
      description: ''
      operationId: putWebdeploymentsDeploymentIdentityresolution
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The deployment ID
        required: true
        type: string
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DeploymentIdentityResolutionConfig'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DeploymentIdentityResolutionConfig'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            general.bad.request: The request could not be understood by the server due to malformed syntax.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
            access.denied.to.field: You are not authorized to view one or more of the referenced entities.
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
        '422':
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.failed: The configuration you specified is invalid.
      security:
      - PureCloud OAuth:
        - webdeployments
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:deployment:edit
        - webDeployments:identityResolution:edit
      x-purecloud-method-name: putWebdeploymentsDeploymentIdentityresolution
  /api/v2/webdeployments/deployments/{deploymentId}:
    get:
      tags:
      - Web Deployments
      summary: Get a deployment
      description: ''
      operationId: getWebdeploymentsDeployment
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The deployment ID
        required: true
        type: string
      - name: expand
        in: query
        description: 'The specified entity attributes will be filled. Comma separated values expected. '
        required: false
        type: array
        items:
          type: string
          enum:
          - supportedContent
          - flowDetails
        collectionFormat: multi
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeployment'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
        - webdeployments:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:deployment:view
      x-purecloud-method-name: getWebdeploymentsDeployment
    put:
      tags:
      - Web Deployments
      summary: Update a deployment
      description: ''
      operationId: putWebdeploymentsDeployment
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The deployment ID
        required: true
        type: string
      - in: body
        name: deployment
        required: true
        schema:
          $ref: '#/definitions/WebDeployment'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeployment'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            bad.flow.id: The flow is not eligible for use here.
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            scp.id.not.found: The Supported Content Profile ID is not found
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:deployment:edit
      x-purecloud-method-name: putWebdeploymentsDeployment
    delete:
      tags:
      - Web Deployments
      summary: Delete a deployment
      description: ''
      operationId: deleteWebdeploymentsDeployment
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The deployment ID
        required: true
        type: string
      responses:
        '204':
          description: The deployment was deleted successfully
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            illegal.operation: Unable to perform the requested operation
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:deployment:delete
      x-purecloud-method-name: deleteWebdeploymentsDeployment
  /api/v2/webdeployments/deployments/{deploymentId}/configurations:
    get:
      tags:
      - Web Deployments
      summary: Get active configuration for a given deployment
      description: ''
      operationId: getWebdeploymentsDeploymentConfigurations
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The deployment ID
        required: true
        type: string
      - name: type
        in: query
        description: Get active configuration on a deployment
        required: false
        type: string
      - name: expand
        in: query
        description: Expand instructions for the return value
        required: false
        type: array
        items:
          type: string
          enum:
          - supportedContent
        collectionFormat: multi
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeploymentActiveConfigurationOnDeployment'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
        - webdeployments:readonly
      x-purecloud-method-name: getWebdeploymentsDeploymentConfigurations
  /api/v2/webdeployments/token/revoke:
    delete:
      tags:
      - Web Deployments
      summary: Invalidate JWT
      description: ''
      operationId: deleteWebdeploymentsTokenRevoke
      produces:
      - application/json
      parameters:
      - name: X-Journey-Session-Id
        in: header
        description: The Customer's journey sessionId.
        required: false
        type: string
      - name: X-Journey-Session-Type
        in: header
        description: The Customer's journey session type.
        required: false
        type: string
      responses:
        '204':
          description: "Revoke any tokens associate with the JWT. \nIf the JWT is expired the refresh endpoint should be called to obtain a valid JWT and this endpoint called again."
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            credentials.expired: The credentials have expired.
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            parameters.missing: The parameters were missing.
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - Webmessaging JWT: []
      x-purecloud-method-name: deleteWebdeploymentsTokenRevoke
  /api/v2/webdeployments/deployments:
    get:
      tags:
      - Web Deployments
      summary: Get deployments
      description: ''
      operationId: getWebdeploymentsDeployments
      produces:
      - application/json
      parameters:
      - name: pageSize
        in: query
        description: Number of entities to return. Defaults to 300.
        required: false
        type: string
      - name: before
        in: query
        description: The cursor that points to the start of the set of entities that has been returned.
        required: false
        type: string
      - name: after
        in: query
        description: The cursor that points to the end of the set of entities that has been returned.
        required: false
        type: string
      - name: expand
        in: query
        description: 'The specified entity attributes will be filled. Comma separated values expected. '
        required: false
        type: array
        items:
          type: string
          enum:
          - Configuration
          - SupportedContent
          - identityresolution
        collectionFormat: multi
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ExpandableWebDeploymentEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
        - webdeployments:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:deployment:view
      x-purecloud-method-name: getWebdeploymentsDeployments
    post:
      tags:
      - Web Deployments
      summary: Create a deployment
      description: ''
      operationId: postWebdeploymentsDeployments
      produces:
      - application/json
      parameters:
      - in: body
        name: deployment
        required: true
        schema:
          $ref: '#/definitions/WebDeployment'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/WebDeployment'
        '201':
          description: The deployment was created successfully
          schema:
            $ref: '#/definitions/WebDeployment'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            resource.limit.exceeded: The maximum number of resources has been exceeded
            invalid.property: Value [%s] is not a valid property for object [%s]
            illegal.operation: Unable to perform the requested operation
            bad.flow.id: The flow is not eligible for use here.
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            scp.id.not.found: The Supported Content Profile ID is not found
            not.found: The requested resource was not found.
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - webdeployments
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - webDeployments:deployment:add
      x-purecloud-method-name: postWebdeploymentsDeployments
definitions:
  Team:
    type: object
    required:
    - name
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The team name
      division:
        description: The division to which this entity belongs.
        $ref: '#/definitions/WritableDivision'
      description:
        type: string
        description: Team information.
      dateCreated:
        type: string
        format: date-time
        description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateModified:
        type: string
        format: date-time
        description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      memberCount:
        type: integer
        format: int64
        description: Number of members in a team
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  NluInfo:
    type: object
    properties:
      domain:
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      version:
        readOnly: true
        $ref: '#/definitions/NluDomainVersion'
      intents:
        type: array
        items:
          $ref: '#/definitions/Intent'
      engineVersion:
        type: string
      nluData:
        $ref: '#/definitions/NluDomainVersion'
  NluDomain:
    type: object
    required:
    - name
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The name of the NLU domain.
      language:
        type: string
        description: The language culture of the NLU domain, e.g. `en-us`, `de-de`.
      draftVersion:
        description: The draft version of that NLU domain.
        readOnly: true
        $ref: '#/definitions/NluDomainVersionReference'
      lastPublishedVersion:
        description: The last published version of that NLU domain.
        readOnly: true
        $ref: '#/definitions/NluDomainVersionReference'
      dateCreated:
        type: string
        format: date-time
        description: 'The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateModified:
        type: string
        format: date-time
        description: 'The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      engineVersion:
        type: string
        description: The version of the NLU engine to use.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  WorkPlanBidRanks:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the user.
      workPlanBiddingPerformance:
        type: integer
        format: int32
        description: Work plan bidding agent performance ranking. The range of values is between 0 and 9999.
      biddingTieBreaker:
        type: string
        description: Custom agent ranking metric that some customers can use.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  AddressableEntityRef:
    type: object
    properties:
      id:
        type: string
      selfUri:
        type: string
        format: uri
  NluDomainVersion:
    type: object
    required:
    - language
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      domain:
        description: The NLU domain of the version.
        readOnly: true
        $ref: '#/definitions/NluDomain'
      description:
        type: string
        description: The description of the NLU domain version.
      language:
        type: string
        description: The language that the NLU domain version supports.
      published:
        type: boolean
        description: Whether this NLU domain version has been published.
        readOnly: true
      dateCreated:
        type: string
        format: date-time
        description: 'The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateModified:
        type: string
        format: date-time
        description: 'The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateTrained:
        type: string
        format: date-time
        description: 'The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      datePublished:
        type: string
        format: date-time
        description: 'The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      trainingStatus:
        type: string
        description: The training status of the NLU domain version.
        readOnly: true
        enum:
        - Untrained
        - Training
        - Trained
        - Error
        - Unknown
      evaluationStatus:
        type: string
        description: The evaluation status of the NLU domain version.
        readOnly: true
        enum:
        - Unevaluated
        - Evaluating
        - Evaluated
        - Error
      intents:
        type: array
        description: The intents defined for this NLU domain version.
        items:
          $ref: '#/definitions/IntentDefinition'
      entityTypes:
        type: array
        description: The entity types defined for this NLU domain version.
        items:
          $ref: '#/definitions/NamedEntityTypeDefinition'
      entities:
        type: array
        description: The entities defined for this NLU domain version.This field is mutually exclusive with entityTypeBindings
        items:
          $ref: '#/definitions/NamedEntityDefinition'
      languageVersions:
        type: object
        description: Map of language code to NLU domain version UUID for multilingual domains.
        readOnly: true
        additionalProperties:
          type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  JsonSchemaDocument:
    type: object
    properties:
      id:
        type: string
      $schema:
        type: string
      title:
        type: string
      description:
        type: string
      type:
        type: string
      required:
        type: array
        items:
          type: string
      properties:
        type: object
        additionalProperties:
          type: object
      additionalProperties:
        type: object
    description: A JSON Schema document.
  MessengerStyles:
    type: object
    properties:
      primaryColor:
        type: string
        example: '#a7017c'
        description: The primary color of messenger in hexadecimal
  SupportCenterModuleSetting:
    type: object
    required:
    - enabled
    - type
    properties:
      type:
        type: string
        description: Screen module type
        enum:
        - Search
        - Categories
        - FAQ
        - Contact
        - Results
        - Article
        - TopViewedArticles
      enabled:
        type: boolean
        description: Whether or not knowledge portal (previously support center) screen module is enabled
      compactCategoryModuleTemplate:
        description: Compact category module template
        $ref: '#/definitions/SupportCenterCompactCategoryModuleTemplate'
      detailedCategoryModuleTemplate:
        description: Detailed category module template
        $ref: '#/definitions/SupportCenterDetailedCategoryModuleTemplate'
  BotMessengerProfile:
    type: object
    properties:
      name:
        type: string
        description: Name of the Bot
      avatarUrl:
        type: string
        description: Avatar for Bot
  ResourcePermissionPolicy:
    type: object
    properties:
      id:
        type: string
      domain:
        type: string
      entityName:
        type: string
      policyName:
        type: string
      policyDescription:
        type: string
      actionSetKey:
        type: string
      allowConditions:
        type: boolean
      resourceConditionNode:
        $ref: '#/definitions/ResourceConditionNode'
      namedResources:
        type: array
        items:
          type: string
      resourceCondition:
        type: string
      actionSet:
        type: array
        uniqueItems: true
        items:
          type: string
  WritableDivision:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
      name:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Knowledge:
    type: object
    properties:
      enabled:
        type: boolean
        description: whether or not knowledge base is enabled
      knowledgeBase:
        description: The knowledge base for messenger
        $ref: '#/definitions/AddressableEntityRef'
  WebDeployment:
    type: object
    required:
    - configuration
    - name
    properties:
      id:
        type: string
        description: The deployment ID
        readOnly: true
      name:
        type: string
        description: The deployment name
      description:
        type: string
        description: The description of the config
      allowAllDomains:
        type: boolean
        description: Property indicates whether all domains are allowed or not. allowedDomains must be empty when this is set as true.
      allowedDomains:
        type: array
        description: The list of domains that are approved to use this deployment; the list will be added to CORS headers for ease of web use.
        items:
          type: string
      supportedContent:
        description: The supported content profile for a deployment
        $ref: '#/definitions/SupportedContentReference'
      snippet:
        type: string
        description: Javascript snippet used to load the config
        readOnly: true
      dateCreated:
        type: string
        format: date-time
        description: 'The date the deployment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateModified:
        type: string
        format: date-time
        description: 'The date the deployment was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      lastModifiedUser:
        description: A reference to the user who most recently modified the deployment
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      flow:
        description: A reference to the inboundshortmessage flow used by this deployment
        $ref: '#/definitions/WebDeploymentFlowEntityRef'
      status:
        type: string
        description: The current status of the deployment
        enum:
        - Pending
        - Active
        - Inactive
        - Error
        - Deleting
      pushIntegrations:
        type: array
        description: The push integration objects associated with the deployment
        items:
          $ref: '#/definitions/PushIntegration'
      configuration:
        description: The config version this deployment uses
        $ref: '#/definitions/WebDeploymentConfigurationVersionEntityRef'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Details about a Web Deployment
  WebDeploymentConfigurationVersionResponse:
    type: object
    required:
    - name
    properties:
      id:
        type: string
        description: The configuration version ID
      name:
        type: string
        description: The configuration version name
      version:
        type: string
        example: DRAFT, 1, 2
        description: The version of the configuration
      headlessMode:
        description: Headless Mode Support which Controls UI components. When enabled, native UI components will be disabled and allows for custom-built UI.
        $ref: '#/definitions/WebDeploymentHeadlessMode'
      description:
        type: string
        description: The description of the configuration
      languages:
        type: array
        example: en-us, de-de
        description: A list of languages supported on the configuration required if the messenger is enabled
        items:
          type: string
      defaultLanguage:
        type: string
        example: en-us, de-de
        description: The default language to use for the configuration required if the messenger is enabled
      customI18nLabels:
        type: array
        description: The localization settings for homescreen app
        items:
          $ref: '#/definitions/CustomI18nLabels'
      messenger:
        description: The settings for messenger
        $ref: '#/definitions/MessengerSettings'
      position:
        description: The settings for position
        $ref: '#/definitions/PositionSettings'
      supportCenter:
        description: The settings for knowledge portal (previously support center)
        $ref: '#/definitions/SupportCenterSettings'
      cobrowse:
        description: The settings for cobrowse
        $ref: '#/definitions/CobrowseSettings'
      journeyEvents:
        description: The settings for journey events
        $ref: '#/definitions/JourneyEventsSettings'
      authenticationSettings:
        description: The settings for authenticated deployments
        $ref: '#/definitions/AuthenticationSettings'
      video:
        description: The settings for video
        $ref: '#/definitions/VideoSettings'
      dateCreated:
        type: string
        format: date-time
        description: 'The date the configuration version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateModified:
        type: string
        format: date-time
        description: 'The date the configuration version was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      datePublished:
        type: string
        format: date-time
        description: 'The date the configuration version was most recently published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      lastModifiedUser:
        description: A reference to the user who most recently modified the configuration version
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      createdUser:
        description: A reference to the user who created the configuration version
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      publishedUser:
        description: A reference to the user who published the configuration version
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      status:
        type: string
        description: The current status of the configuration version
        enum:
        - Pending
        - Active
        - Inactive
        - Error
        - Deleting
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Details about the configuration version of a Web Deployment
  UserStations:
    type: object
    properties:
      associatedStation:
        description: Current associated station for this user.
        readOnly: true
        $ref: '#/definitions/UserStation'
      effectiveStation:
        description: The station where the user can be reached based on their default and associated station.
        readOnly: true
        $ref: '#/definitions/UserStation'
      defaultStation:
        description: Default station to be used if not associated with a station.
        readOnly: true
        $ref: '#/definitions/UserStation'
      lastAssociatedStation:
        description: Last associated station for this user.
        readOnly: true
        $ref: '#/definitions/UserStation'
  AdditionalLanguagesSynonyms:
    type: object
    properties:
      synonyms:
        type: array
        description: Synonyms for additional language
        readOnly: true
        items:
          type: string
  OAuthLastTokenIssued:
    type: object
    properties:
      dateIssued:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  MediaSummary:
    type: object
    properties:
      contactCenter:
        $ref: '#/definitions/MediaSummaryDetail'
      enterprise:
        $ref: '#/definitions/MediaSummaryDetail'
  LocationAddressVerificationDetails:
    type: object
    properties:
      status:
        type: string
        description: Status of address verification process
        enum:
        - Pending
        - InProgress
        - Retry
        - Complete
        - Failed
      dateFinished:
        type: string
        format: date-time
        description: 'Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateStarted:
        type: string
        format: date-time
        description: 'Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      service:
        type: string
        example: smartystreets-us
        description: Third party service used for address verification
  IdleEventTrigger:
    type: object
    required:
    - eventName
    properties:
      eventName:
        type: string
        description: Name of event triggered after period of inactivity.
      idleAfterSeconds:
        type: integer
        format: int64
        description: Number of seconds of inactivity before an event is triggered.
    description: Details about an idle event trigger
  MediaTypes:
    type: object
    properties:
      allow:
        description: Specify allowed media types for inbound and outbound messages. If this field is empty, all inbound and outbound media will be blocked.
        $ref: '#/definitions/MediaTypeAccess'
    description: Media types
  Markdown:
    type: object
    properties:
      enabled:
        type: boolean
        description: whether or not markdown is enabled
  IpFilter:
    type: object
    properties:
      ipAddress:
        type: string
        description: IP address or CIDR range to filter (e.g. '192.168.1.0/24').
      name:
        type: string
        description: Descriptive name for the IP address filter.
    description: Configuration for filtering tracking based on IP addresses.
  NluUtterance:
    type: object
    required:
    - segments
    properties:
      id:
        type: string
        description: ID of the utterance.
        readOnly: true
      source:
        type: string
        description: The source of the utterance.
        enum:
        - Generated
        - User
      segments:
        type: array
        description: The list of segments that that constitute this utterance for the given intent.
        items:
          $ref: '#/definitions/NluUtteranceSegment'
  MediaTypeAccess:
    type: object
    properties:
      inbound:
        type: array
        description: List of media types allowed for inbound messages from customers. If inbound messages from a customer contain media that is not in this list, the media will be dropped from the outbound message.
        items:
          $ref: '#/definitions/MediaType'
      outbound:
        type: array
        description: List of media types allowed for outbound messages to customers. If an outbound message is sent that contains media that is not in this list, the message will not be sent.
        items:
          $ref: '#/definitions/MediaType'
    description: Media type access definitions
  Geolocation:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      type:
        type: string
        description: A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc.
      primary:
        type: boolean
        description: A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH
      latitude:
        type: number
        format: double
      longitude:
        type: number
        format: double
      country:
        type: string
      region:
        type: string
      city:
        type: string
      locations:
        type: array
        items:
          $ref: '#/definitions/LocationDefinition'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  VideoSettings:
    type: object
    properties:
      enabled:
        type: boolean
        description: whether or not video is enabled
      channels:
        type: array
        description: The channels on which video chat is available
        items:
          type: string
          enum:
          - Webmessaging
          - Voice
      agent:
        description: Video Settings for agent
        $ref: '#/definitions/AgentVideoSettings'
      user:
        description: Video Settings for user
        $ref: '#/definitions/UserVideoSettings'
    description: The settings to enable video chat
  WebDeploymentsJourneyContext:
    type: object
    properties:
      journeyAction:
        description: A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context)
        $ref: '#/definitions/JourneyAction'
      customer:
        description: 'Journey customer information. Used for linking the authenticated customer with the journey. '
        $ref: '#/definitions/JourneyCustomer'
      customerSession:
        description: Contains the Journey System's customer session details.
        $ref: '#/definitions/JourneyCustomerSession'
  AutoStart:
    type: object
    properties:
      enabled:
        type: boolean
        description: whether or not auto start is enabled
  AuthenticationSettings:
    type: object
    required:
    - enabled
    - integrationId
    properties:
      enabled:
        type: boolean
        description: Indicate if these auth is required for this deployment. If, for example, this flag is set to true then webmessaging sessions can not send messages unless the end-user is authenticated.
      integrationId:
        type: string
        description: The integration identifier which contains the auth settings required on the deployment.
      allowSessionUpgrade:
        type: boolean
        description: Allow end-users to upgrade an anonymous session to authenticated conversation.
    description: Settings for authenticated webdeployments.
  SupportCenterSettings:
    type: object
    required:
    - enabled
    - enabledCategories
    - knowledgeBase
    - screens
    - styleSetting
    properties:
      enabled:
        type: boolean
        description: Whether or not knowledge portal (previously support center) is enabled
      knowledgeBase:
        description: The knowledge base for knowledge portal (previously support center)
        $ref: '#/definitions/AddressableEntityRef'
      customMessages:
        type: array
        description: Customizable display texts for knowledge portal (previously support center)
        items:
          $ref: '#/definitions/SupportCenterCustomMessage'
      routerType:
        type: string
        description: Router type for knowledge portal (previously support center)
        enum:
        - Hash
        - Browser
      screens:
        type: array
        description: Available screens for the knowledge portal (previously support center) with its modules
        items:
          $ref: '#/definitions/SupportCenterScreen'
      enabledCategories:
        type: array
        description: Featured categories for knowledge portal (previously support center) home screen
        items:
          $ref: '#/definitions/SupportCenterCategory'
      labelFilter:
        description: Document label filter. If set, only documents having at least one of the specified labels will be returned by knowledge document query operations.
        $ref: '#/definitions/SupportCenterLabelFilter'
      styleSetting:
        description: Style attributes for knowledge portal (previously support center)
        $ref: '#/definitions/SupportCenterStyleSetting'
      feedback:
        description: Customer feedback settings
        $ref: '#/definitions/SupportCenterFeedbackSettings'
    description: Settings concerning knowledge portal (previously support center)
  Humanize:
    type: object
    properties:
      enabled:
        type: boolean
        description: Whether or not humanize conversations setting is enabled
      bot:
        description: Bot messenger profile setting
        $ref: '#/definitions/BotMessengerProfile'
  SupportCenterFeedbackSettings:
    type: object
    required:
    - enabled
    properties:
      enabled:
        type: boolean
        description: Whether or not requesting customer feedback on article content and article search results is enabled
  UserRoutingLanguage:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      proficiency:
        type: number
        format: double
        description: A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings.
      state:
        type: string
        description: Activate or deactivate this routing language.
        enum:
        - active
        - inactive
        - deleted
      languageUri:
        type: string
        format: uri
        description: URI to the organization language used by this user language.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
  SupportCenterCompactCategoryModuleTemplate:
    type: object
    required:
    - active
    properties:
      active:
        type: boolean
        description: Whether this template is active or not
  WebDeploymentsOAuthRequestParameters:
    type: object
    required:
    - redirectUri
    properties:
      code:
        type: string
        description: "The authorization code to be sent to the authentication server during the token request.\n Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"
      idToken:
        type: string
        description: "The implicit id_token to be sent to the authentication server during the token request.\n Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"
      redirectUri:
        type: string
        description: Redirect URI sent in the "Authentication Request"Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
      nonce:
        type: string
        description: Required if provided in the "Authentication Request". Otherwise should be empty.String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified from the Authentication Request to the ID Token. Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
      maxAge:
        type: integer
        format: int32
        description: Required if provided in the  "Authentication Request". Otherwise should be empty.Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated.Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
      codeVerifier:
        type: string
        description: Required if authorizing using Proof Key for Code Exchange (PKCE). Otherwise should be empty.Random URL-safe string with a minimum length of 43 characters generated at start of authorization flow to mitigate the threat of having the authorization code intercepted. Refer to https://datatracker.ietf.org/doc/html/rfc7636
      iss:
        type: string
        description: 'Optional parameter. Set it if authorization server discovery metadata authorization_response_iss_parameter_supported is enabled.

          Refer to https://datatracker.ietf.org/doc/html/rfc9207'
  SupportCenterCategory:
    type: object
    properties:
      id:
        type: string
        pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
      selfUri:
        type: string
        format: uri
      image:
        description: Image attributes for a featured category
        $ref: '#/definitions/SupportCenterImage'
  WebDeploymentsAuthorizationResponse:
    type: object
    properties:
      refreshToken:
        type: string
        description: Refresh token used to issue a new JWT.
      jwt:
        type: string
  SupportCenterGlobalStyle:
    type: object
    required:
    - backgroundColor
    - fontFamily
    - primaryColor
    - primaryColorDark
    - primaryColorLight
    - textColor
    properties:
      backgroundColor:
        type: string
        description: 'Global background color, in hexadecimal format, eg #ffffff'
        pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
      primaryColor:
        type: string
        description: 'Global primary color, in hexadecimal format, eg #ffffff'
        pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
      primaryColorDark:
        type: string
        description: 'Global dark primary color, in hexadecimal format, eg #ffffff'
        pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
      primaryColorLight:
        type: string
        description: 'Global light primary color, in hexadecimal format, eg #ffffff'
        pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
      textColor:
        type: string
        description: 'Global text color, in hexadecimal format, eg #ffffff'
        pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
      fontFamily:
        type: string
        description: Global font family
  User:
    type: object
    required:
    - version
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      division:
        description: The division to which this entity belongs.
        $ref: '#/definitions/Division'
      chat:
        $ref: '#/definitions/Chat'
      department:
        type: string
      email:
        type: string
      primaryContactInfo:
        type: array
        description: Auto populated from addresses.
        readOnly: true
        items:
          $ref: '#/definitions/Contact'
      addresses:
        type: array
        description: Email addresses and phone numbers for this user
        items:
          $ref: '#/definitions/Contact'
      state:
        type: string
        description: The current state for this user.
        readOnly: true
        enum:
        - active
        - inactive
        - deleted
      title:
        type: string
      username:
        type: string
      manager:
        $ref: '#/definitions/User'
      images:
        type: array
        items:
          $ref: '#/definitions/Image'
      version:
        type: integer
        format: int32
        description: Required when updating a user, this value should be the current version of the user.  The current version can be obtained with a GET on the user before doing a PATCH.
      certifications:
        type: array
        items:
          type: string
      biography:
        $ref: '#/definitions/Biography'
      employerInfo:
        $ref: '#/definitions/EmployerInfo'
      preferredName:
        type: string
        description: Preferred full name of the agent
      routingStatus:
        description: ACD routing status
        readOnly: true
        $ref: '#/definitions/RoutingStatus'
      presence:
        description: Active presence
        readOnly: true
        $ref: '#/definitions/UserPresence'
      integrationPresence:
        description: Integration presence
        readOnly: true
        $ref: '#/definitions/UserPresence'
      conversationSummary:
        description: Summary of conversion statistics for conversation types.
        readOnly: true
        $ref: '#/definitions/UserConversationSummary'
      outOfOffice:
        description: Determine if out of office is enabled
        readOnly: true
        $ref: '#/definitions/OutOfOffice'
      geolocation:
        description: Current geolocation position
        readOnly: true
        $ref: '#/definitions/Geolocation'
      station:
        description: Effective, default, and last station information
        readOnly: true
        $ref: '#/definitions/UserStations'
      authorization:
        description: Roles and permissions assigned to the user
        readOnly: true
        $ref: '#/definitions/UserAuthorization'
      profileSkills:
        type: array
        description: Profile skills possessed by the user
        readOnly: true
        items:
          type: string
      locations:
        type: array
        description: The user placement at each site location.
        readOnly: true
        items:
          $ref: '#/definitions/Location'
      groups:
        type: array
        description: The groups the user is a member of
        readOnly: true
        items:
          $ref: '#/definitions/Group'
      team:
        description: The team the user is a member of
        readOnly: true
        $ref: '#/definitions/Team'
      workPlanBidRanks:
        description: The WFM work plan bid rank settings for the user
        readOnly: true
        $ref: '#/definitions/WorkPlanBidRanks'
      skills:
        type: array
        description: Routing (ACD) skills possessed by the user
        readOnly: true
        items:
          $ref: '#/definitions/UserRoutingSkill'
      languages:
        type: array
        description: Routing (ACD) languages possessed by the user
        readOnly: true
        items:
          $ref: '#/definitions/UserRoutingLanguage'
      acdAutoAnswer:
        type: boolean
        description: acd auto answer
      languagePreference:
        type: string
        description: preferred language by the user
        readOnly: true
      lastTokenIssued:
        $ref: '#/definitions/OAuthLastTokenIssued'
      dateLastLogin:
        type: string
        format: date-time
        description: 'The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateWelcomeSent:
        type: string
        format: date-time
        description: 'The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  MediaSummaryDetail:
    type: object
    properties:
      active:
        type: integer
        format: int32
      acw:
        type: integer
        format: int32
  NamedEntityTypeItem:
    type: object
    required:
    - value
    properties:
      value:
        type: string
        description: A value for an named entity type definition.
      synonyms:
        type: array
        description: Synonyms for the given named entity value.
        items:
          type: string
      additionalLanguages:
        type: object
        description: Additional Language Synonyms for the given named entity value.
        additionalProperties:
          $ref: '#/definitions/AdditionalLanguagesSynonyms'
  SupportCenterLabelFilter:
    type: object
    properties:
      labels:
        type: array
        description: Labels to filter by.
        items:
          $ref: '#/definitions/AddressableEntityRef'
  Biography:
    type: object
    properties:
      biography:
        type: string
        description: Personal detailed description
      interests:
        type: array
        items:
          type: string
      hobbies:
        type: array
        items:
          type: string
      spouse:
        type: string
      education:
        type: array
        description: User education details
        items:
          $ref: '#/definitions/Education'
  SupportedContentReference:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The SupportedContent unique identifier associated with this integration or phone number
      name:
        type: string
        description: The SupportedContent profile name
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The SupportedContent profile URI
        readOnly: true
      mediaTypes:
        description: Media types definition for the supported content
        readOnly: true
        $ref: '#/definitions/MediaTypes'
  ResourceConditionNode:
    type: object
    properties:
      variableName:
        type: string
      conjunction:
        type: string
        enum:
        - AND
        - OR
      operator:
        type: string
        enum:
        - EQ
        - IN
        - GE
        - GT
        - LE
        - LT
      operands:
        type: array
        items:
          $ref: '#/definitions/ResourceConditionValue'
      terms:
        type: array
        items:
          $ref: '#/definitions/ResourceConditionNode'
  SupportCenterDetailedCategoryModuleSidebar:
    type: object
    required:
    - enabled
    properties:
      enabled:
        type: boolean
        description: Whether sidebar is enabled or not
  SelectorEventTrigger:
    type: object
    required:
    - eventName
    - selector
    properties:
      selector:
        type: string
        description: Element that triggers event.
      eventName:
        type: string
        description: Name of event triggered when element matching selector is interacted with.
    description: Details about a selector event trigger
  NamedEntityDefinition:
    type: object
    required:
    - name
    - type
    properties:
      name:
        type: string
        description: The name of the entity.
      type:
        type: string
        description: The name of the entity type.
  PushIntegration:
    type: object
    properties:
      id:
        type: string
        description: The mobile push integration id associated with the deployment
      provider:
        type: string
        description: The integration provider associated with the deployment
        enum:
        - APNS
        - FCM
  JourneyAction:
    type: object
    required:
    - actionMap
    - id
    properties:
      id:
        type: string
        description: The ID of an action from the Journey System (an action is spawned from an actionMap)
      actionMap:
        description: Details about the action map from the Journey System which triggered this action
        $ref: '#/definitions/JourneyActionMap'
  SupportCenterScreen:
    type: object
    required:
    - moduleSettings
    - type
    properties:
      type:
        type: string
        description: The type of the screen
        enum:
        - Home
        - Category
        - SearchResults
        - Article
      moduleSettings:
        type: array
        description: 'Module settings for the screen, valid modules for each screenType: Home: Search, Categories, TopViewedArticles; Category: Search, Categories; SearchResults: Search, Results; Article: Search, Article;'
        items:
          $ref: '#/definitions/SupportCenterModuleSetting'
  MessengerApps:
    type: object
    properties:
      conversations:
        description: The conversation settings that handles chats within the messenger
        $ref: '#/definitions/ConversationAppSettings'
      knowledge:
        description: The knowledge base config for messenger
        $ref: '#/definitions/Knowledge'
    description: The apps embedded in the messenger
  SupportCenterImage:
    type: object
    required:
    - source
    properties:
      source:
        description: Source URLs for image
        $ref: '#/definitions/SupportCenterImageSource'
  SupportCenterCustomMessage:
    type: object
    required:
    - defaultValue
    - type
    properties:
      defaultValue:
        type: string
        description: Default value for the message
        minLength: 0
        maxLength: 300
      type:
        type: string
        description: Type of the message
        enum:
        - Welcome
        - Fallback
  ConversationClearSettings:
    type: object
    properties:
      enabled:
        type: boolean
        description: whether or not conversation clear setting is enabled
  DomainEntityRef:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      selfUri:
        type: string
        format: uri
  Empty:
    type: object
  ExpandableWebDeployment:
    type: object
    required:
    - configuration
    - name
    properties:
      id:
        type: string
        description: The deployment ID
        readOnly: true
      name:
        type: string
        description: The deployment name
      description:
        type: string
        description: The description of the config
      allowAllDomains:
        type: boolean
        description: Property indicates whether all domains are allowed or not. allowedDomains must be empty when this is set as true.
      allowedDomains:
        type: array
        description: The list of domains that are approved to use this deployment; the list will be added to CORS headers for ease of web use.
        items:
          type: string
      supportedContent:
        description: The supported content profile for a deployment
        $ref: '#/definitions/SupportedContentReference'
      snippet:
        type: string
        description: Javascript snippet used to load the config
        readOnly: true
      dateCreated:
        type: string
        format: date-time
        description: 'The date the deployment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateModified:
        type: string
        format: date-time
        description: 'The date the deployment was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      lastModifiedUser:
        description: A reference to the user who most recently modified the deployment
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      flow:
        description: A reference to the inboundshortmessage flow used by this deployment
        $ref: '#/definitions/WebDeploymentFlowEntityRef'
      status:
        type: string
        description: The current status of the deployment
        enum:
        - Pending
        - Active
        - Inactive
        - Error
        - Deleting
      pushIntegrations:
        type: array
        description: The push integration objects associated with the deployment
        items:
          $ref: '#/definitions/PushIntegration'
      configuration:
        description: The config version this deployment uses
        $ref: '#/definitions/WebDeploymentConfigurationVersionResponse'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Details about a Web Deployment
  DomainRole:
    type: object
    properties:
      id:
        type: string
        description: The ID of the role
      name:
        type: string
        description: The name of the role
  WebDeploymentConfigurationVersionEntityRef:
    type: object
    required:
    - id
    - version
    properties:
      id:
        type: string
        description: The configuration version ID
      name:
        type: string
        description: The configuration version name
      selfUri:
        type: string
        format: uri
      version:
        type: string
        example: DRAFT, 1, 2
        description: The version of the configuration
  JourneyCustomer:
    type: object
    required:
    - id
    - idType
    properties:
      id:
        type: string
        description: An ID of a customer within the Journey System at a point-in-time.  Note that a customer entity can have multiple customerIds based on the stitching process.  Depending on the context within the PureCloud conversation, this may or may not be mutable.
      idType:
        type: string
        description: The type of the customerId within the Journey System (e.g. cookie).
  UserRoutingSkill:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      proficiency:
        type: number
        format: double
        description: A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When "Best available skills" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings.
      state:
        type: string
        description: Activate or deactivate this routing skill.
        enum:
        - active
        - inactive
        - deleted
      skillUri:
        type: string
        format: uri
        description: URI to the organization skill used by this user skill.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
  WebDeploymentHeadlessMode:
    type: object
    properties:
      enabled:
        type: boolean
        description: Whether or not Headless Mode is enabled
  DeploymentIdentityResolutionConfig:
    type: object
    required:
    - resolveIdentities
    properties:
      division:
        description: The division to use when performing identity resolution.
        $ref: '#/definitions/WritableStarrableDivision'
      resolveIdentities:
        type: boolean
        description: Whether the channel should resolve identities
      externalSource:
        description: The external source used for stitching this channel.
        $ref: '#/definitions/IdentityResolutionExternalSource'
      automerge:
        description: Whether automerging of contacts should be enabled for each channel.
        $ref: '#/definitions/IdentityResolutionAutomergeConfig'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  PresenceDefinition:
    type: object
    properties:
      id:
        type: string
        description: description
      systemPresence:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  BackgroundImageSettings:
    type: object
    properties:
      url:
        type: string
        description: BackgroundImage URL for agent video settings
    description: The settings to Agent Video background image
  Detail:
    type: object
    properties:
      errorCode:
        type: string
      fieldName:
        type: string
      entityId:
        type: string
      entityName:
        type: string
  MessengerSettings:
    type: object
    properties:
      enabled:
        type: boolean
        description: Whether or not messenger is enabled
      styles:
        description: The style settings for messenger
        $ref: '#/definitions/MessengerStyles'
      launcherButton:
        description: The launcher button settings for messenger
        $ref: '#/definitions/LauncherButtonSettings'
      fileUpload:
        description: The file upload settings for messenger
        $ref: '#/definitions/FileUploadSettings'
      apps:
        description: The apps embedded in the messenger
        $ref: '#/definitions/MessengerApps'
      homeScreen:
        description: The homescreen settings for messenger
        $ref: '#/definitions/MessengerHomeScreen'
      sessionPersistenceType:
        type: string
        description: The session persistence type for messenger
        enum:
        - AcrossSubdomains
        - DomainOrSubdomainOnly
    description: Settings concerning messenger
  FileUploadMode:
    type: object
    properties:
      fileTypes:
        type: array
        description: A list of supported content types for uploading files.
        items:
          type: string
          enum:
          - image/jpeg
          - image/gif
          - image/png
      maxFileSizeKB:
        type: integer
        format: int64
        description: The maximum file size for file uploads in kilobytes. Default is 10240 (10 MB)
  SupportCenterStyleSetting:
    type: object
    required:
    - globalStyle
    - heroStyle
    properties:
      heroStyle:
        description: Knowledge portal (previously support center) hero customizations
        $ref: '#/definitions/SupportCenterHeroStyle'
      globalStyle:
        description: Knowledge portal (previously support center) global customizations
        $ref: '#/definitions/SupportCenterGlobalStyle'
  UserAuthorization:
    type: object
    properties:
      roles:
        type: array
        items:
          $ref: '#/definitions/DomainRole'
      unusedRoles:
        type: array
        description: A collection of the roles the user is not using
        readOnly: true
        items:
          $ref: '#/definitions/DomainRole'
      permissions:
        type: array
        description: A collection of the permissions granted by all assigned roles
        readOnly: true
        items:
          type: string
      permissionPolicies:
        type: array
        description: The policies configured for assigned permissions.
        readOnly: true
        items:
          $ref: '#/definitions/ResourcePermissionPolicy'
  CobrowseWebMessagingSession:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      joinCode:
        type: string
        description: Cobrowse session join code
        readOnly: true
      websocketUrl:
        type: string
        description: WebSocket URL for the JS client
        readOnly: true
      dateOfferEnds:
        type: string
        format: date-time
        description: 'Date when Cobrowse Offer Expires. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      communicationType:
        type: string
        description: CommunicationType for Cobrowse Session
        readOnly: true
        enum:
        - Call
        - Message
        - Unknown
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  NamedEntityTypeMechanismExample:
    type: object
    required:
    - resolvedValue
    - text
    properties:
      text:
        type: string
        description: Example input text
      resolvedValue:
        type: string
        description: Resolved entity value
  OutOfOffice:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      user:
        $ref: '#/definitions/User'
      startDate:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      endDate:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      active:
        type: boolean
      indefinite:
        type: boolean
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  UserPresence:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      source:
        type: string
        description: Deprecated - The sourceID field should be used as a replacement.
      sourceId:
        type: string
        description: Represents the ID of a registered source
      primary:
        type: boolean
        description: A boolean used to tell whether or not to set this presence source as the primary on a PATCH
      presenceDefinition:
        $ref: '#/definitions/PresenceDefinition'
      futurePresenceDefinition:
        description: The definition of the user's desired future presence
        readOnly: true
        $ref: '#/definitions/PresenceDefinition'
      message:
        type: string
      modifiedDate:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  LocationEmergencyNumber:
    type: object
    properties:
      e164:
        type: string
      number:
        type: string
      type:
        type: string
        description: The type of emergency number.
        enum:
        - default
        - elin
  ConversationAppSettings:
    type: object
    properties:
      enabled:
        type: boolean
        description: The toggle to enable or disable conversations
      showAgentTypingIndicator:
        type: boolean
        description: The toggle to enable or disable typing indicator for messenger
      showUserTypingIndicator:
        type: boolean
        description: The toggle to enable or disable typing indicator for messenger
      autoStart:
        description: The auto start for the messenger conversation
        $ref: '#/definitions/AutoStart'
      markdown:
        description: The markdown for the messenger app
        $ref: '#/definitions/Markdown'
      conversationDisconnect:
        description: The conversation disconnect settings for the messenger app
        $ref: '#/definitions/ConversationDisconnectSettings'
      conversationClear:
        description: The conversation clear settings for the messenger app
        $ref: '#/definitions/ConversationClearSettings'
      humanize:
        description: The humanize conversations settings for the messenger app
        $ref: '#/definitions/Humanize'
      notifications:
        description: The notification settings for messenger apps
        $ref: '#/definitions/NotificationsSettings'
      sessionDurationSeconds:
        type: integer
        format: int32
        description: The guest session duration settings for messenger conversations
    description: Conversation settings that handles chats within the messenger
  NamedEntityTypeDefinition:
    type: object
    required:
    - mechanism
    - name
    properties:
      name:
        type: string
        description: The name of the entity type.
      description:
        type: string
        description: Description of the of the named entity type.
      mechanism:
        description: The mechanism enabling detection of the named entity type.
        $ref: '#/definitions/NamedEntityTypeMechanism'
  MessengerHomeScreen:
    type: object
    properties:
      enabled:
        type: boolean
        description: whether or not homescreen is enabled
      logoUrl:
        type: string
        description: to capture uploaded company logoUrl
  EmployerInfo:
    type: object
    properties:
      officialName:
        type: string
      employeeId:
        type: string
      employeeType:
        type: string
      dateHire:
        type: string
  RoutingStatus:
    type: object
    properties:
      userId:
        type: string
        description: The userId of the agent
      status:
        type: string
        description: Indicates the Routing State of the agent.  A value of OFF_QUEUE will be returned if the specified user does not exist.
        enum:
        - OFF_QUEUE
        - IDLE
        - INTERACTING
        - NOT_RESPONDING
        - COMMUNICATING
      startTime:
        type: string
        format: date-time
        description: 'The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  SupportCenterDetailedCategoryModuleTemplate:
    type: object
    required:
    - active
    - sidebar
    properties:
      active:
        type: boolean
        description: Whether this template is active or not
      sidebar:
        description: Sidebar settings for the template
        $ref: '#/definitions/SupportCenterDetailedCategoryModuleSidebar'
  ResourceConditionValue:
    type: object
    properties:
      type:
        type: string
        enum:
        - SCALAR
        - VARIABLE
        - USER
        - QUEUE
        - TEAM
      value:
        type: string
  NamedEntityTypeMechanism:
    type: object
    required:
    - items
    - type
    properties:
      items:
        type: array
        description: The items that define the named entity type.
        items:
          $ref: '#/definitions/NamedEntityTypeItem'
      restricted:
        type: boolean
        description: 'Whether the named entity type is restricted to the items provided. Default: false'
      type:
        type: string
        description: The type of the mechanism.
        enum:
        - AI
        - DynamicDateTime
        - DynamicList
        - List
        - Regex
        - Unknown
      subType:
        type: string
        description: Subtype of detection mechanism
        enum:
        - Alphanumeric
        - NumberSequence
        - FreeForm
      maxLength:
        type: integer
        format: int32
        description: The maximum length of the entity resolved value
      minLength:
        type: integer
        format: int32
        description: The minimum length of the entity resolved value
      allowSpecialChars:
        type: boolean
        description: Flag whether to allow for special characters during AI slot capture
      examples:
        type: array
        description: Examples for entity detection
        items:
          $ref: '#/definitions/NamedEntityTypeMechanismExample'
  SignedData:
    type: object
    properties:
      jwt:
        type: string
  LocalizedLabels:
    type: object
    properties:
      key:
        type: string
        description: Contains localized label key used in messenger homescreen and push notification. PushNotificationTitle and PushNotificationBody keys are required when notifications are enabled.
        enum:
        - MessengerHomeHeaderTitle
        - MessengerHomeHeaderSubTitle
        - PushNotificationTitle
        - PushNotificationBody
        - MessengerLauncherButtonText
      value:
        type: string
        description: Contains localized label value used in messenger homescreen and push notification
    description: Contains localized labels used in messenger apps
  Limit:
    type: object
    properties:
      key:
        type: string
      namespace:
        type: string
        enum:
        - web.deployments
        - web.messaging
        - agent.assistant
        - agentic.virtual.agents
        - analytics.agents
        - analytics.alerting
        - analytics.data.extraction
        - analytics
        - analytics.realtime
        - analytics.reporting.settings
        - anomaly.detection
        - architect
        - audiohook
        - audiohook.monitor
        - audit
        - auth.api
        - authorization
        - automation.testing
        - bots
        - bots.voice
        - business.rules
        - callback
        - case.management
        - cobrowse
        - content.management
        - conversation
        - copilot
        - dataactions
        - datatables
        - directory
        - dsar
        - email
        - employee.engagement
        - event.orchestration
        - external.contacts
        - external.events.data.ingestion
        - gamification
        - gcv
        - gdpr
        - groups
        - guides
        - historical.adherence
        - infrastructureascode
        - integrations
        - intent.miner
        - internal.messaging
        - journey
        - knowledge
        - language.understanding
        - learning
        - limit.registry
        - marketplace
        - mcp.analytics.aggregates
        - mcp
        - media.communications
        - messaging
        - micro.frontend
        - multi.org
        - notifications
        - onboarding
        - outbound
        - platform.api
        - predictive.routing
        - presence
        - quality
        - recording
        - response.management
        - routing
        - scim
        - screen.monitoring
        - search
        - secondary.automation.testing
        - skills
        - social.media
        - speech.and.text.analytics
        - speech.integration
        - supportability
        - task.management
        - telephony.configuration
        - usage
        - users
        - users.rules
        - voice.transcription
        - webchat
        - webhooks
        - workforce.management.adherence
        - workforce.management.agent.availability
        - workforce.management.forecast
        - workforce.management
        - workforce.management.scheduling.preferences
        - workforce.management.self.schedule
        - workforce.management.shift.trading
        - system
      value:
        type: integer
        format: int64
  NotificationsSettings:
    type: object
    properties:
      enabled:
        type: boolean
        description: The toggle to enable or disable notifications. When enabled, PushNotificationTitle and PushNotificationBody localization keys are required.
      notificationContentType:
        type: string
        description: The notification content type settings for messenger
        enum:
        - IncludeMessagesContent
        - ExcludeMessagesContent
    description: Notification settings that handles messenger notifications
  IntentReference:
    type: object
    required:
    - name
    properties:
      id:
        type: string
        description: ID of the intent.
        readOnly: true
      name:
        type: string
        description: The name of the intent.
  Chat:
    type: object
    properties:
      jabberId:
        type: string
  WebDeploymentConfigurationVersion:
    type: object
    required:
    - name
    properties:
      id:
        type: string
        description: The configuration version ID
        readOnly: true
      name:
        type: string
        description: The configuration version name
      version:
        type: string
        example: DRAFT, 1, 2
        description: The version of the configuration
        readOnly: true
      headlessMode:
        description: Headless Mode Support which Controls UI components. When enabled, native UI components will be disabled and allows for custom-built UI.
        $ref: '#/definitions/WebDeploymentHeadlessMode'
      description:
        type: string
        description: The description of the configuration
      languages:
        type: array
        example: en-us, de-de
        description: A list of languages supported on the configuration required if the messenger is enabled
        items:
          type: string
      defaultLanguage:
        type: string
        example: en-us, de-de
        description: The default language to use for the configuration required if the messenger is enabled
      customI18nLabels:
        type: array
        description: The localization settings for homescreen app
        items:
          $ref: '#/definitions/CustomI18nLabels'
      messenger:
        description: The settings for messenger
        $ref: '#/definitions/MessengerSettings'
      position:
        description: The settings for position
        $ref: '#/definitions/PositionSettings'
      supportCenter:
        description: The settings for knowledge portal (previously support center)
        $ref: '#/definitions/SupportCenterSettings'
      cobrowse:
        description: The settings for cobrowse
        $ref: '#/definitions/CobrowseSettings'
      journeyEvents:
        description: The settings for journey events
        $ref: '#/definitions/JourneyEventsSettings'
      authenticationSettings:
        description: The settings for authenticated deployments
        $ref: '#/definitions/AuthenticationSettings'
      video:
        description: The settings for video
        $ref: '#/definitions/VideoSettings'
      dateCreated:
        type: string
        format: date-time
        description: 'The date the configuration version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateModified:
        type: string
        format: date-time
        description: 'The date the configuration version was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      datePublished:
        type: string
        format: date-time
        description: 'The date the configuration version was most recently published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      lastModifiedUser:
        description: A reference to the user who most recently modified the configuration version
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      createdUser:
        description: A reference to the user who created the configuration version
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      publishedUser:
        description: A reference to the user who published the configuration version
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      status:
        type: string
        description: The current status of the configuration version
        enum:
        - Pending
        - Active
        - Inactive
        - Error
        - Deleting
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Details about the configuration version of a Web Deployment
  GroupContact:
    type: object
    required:
    - address
    - mediaType
    - type
    properties:
      address:
        type: string
        description: Phone number for this contact type
      extension:
        type: string
        description: Extension is set if the number is e164 valid
      display:
        type: string
        description: Formatted version of the address property
        readOnly: true
      type:
        type: string
        description: Contact type of the address
        enum:
        - GROUPRING
        - GROUPPHONE
      mediaType:
        type: string
        description: Media type of the address
        enum:
        - PHONE
  WebDeploymentFlowEntityRef:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The Flow ID
      name:
        type: string
        description: The Flow name
      selfUri:
        type: string
        format: uri
      flowDescription:
        type: string
        description: The flow description for the webdeployment
      publishVersion:
        description: The published config version for the associated deployment
        $ref: '#/definitions/FlowVersion'
  PauseCriteria:
    type: object
    properties:
      urlFragment:
        type: string
      condition:
        type: string
        enum:
        - Includes
        - DoesNotInclude
        - StartsWith
        - EndsWith
        - Equals
  SupportCenterImageSource:
    type: object
    required:
    - defaultUrl
    properties:
      defaultUrl:
        type: string
        description: Default URL for image
  Contact:
    type: object
    properties:
      address:
        type: string
        description: Email address or phone number for this contact type
      display:
        type: string
        description: Formatted version of the address property
        readOnly: true
      mediaType:
        type: string
        enum:
        - PHONE
        - EMAIL
        - SMS
      type:
        type: string
        enum:
        - PRIMARY
        - WORK
        - WORK2
        - WORK3
        - WORK4
        - HOME
        - MOBILE
        - MAIN
        - OTHER
      extension:
        type: string
        description: Use internal extension instead of address. Mutually exclusive with the address field.
      countryCode:
        type: string
      integration:
        type: string
        example: microsoftteams
        description: Integration tag value if this number is associated with an external integration.
  LocationDefinition:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      contactUser:
        description: Site contact for the location entity
        $ref: '#/definitions/AddressableEntityRef'
      emergencyNumber:
        description: Emergency number for the location entity
        $ref: '#/definitions/LocationEmergencyNumber'
      address:
        $ref: '#/definitions/LocationAddress'
      state:
        type: string
        description: Current state of the location entity
        enum:
        - active
        - deleted
      notes:
        type: string
        description: Notes for the location entity
      version:
        type: integer
        format: int32
        description: Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response
      path:
        type: array
        description: A list of ancestor IDs in order
        readOnly: true
        items:
          type: string
      profileImage:
        type: array
        description: Profile image of the location entity, retrieved with ?expand=images query parameter
        readOnly: true
        items:
          $ref: '#/definitions/LocationImage'
      floorplanImage:
        type: array
        description: Floorplan images of the location entity, retrieved with ?expand=images query parameter
        readOnly: true
        items:
          $ref: '#/definitions/LocationImage'
      addressVerificationDetails:
        description: Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter
        readOnly: true
        $ref: '#/definitions/LocationAddressVerificationDetails'
      addressVerified:
        type: boolean
        description: Boolean field which states if the address has been verified as an actual address
        readOnly: true
      addressStored:
        type: boolean
        description: Boolean field which states if the address has been stored for E911
        readOnly: true
      images:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ScrollPercentageEventTrigger:
    type: object
    required:
    - eventName
    - percentage
    properties:
      percentage:
        type: integer
        format: int32
        description: Percentage of a webpage at which an event is triggered.
      eventName:
        type: string
        description: Name of event triggered after scrolling to the specified percentage.
    description: Details about a scroll percentage event trigger
  NamedEntityTypeBinding:
    type: object
    required:
    - entityName
    - entityType
    properties:
      entityType:
        type: string
        description: The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType.
      entityName:
        type: string
        description: The name that this named entity type is bound to.
  UserConversationSummary:
    type: object
    properties:
      userId:
        type: string
      call:
        $ref: '#/definitions/MediaSummary'
      callback:
        $ref: '#/definitions/MediaSummary'
      email:
        $ref: '#/definitions/MediaSummary'
      message:
        $ref: '#/definitions/MediaSummary'
      chat:
        $ref: '#/definitions/MediaSummary'
      socialExpression:
        $ref: '#/definitions/MediaSummary'
      video:
        $ref: '#/definitions/MediaSummary'
  Image:
    type: object
    properties:
      resolution:
        type: string
        description: 'Height and/or width of image. ex: 640x480 or x128'
      imageUri:
        type: string
  Education:
    type: object
    properties:
      school:
        type: string
      fieldOfStudy:
        type: string
      notes:
        type: string
        description: Notes about education has a 2000 character limit
      dateStart:
        type: string
        format: date
        description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd'
      dateEnd:
        type: string
        format: date
        description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd'
  PositionSettings:
    type: object
    properties:
      alignment:
        type: string
        description: The alignment for position
        enum:
        - Auto
        - Left
        - Right
      sideSpace:
        type: integer
        format: int32
        description: The sidespace value for position
      bottomSpace:
        type: integer
        format: int32
        description: The bottomspace value for position
    description: Settings concerning position
  UserVideoSettings:
    type: object
    properties:
      allowCamera:
        type: boolean
        description: whether or not user camera is allowed
      allowScreenShare:
        type: boolean
        description: whether or not user screen share is allowed
      allowMicrophone:
        type: boolean
        description: whether or not user microphone is allowed
    description: The settings for User Video
  FormsTrackTrigger:
    type: object
    required:
    - captureDataOnFormAbandon
    - captureDataOnFormSubmit
    - formName
    - selector
    properties:
      selector:
        type: string
        description: Form element that triggers the form submitted or abandoned event.
      formName:
        type: string
        description: Prefix for the form submitted or abandoned event name.
      captureDataOnFormAbandon:
        type: boolean
        description: Whether to capture the form data in the form abandoned event.
      captureDataOnFormSubmit:
        type: boolean
        description: Whether to capture the form data in the form submitted event.
    description: Details about a forms tracking event trigger
  ExpandableWebDeploymentEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ExpandableWebDeployment'
      nextUri:
        type: string
      selfUri:
        type: string
      previousUri:
        type: string
      total:
        type: integer
        format: int64
  FlowVersion:
    type: object
    properties:
      id:
        type: string
        description: The flow version identifier
      name:
        type: string
      commitVersion:
        type: string
      configurationVersion:
        type: string
      type:
        type: string
        enum:
        - PUBLISH
        - CHECKIN
        - SAVE
      secure:
        type: boolean
      debug:
        type: boolean
      createdBy:
        $ref: '#/definitions/User'
      createdByClient:
        $ref: '#/definitions/DomainEntityRef'
      configurationUri:
        type: string
      dateCreated:
        type: integer
        format: int64
      dateCheckedIn:
        type: integer
        format: int64
      dateSaved:
        type: integer
        format: int64
      generationId:
        type: string
      publishResultUri:
        type: string
        format: uri
      inputSchema:
        $ref: '#/definitions/JsonSchemaDocument'
      outputSchema:
        $ref: '#/definitions/JsonSchemaDocument'
      virtualAgentEnabled:
        type: boolean
        description: Indicates whether virtual agent is enabled for this flow.
      datePublished:
        type: string
        format: date-time
        description: 'The date this version became the published version of the flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      datePublishedEnd:
        type: string
        format: date-time
        description: 'The date this version was no longer the published version of the flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      nluInfo:
        description: Information about the natural language understanding configuration for the flow version
        readOnly: true
        $ref: '#/definitions/NluInfo'
      supportedLanguages:
        type: array
        description: List of supported languages for this version of the flow
        readOnly: true
        items:
          $ref: '#/definitions/SupportedLanguage'
      compatibleFlowTypes:
        type: array
        description: Compatible flow types designate which flow types are allowed to embed a flow’s configuration within their own flow configuration.  Currently the only flows that can be embedded are Common Module flows and the embedding flow can invoke them using the Call Common Module action.
        readOnly: true
        items:
          type: string
          enum:
          - BOT
          - COMMONMODULE
          - DIGITALBOT
          - EMAILSEND
          - INBOUNDCALL
          - INBOUNDCHAT
          - INBOUNDEMAIL
          - INBOUNDSHORTMESSAGE
          - INQUEUECALL
          - INQUEUEEMAIL
          - INQUEUESHORTMESSAGE
          - OUTBOUNDCALL
          - SECURECALL
          - SPEECH
          - SURVEYINVITE
          - VOICE
          - VOICEMAIL
          - VOICESURVEY
          - WORKFLOW
          - WORKITEM
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  NluUtteranceSegment:
    type: object
    required:
    - text
    properties:
      text:
        type: string
        description: The text of the segment.
      entity:
        description: The entity annotation of the segment.
        $ref: '#/definitions/NamedEntityAnnotation'
  ErrorBody:
    type: object
    properties:
      message:
        type: string
      code:
        type: string
      status:
        type: integer
        format: int32
      entityId:
        type: string
      entityName:
        type: string
      messageWithParams:
        type: string
      messageParams:
        type: object
        additionalProperties:
          type: string
      contextId:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/Detail'
      errors:
        type: array
        items:
          $ref: '#/definitions/ErrorBody'
      limit:
        $ref: '#/definitions/Limit'
  LocationImage:
    type: object
    properties:
      resolution:
        type: string
        description: 'Height and/or width of image. ex: 640x480 or x128'
      imageUri:
        type: string
  Division:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  SupportCenterHeroStyle:
    type: object
    required:
    - backgroundColor
    - textColor
    properties:
      backgroundColor:
        type: string
        description: 'Background color for hero section, in hexadecimal format, eg #ffffff'
        pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
      textColor:
        type: string
        description: 'Text color for hero section, in hexadecimal format, eg #ffffff'
        pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
      image:
        description: Background image for hero section
        $ref: '#/definitions/SupportCenterImage'
  TrackingSettings:
    type: object
    properties:
      excludedQueryParameters:
        type: array
        description: List of parameters to be excluded from the query string.
        items:
          type: string
      shouldKeepUrlFragment:
        type: boolean
        description: Whether or not to keep the URL fragment.
      searchQueryParameters:
        type: array
        description: List of query parameters used for search (e.g. 'query').
        items:
          type: string
      ipFilters:
        type: array
        description: IP address filtering configuration for tracking restrictions.
        items:
          $ref: '#/definitions/IpFilter'
    description: Settings that control how tracking data is collected and filtered.
  IdentityResolutionAutomergeConfig:
    type: object
    properties:
      authenticatedWebMessaging:
        type: boolean
        description: Whether automerging is enabled for Authenticated Webmessaging conversations in this channel.
      webTracking:
        type: boolean
        description: Whether automerging is enabled for Web Tracking sessions in this channel.
  Icon:
    type: object
    properties:
      url:
        type: string
        description: Icon URL for the launcher button
    description: The icon for the launcher button
  CustomI18nLabels:
    type: object
    properties:
      language:
        type: string
        description: Language of localized labels in homescreen app (eg. en-us, de-de) and push notification
      localizedLabels:
        type: array
        description: Contains localized labels used in messenger apps and push notification. PushNotificationTitle and PushNotificationBody are required when notifications are enabled.
        items:
          $ref: '#/definitions/LocalizedLabels'
    description: The localization settings for homescreen and push notification
  WritableStarrableDivision:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
      name:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  JourneyEventsSettings:
    type: object
    properties:
      enabled:
        type: boolean
        description: Whether or not journey event collection is enabled.
      excludedQueryParameters:
        type: array
        description: (deprecated) List of parameters to be excluded from the query string.
        items:
          type: string
      shouldKeepUrlFragment:
        type: boolean
        description: (deprecated) Whether or not to keep the URL fragment.
      searchQueryParameters:
        type: array
        description: (deprecated) List of query parameters used for search (e.g. 'q').
        items:
          type: string
      pageviewConfig:
        type: string
        description: Controls how the pageview events are tracked.
        enum:
        - Auto
        - Once
        - 'Off'
      clickEvents:
        type: array
        description: Tracks when and where a visitor clicks on a webpage.
        items:
          $ref: '#/definitions/SelectorEventTrigger'
      formsTrackEvents:
        type: array
        description: Controls how the form submitted and form abandoned events are tracked after a visitor interacts with a form element.
        items:
          $ref: '#/definitions/FormsTrackTrigger'
      idleEvents:
        type: array
        description: Tracks when and where a visitor becomes inactive on a webpage.
        items:
          $ref: '#/definitions/IdleEventTrigger'
      inViewportEvents:
        type: array
        description: Tracks when elements become visible or hidden on screen.
        items:
          $ref: '#/definitions/SelectorEventTrigger'
      scrollDepthEvents:
        type: array
        description: Tracks when a visitor scrolls to a specific percentage of a webpage.
        items:
          $ref: '#/definitions/ScrollPercentageEventTrigger'
      trackingSettings:
        description: Configuration settings for tracking behavior and filtering
        $ref: '#/definitions/TrackingSettings'
    description: Settings concerning journey events
  JourneyCustomerSession:
    type: object
    required:
    - id
    - type
    properties:
      id:
        type: string
        description: An ID of a Customer/User's session within the Journey System at a point-in-time
      type:
        type: string
        description: The type of the Customer/User's session within the Journey System (e.g. web, app)
  JourneyActionMap:
    type: object
    required:
    - id
    - version
    properties:
      id:
        type: string
        description: The ID of the actionMap in the Journey System which triggered this action
      version:
        type: integer
        format: int32
        description: The version number of the actionMap in the Journey System at the time this action was triggered
  AgentVideoSettings:
    type: object
    properties:
      allowCamera:
        type: boolean
        description: whether or not agent camera is allowed
      allowScreenShare:
        type: boolean
        description: whether or not agent screen share is allowed
      allowMicrophone:
        type: boolean
        description: whether or not agent microphone is allowed
      background:
        type: string
        description: background for agent
        enum:
        - BLUR
        - NONE
        - IMAGE
      backgroundImage:
        description: background image settings for agent
        $ref: '#/definitions/BackgroundImageSettings'
    description: The settings for Agent Video
  UserStation:
    type: object
    properties:
      id:
        type: string
        description: A globally unique identifier for this station
        readOnly: true
      name:
        type: string
      type:
        type: string
      associatedUser:
        $ref: '#/definitions/User'
      associatedDate:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      defaultUser:
        $ref: '#/definitions/User'
      providerInfo:
        type: object
        description: 'Provider-specific info for this station, e.g. { "edgeGroupId": "ffe7b15c-a9cc-4f4c-88f5-781327819a49" }'
        additionalProperties:
          type: string
      webRtcCallAppearances:
        type: integer
        format: int32
        description: The number of call appearances on the station.
        readOnly: true
  FileUploadSettings:
    type: object
    properties:
      enableAttachments:
        type: boolean
        description: whether or not attachments are enabled
      modes:
        type: array
        description: The list of supported file upload modes
        items:
          $ref: '#/definitions/FileUploadMode'
    description: File upload settings for messenger
  NamedEntityAnnotation:
    type: object
    required:
    - name
    properties:
      name:
        type: string
        description: The name of the annotated named entity.
  IdentityResolutionExternalSource:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Group:
    type: object
    required:
    - name
    - rulesVisible
    - type
    - visibility
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The group name.
      description:
        type: string
      dateModified:
        type: string
        format: date-time
        description: 'Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      memberCount:
        type: integer
        format: int64
        description: Number of members.
        readOnly: true
      state:
        type: string
        description: Active, inactive, or deleted state.
        readOnly: true
        enum:
        - active
        - inactive
        - deleted
      version:
        type: integer
        format: int32
        description: Current version for this resource.
        readOnly: true
      type:
        type: string
        description: Type of group.
        enum:
        - official
        - social
      images:
        type: array
        items:
          $ref: '#/definitions/Image'
      addresses:
        type: array
        items:
          $ref: '#/definitions/GroupContact'
      rulesVisible:
        type: boolean
        description: Are membership rules visible to the person requesting to view the group
      visibility:
        type: string
        description: Who can view this group
        enum:
        - public
        - owners
        - members
      rolesEnabled:
        type: boolean
        description: Allow roles to be assigned to this group
      includeOwners:
        type: boolean
        description: Allow owners to be included as members of the group
      callsEnabled:
        type: boolean
        description: Allow calls to be placed to this group.
      owners:
        type: array
        description: Owners of the group
        items:
          $ref: '#/definitions/User'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Location:
    type: object
    properties:
      id:
        type: string
        description: Unique identifier for the location
      floorplanId:
        type: string
        description: Unique identifier for the location floorplan image
        readOnly: true
      coordinates:
        type: object
        description: Users coordinates on the floorplan. Only used when floorplanImage is set
        additionalProperties:
          type: number
          format: double
      notes:
        type: string
        description: Optional description on the users location
      locationDefinition:
        $ref: '#/definitions/LocationDefinition'
  WebDeploymentConfigurationVersionEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/WebDeploymentConfigurationVersion'
      nextUri:
        type: string
      selfUri:
        type: string
      previousUri:
        type: string
      total:
        type: integer
        format: int64
  MediaType:
    type: object
    properties:
      type:
        type: string
        description: The media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.
    description: Media type definition
  Intent:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
  CobrowseSettings:
    type: object
    properties:
      enabled:
        type: boolean
        description: Whether or not cobrowse is enabled
      allowAgentControl:
        type: boolean
        description: Whether the viewer should have option to request control
      allowAgentNavigation:
        type: boolean
        description: Whether the viewer should have option to request navigation
      allowDraw:
        type: boolean
        description: Should cobrowse draw be enabled
      maskSelectors:
        type: array
        description: Mask patterns that will apply to pages being shared
        items:
          type: string
      channels:
        type: array
        description: Cobrowse channels for web messenger
        items:
          type: string
          enum:
          - Webmessaging
          - Voice
      readonlySelectors:
        type: array
        description: Readonly patterns that will apply to pages being shared
        items:
          type: string
      pauseCriteria:
        type: array
        description: Pause criteria that will pause cobrowse if some of them are met in the user's URL
        items:
          $ref: '#/definitions/PauseCriteria'
    description: Settings concerning cobrowse
  ConversationDisconnectSettings:
    type: object
    properties:
      enabled:
        type: boolean
        description: whether or not conversation disconnect setting is enabled
      type:
        type: string
        description: Conversation disconnect type
        enum:
        - Send
        - ReadOnly
  SupportedLanguage:
    type: object
    properties:
      language:
        type: string
        description: Architect supported language tag, e.g. en-us, es-us
        readOnly: true
      isDefault:
        type: boolean
        description: Whether or not this language is the default language
        readOnly: true
  WebDeploymentActiveConfigurationOnDeployment:
    type: object
    properties:
      configurationVersion:
        description: The active configuration on a deployment
        $ref: '#/definitions/WebDeploymentConfigurationVersion'
      deployment:
        description: The web deployment associated with the active configuration
        $ref: '#/definitions/WebDeployment'
    description: Details about the active configuration on a deployment
  NluDomainVersionReference:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      domain:
        description: The NLU domain of the version.
        readOnly: true
        $ref: '#/definitions/NluDomain'
      intents:
        type: array
        description: The intents defined for this NLU domain version.
        items:
          $ref: '#/definitions/IntentReference'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  AdditionalLanguagesIntent:
    type: object
    properties:
      id:
        type: string
        description: ID of the intent for respective additional language
        readOnly: true
      utterances:
        type: array
        description: Utterances list for additional language
        items:
          $ref: '#/definitions/NluUtterance'
  WebDeploymentsOAuthExchangeRequest:
    type: object
    required:
    - deploymentId
    properties:
      deploymentId:
        type: string
        description: The WebDeployment ID
      journeyContext:
        description: A Customer journey context.
        $ref: '#/definitions/WebDeploymentsJourneyContext'
      oauth:
        $ref: '#/definitions/WebDeploymentsOAuthRequestParameters'
  LauncherButtonSettings:
    type: object
    properties:
      visibility:
        type: string
        description: The visibility settings for the button
        enum:
        - 'On'
        - 'Off'
        - OnDemand
      displayType:
        type: string
        description: The display type of the launcher button
        enum:
        - IconAndText
        - Icon
        - Text
      icon:
        description: The icon for the launcher button
        $ref: '#/definitions/Icon'
    description: The settings for the launcher button
  IntentDefinition:
    type: object
    required:
    - name
    - utterances
    properties:
      id:
        type: string
        description: ID of the intent.
        readOnly: true
      name:
        type: string
        description: The name of the intent.
      description:
        type: string
        description: The description of the intent.
      entityTypeBindings:
        type: array
        description: The bindings for the named entity types used in this intent.This field is mutually exclusive with entityNameReferences and entities
        items:
          $ref: '#/definitions/NamedEntityTypeBinding'
      entityNameReferences:
        type: array
        description: The references for the named entity used in this intent.This field is mutually exclusive with entityTypeBindings
        readOnly: true
        items:
          type: string
      utterances:
        type: array
        description: The utterances that act as training phrases for the intent.
        items:
          $ref: '#/definitions/NluUtterance'
      additionalLanguages:
        type: object
        description: Additional languages for intents
        additionalProperties:
          $ref: '#/definitions/AdditionalLanguagesIntent'
  WebDeploymentsRefreshJWTRequest:
    type: object
    required:
    - deploymentId
    - refreshToken
    properties:
      refreshToken:
        type: string
        description: Refresh token used to issue a new JWT.
      deploymentId:
        type: string
        description: The WebDeployment ID
  LocationAddress:
    type: object
    properties:
      city:
        type: string
      country:
        type: string
      countryName:
        type: string
      state:
        type: string
      street1:
        type: string
      street2:
        type: string
      zipcode:
        type: string
securityDefinitions:
  PureCloud OAuth:
    type: oauth2
    authorizationUrl: https://login.mypurecloud.com/authorize
    flow: implicit
    scopes:
      all: All the scopes
  Guest Chat JWT:
    type: apiKey
    name: Authorization
    in: header
externalDocs:
  description: PureCloud API Documentation
  url: https://developer.genesys.cloud/