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 Journey 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: Journey
  description: Predictive Engagement, Customer Journey
  externalDocs:
    description: Journey documentation
    url: https://developer.genesys.cloud/commdigital/digital/webmessaging/journey/journey-apis
paths:
  /api/v2/analytics/journeys/aggregates/query:
    post:
      tags:
      - Journey
      summary: Query for journey aggregates
      description: ''
      operationId: postAnalyticsJourneysAggregatesQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/JourneyAggregationQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyAggregateQueryResponse'
        '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]
            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:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: postAnalyticsJourneysAggregatesQuery
  /api/v2/analytics/journeys/aggregates/jobs:
    post:
      tags:
      - Journey
      summary: Query for journey aggregates asynchronously
      description: ''
      operationId: postAnalyticsJourneysAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/JourneyAsyncAggregationQuery'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryResponse'
        '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]
            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: You are not authorized to perform the requested action.
            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:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: postAnalyticsJourneysAggregatesJobs
  /api/v2/analytics/journeys/aggregates/jobs/{jobId}:
    get:
      tags:
      - Journey
      summary: Get status for async query for journey aggregates
      description: ''
      operationId: getAnalyticsJourneysAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/AsyncQueryStatus'
        '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: You are not authorized to perform the requested action.
            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:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: getAnalyticsJourneysAggregatesJob
    delete:
      tags:
      - Journey
      summary: Delete/cancel an async request for journey aggregates
      description: ''
      operationId: deleteAnalyticsJourneysAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '204':
          description: Deleted
        '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.
      security:
      - PureCloud OAuth:
        - analytics
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: deleteAnalyticsJourneysAggregatesJob
  /api/v2/analytics/journeys/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Journey
      summary: Fetch a page of results for an async aggregates query
      description: ''
      operationId: getAnalyticsJourneysAggregatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      - name: cursor
        in: query
        description: Cursor token to retrieve next page
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyAsyncAggregateQueryResponse'
        '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: You are not authorized to perform the requested action.
            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:
        - analytics
        - analytics:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - analytics:journeyAggregate:view
      x-purecloud-method-name: getAnalyticsJourneysAggregatesJobResults
  /api/v2/externalcontacts/contacts/{contactId}/journey/segments:
    get:
      tags:
      - Journey
      summary: Retrieve segment assignments by external contact ID.
      description: ''
      operationId: getExternalcontactsContactJourneySegments
      produces:
      - application/json
      parameters:
      - name: contactId
        in: path
        description: ExternalContact ID
        required: true
        type: string
      - name: includeMerged
        in: query
        description: Indicates whether to return segment assignments from all external contacts in the merge-set of the given one.
        required: false
        type: boolean
      - name: limit
        in: query
        description: Number of entities to return. Default of 25, maximum of 500.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SegmentAssignmentListing'
        '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:
        - external-contacts
        - external-contacts:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - externalContacts:segmentAssignment:view
      x-purecloud-method-name: getExternalcontactsContactJourneySegments
    post:
      tags:
      - Journey
      summary: Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.
      description: ''
      operationId: postExternalcontactsContactJourneySegments
      produces:
      - application/json
      parameters:
      - name: contactId
        in: path
        description: ExternalContact ID
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/UpdateSegmentAssignmentRequest'
      responses:
        '200':
          description: Request completed successfully or was partially successful.
          schema:
            $ref: '#/definitions/UpdateSegmentAssignmentResponse'
        '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]
            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:
        - external-contacts
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - externalContacts:segmentAssignment:add
        - externalContacts:segmentAssignment:delete
      x-purecloud-method-name: postExternalcontactsContactJourneySegments
  /api/v2/externalcontacts/contacts/{contactId}/journey/sessions:
    get:
      tags:
      - Journey
      summary: Retrieve all sessions for a given external contact.
      description: ''
      operationId: getExternalcontactsContactJourneySessions
      produces:
      - application/json
      parameters:
      - name: contactId
        in: path
        description: ExternalContact ID
        required: true
        type: string
      - name: pageSize
        in: query
        description: Number of entities to return. Maximum of 200.
        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: includeMerged
        in: query
        description: Indicates whether to return sessions from all external contacts in the merge-set of the given one.
        required: false
        type: boolean
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SessionListing'
        '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:
        - external-contacts
        - external-contacts:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - externalContacts:session:view
      x-purecloud-method-name: getExternalcontactsContactJourneySessions
  /api/v2/journey/actionmaps/{actionMapId}:
    get:
      tags:
      - Journey
      summary: Retrieve a single action map.
      description: ''
      operationId: getJourneyActionmap
      produces:
      - application/json
      parameters:
      - name: actionMapId
        in: path
        description: ID of the action map.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionMap'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actionmap:view
      x-purecloud-method-name: getJourneyActionmap
    delete:
      tags:
      - Journey
      summary: Delete single action map.
      description: ''
      operationId: deleteJourneyActionmap
      produces:
      - application/json
      parameters:
      - name: actionMapId
        in: path
        description: ID of the action map.
        required: true
        type: string
      responses:
        '204':
          description: Action map deleted.
        '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.
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actionmap:delete
      x-purecloud-method-name: deleteJourneyActionmap
    patch:
      tags:
      - Journey
      summary: Update single action map.
      description: ''
      operationId: patchJourneyActionmap
      produces:
      - application/json
      parameters:
      - name: actionMapId
        in: path
        description: ID of the action map.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/PatchActionMap'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionMap'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actionmap:edit
      x-purecloud-method-name: patchJourneyActionmap
  /api/v2/journey/actionmaps:
    get:
      tags:
      - Journey
      summary: Retrieve all action maps.
      description: ''
      operationId: getJourneyActionmaps
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      - name: sortBy
        in: query
        description: Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
        required: false
        type: string
      - name: filterField
        in: query
        description: Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.
        required: false
        type: string
      - name: filterValue
        in: query
        description: Value to filter by. Requires 'filterValue' to also be set.
        required: false
        type: string
      - name: actionMapIds
        in: query
        description: IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: queryFields
        in: query
        description: Action Map field(s) to query on. Requires 'queryValue' to also be set.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: queryValue
        in: query
        description: Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionMapListing'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actionmap:view
      x-purecloud-method-name: getJourneyActionmaps
    post:
      tags:
      - Journey
      summary: Create an action map.
      description: ''
      operationId: postJourneyActionmaps
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/ActionMap'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionMap'
        '201':
          description: Action map created.
          schema:
            $ref: '#/definitions/ActionMap'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actionmap:add
      x-purecloud-method-name: postJourneyActionmaps
  /api/v2/journey/actiontargets/{actionTargetId}:
    get:
      tags:
      - Journey
      summary: Deprecated. Retrieve a single action target.
      description: ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
      operationId: getJourneyActiontarget
      produces:
      - application/json
      parameters:
      - name: actionTargetId
        in: path
        description: ID of the action target.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionTarget'
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actiontarget:view
      x-purecloud-method-name: getJourneyActiontarget
    patch:
      tags:
      - Journey
      summary: Deprecated. Update a single action target.
      description: ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
      operationId: patchJourneyActiontarget
      produces:
      - application/json
      parameters:
      - name: actionTargetId
        in: path
        description: ID of the action target.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/PatchActionTarget'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionTarget'
        '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]
            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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actiontarget:edit
      x-purecloud-method-name: patchJourneyActiontarget
  /api/v2/journey/actiontargets:
    get:
      tags:
      - Journey
      summary: Deprecated. Retrieve all action targets.
      description: ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
      operationId: getJourneyActiontargets
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionTargetListing'
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actiontarget:view
      x-purecloud-method-name: getJourneyActiontargets
  /api/v2/journey/actiontemplates/{actionTemplateId}:
    get:
      tags:
      - Journey
      summary: Retrieve a single action template.
      description: ''
      operationId: getJourneyActiontemplate
      produces:
      - application/json
      parameters:
      - name: actionTemplateId
        in: path
        description: ID of the action template.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionTemplate'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actiontemplate:view
      x-purecloud-method-name: getJourneyActiontemplate
    delete:
      tags:
      - Journey
      summary: Delete a single action template.
      description: ''
      operationId: deleteJourneyActiontemplate
      produces:
      - application/json
      parameters:
      - name: actionTemplateId
        in: path
        description: ID of the action template.
        required: true
        type: string
      - name: hardDelete
        in: query
        description: Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.
        required: false
        type: boolean
      responses:
        '204':
          description: Action template deleted.
        '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.
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actiontemplate:delete
      x-purecloud-method-name: deleteJourneyActiontemplate
    patch:
      tags:
      - Journey
      summary: Update a single action template.
      description: ''
      operationId: patchJourneyActiontemplate
      produces:
      - application/json
      parameters:
      - name: actionTemplateId
        in: path
        description: ID of the action template.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/PatchActionTemplate'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionTemplate'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actiontemplate:edit
      x-purecloud-method-name: patchJourneyActiontemplate
  /api/v2/journey/actiontemplates:
    get:
      tags:
      - Journey
      summary: Retrieve all action templates.
      description: ''
      operationId: getJourneyActiontemplates
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      - name: sortBy
        in: query
        description: Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate).
        required: false
        type: string
      - name: mediaType
        in: query
        description: Media type
        required: false
        type: string
        enum:
        - webchat
        - webMessagingOffer
        - contentOffer
        - integrationAction
        - architectFlow
        - openAction
      - name: state
        in: query
        description: Action template state.
        required: false
        type: string
        enum:
        - Active
        - Inactive
        - Deleted
      - name: queryFields
        in: query
        description: ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: queryValue
        in: query
        description: Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionTemplateListing'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actiontemplate:view
      x-purecloud-method-name: getJourneyActiontemplates
    post:
      tags:
      - Journey
      summary: Create a single action template.
      description: ''
      operationId: postJourneyActiontemplates
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/ActionTemplate'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionTemplate'
        '201':
          description: Action template created.
          schema:
            $ref: '#/definitions/ActionTemplate'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actiontemplate:add
      x-purecloud-method-name: postJourneyActiontemplates
  /api/v2/journey/actionmaps/estimates/jobs/{jobId}:
    get:
      tags:
      - Journey
      summary: Deprecated. Get status of job.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: getJourneyActionmapsEstimatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: ID of the job.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            type: string
            enum:
            - Cancelled
            - Failed
            - Queued
            - Running
            - Succeeded
        '202':
          description: Accepted - Running query asynchronously
          schema:
            type: string
            enum:
            - Cancelled
            - Failed
            - Queued
            - Running
            - Succeeded
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:actionmapEstimateJob:view
      x-purecloud-method-name: getJourneyActionmapsEstimatesJob
  /api/v2/journey/actionmaps/estimates/jobs/{jobId}/results:
    get:
      tags:
      - Journey
      summary: Deprecated. Get estimates from completed job.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: getJourneyActionmapsEstimatesJobResults
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: ID of the job.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActionMapEstimateResult'
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:actionmapEstimate:view
      x-purecloud-method-name: getJourneyActionmapsEstimatesJobResults
  /api/v2/journey/actionmaps/estimates/jobs:
    post:
      tags:
      - Journey
      summary: Deprecated. Query for estimates
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: postJourneyActionmapsEstimatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: audience estimator request
        required: true
        schema:
          $ref: '#/definitions/ActionMapEstimateRequest'
      responses:
        '202':
          description: Accepted - Running query asynchronously
          schema:
            $ref: '#/definitions/EstimateJobAsyncResponse'
        '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]
            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:
        - journey
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:actionmapEstimateJob:add
      x-purecloud-method-name: postJourneyActionmapsEstimatesJobs
  /api/v2/journey/sessions/{sessionId}/events:
    get:
      tags:
      - Journey
      summary: Retrieve all events for a given session.
      description: ''
      operationId: getJourneySessionEvents
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: System-generated UUID that represents the session the event is a part of.
        required: true
        type: string
      - name: pageSize
        in: query
        description: Number of entities to return. Maximum of 200.
        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: eventType
        in: query
        description: A comma separated list of journey event types to include in the results.
        required: false
        type: string
        enum:
        - com.genesys.journey.OutcomeAchievedEvent
        - com.genesys.journey.SegmentAssignmentEvent
        - com.genesys.journey.WebActionEvent
        - com.genesys.journey.WebEvent
        - com.genesys.journey.AppEvent
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/EventListing'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:event:view
      x-purecloud-method-name: getJourneySessionEvents
  /api/v2/journey/externalevents/schemas/coretypes/{coreTypeName}:
    get:
      tags:
      - Journey
      summary: Get a core type from which all schemas are built
      description: ''
      operationId: getJourneyExternaleventsSchemasCoretype
      produces:
      - application/json
      parameters:
      - name: coreTypeName
        in: path
        description: Name of core type
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Coretype'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:view
      x-purecloud-method-name: getJourneyExternaleventsSchemasCoretype
  /api/v2/journey/externalevents/schemas/coretypes:
    get:
      tags:
      - Journey
      summary: Get the list of core types enabled for a specific namespace.
      description: ''
      operationId: getJourneyExternaleventsSchemasCoretypes
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/CoretypeListing'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:view
      x-purecloud-method-name: getJourneyExternaleventsSchemasCoretypes
  /api/v2/journey/externalevents/configurations/{configId}:
    get:
      tags:
      - Journey
      summary: Get an external events configuration
      description: ''
      operationId: getJourneyExternaleventsConfiguration
      produces:
      - application/json
      parameters:
      - name: configId
        in: path
        description: The ID of the external event configuration.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ExternalEventsConfiguration'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsConfiguration:view
      x-purecloud-method-name: getJourneyExternaleventsConfiguration
    delete:
      tags:
      - Journey
      summary: Delete an external events configuration.
      description: ''
      operationId: deleteJourneyExternaleventsConfiguration
      produces:
      - application/json
      parameters:
      - name: configId
        in: path
        description: The ID of the external event configuration.
        required: true
        type: string
      responses:
        '204':
          description: Configuration deleted.
        '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.
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsConfiguration:delete
      x-purecloud-method-name: deleteJourneyExternaleventsConfiguration
    patch:
      tags:
      - Journey
      summary: Update an external events configuration.
      description: ''
      operationId: patchJourneyExternaleventsConfiguration
      produces:
      - application/json
      parameters:
      - name: configId
        in: path
        description: The ID of the external event configuration.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/UpdateExternalEventsConfigurationRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ExternalEventsConfiguration'
        '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]
            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:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsConfiguration:edit
      x-purecloud-method-name: patchJourneyExternaleventsConfiguration
  /api/v2/journey/externalevents/configurations:
    get:
      tags:
      - Journey
      summary: Get all external event configurations.
      description: ''
      operationId: getJourneyExternaleventsConfigurations
      produces:
      - application/json
      parameters:
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 20
        maximum: 20
        minimum: 1
        format: int32
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        minimum: 1
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ExternalEventsConfigurationListing'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsConfiguration:view
      x-purecloud-method-name: getJourneyExternaleventsConfigurations
    post:
      tags:
      - Journey
      summary: Create an external events configuration.
      description: ''
      operationId: postJourneyExternaleventsConfigurations
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/CreateExternalEventsConfigurationRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ExternalEventsConfiguration'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsConfiguration:add
      x-purecloud-method-name: postJourneyExternaleventsConfigurations
  /api/v2/journey/externalevents/configurations/{configurationId}/events:
    post:
      tags:
      - Journey
      summary: Create external events
      description: ''
      operationId: postJourneyExternaleventsConfigurationEvents
      produces:
      - application/json
      parameters:
      - name: configurationId
        in: path
        description: The ID of the external event configuration.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/ExternalEventsRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ExternalEventsResponse'
        '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]
            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.
        '422':
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            unprocessable.entity: Configuration schema or division is inactive
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsEvent:add
      x-purecloud-method-name: postJourneyExternaleventsConfigurationEvents
  /api/v2/journey/externalevents/schemas/limits:
    get:
      tags:
      - Journey
      summary: Get quantitative limits on schemas
      description: ''
      operationId: getJourneyExternaleventsSchemasLimits
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SchemaQuantityLimits'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:view
      x-purecloud-method-name: getJourneyExternaleventsSchemasLimits
  /api/v2/journey/externalevents/schemas/{schemaId}:
    get:
      tags:
      - Journey
      summary: Get a schema
      description: ''
      operationId: getJourneyExternaleventsSchema
      produces:
      - application/json
      parameters:
      - name: schemaId
        in: path
        description: Schema ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyExternalEventsSchema'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:view
      x-purecloud-method-name: getJourneyExternaleventsSchema
    put:
      tags:
      - Journey
      summary: Update a schema
      description: ''
      operationId: putJourneyExternaleventsSchema
      produces:
      - application/json
      parameters:
      - name: schemaId
        in: path
        description: Schema ID
        required: true
        type: string
      - in: body
        name: body
        description: Schema update request body
        required: true
        schema:
          $ref: '#/definitions/JourneySchemaUpdateRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyExternalEventsSchema'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded: The total number of fields defined for all schemas cannot exceed 2500.
            dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded: There cannot be more than 50 schemas.
            bad.request: The request could not be understood by the server due to malformed syntax.  Check that all required schema fields are present.
            invalid.property: Value [%s] is not a valid property for object [%s]
            dynamic.schema.invalid.json.schema: An invalid JSON schema was provided.
            dynamic.schema.duplicate.schema.title: The schema title has to be unique.
            constraint.validation: '%s'
            dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded: A schema cannot have more than 50 fields
            dynamic.schema.duplicate.enum.properties.title: The title of the enum options has to be unique.
            dynamic.schema.validation.limit.error: The JSON schema provided for update has a validation limit error.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            dynamic.schema.incompatible.json.schema.update: The JSON schema provided for update is incompatible with the previous version.
            dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded: A field name cannot exceed 100 characters
            dynamic.schema.validation.limit.missing: The new JSON schema provided for update is missing a validation limit.
            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.
            dynamic.schema.duplicate.property.title: The property title in the schema has to be unique.
            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.
            dynamic.schema.version.conflict: A valid version is required.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            dynamic.schema.payload.too.large: Payload too large.
            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:
            dynamic.schema.expand.failed: Unable to expand the schema.
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:edit
      x-purecloud-method-name: putJourneyExternaleventsSchema
    delete:
      tags:
      - Journey
      summary: Delete a schema
      description: ''
      operationId: deleteJourneyExternaleventsSchema
      produces:
      - application/json
      parameters:
      - name: schemaId
        in: path
        description: Schema ID
        required: true
        type: string
      responses:
        '204':
          description: Operation was successful.
        '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'
            feature.forbidden: Delete operation forbidden.
            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:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:delete
      x-purecloud-method-name: deleteJourneyExternaleventsSchema
  /api/v2/journey/externalevents/schemas/{schemaId}/versions:
    get:
      tags:
      - Journey
      summary: Get all versions of a External Events schema
      description: ''
      operationId: getJourneyExternaleventsSchemaVersions
      produces:
      - application/json
      parameters:
      - name: schemaId
        in: path
        description: Schema ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyExternalEventsSchemaListing'
        '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.
        '422':
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            dynamic.schema.expand.failed: The schema to expand has parse errors
      security:
      - PureCloud OAuth:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:view
      x-purecloud-method-name: getJourneyExternaleventsSchemaVersions
  /api/v2/journey/externalevents/schemas/{schemaId}/versions/{versionId}:
    get:
      tags:
      - Journey
      summary: Get a specific version of a schema
      description: ''
      operationId: getJourneyExternaleventsSchemaVersion
      produces:
      - application/json
      parameters:
      - name: schemaId
        in: path
        description: Schema ID
        required: true
        type: string
      - name: versionId
        in: path
        description: Schema version
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyExternalEventsSchema'
        '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.
        '422':
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            dynamic.schema.expand.failed: The schema to expand has parse errors
      security:
      - PureCloud OAuth:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:view
      x-purecloud-method-name: getJourneyExternaleventsSchemaVersion
  /api/v2/journey/externalevents/schemas:
    get:
      tags:
      - Journey
      summary: Get a list of schemas.
      description: ''
      operationId: getJourneyExternaleventsSchemas
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyExternalEventsSchemaListing'
        '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.
        '422':
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            dynamic.schema.expand.failed: Unable to expand the schema.
      security:
      - PureCloud OAuth:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:view
      x-purecloud-method-name: getJourneyExternaleventsSchemas
    post:
      tags:
      - Journey
      summary: Create a schema
      description: ''
      operationId: postJourneyExternaleventsSchemas
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: Schema create request body
        required: true
        schema:
          $ref: '#/definitions/JourneyJsonSchemaRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyExternalEventsSchema'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded: The total number of fields defined for all schemas would exceed 2500.
            dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded: There cannot be more than 50 schemas.
            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]
            dynamic.schema.invalid.json.schema: An invalid JSON schema was provided.
            dynamic.schema.duplicate.schema.title: The schema title has to be unique.
            constraint.validation: '%s'
            dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded: A schema cannot have more than 50 fields
            dynamic.schema.duplicate.enum.properties.title: The title of the enum options has to be unique.
            dynamic.schema.validation.limit.error: The schema has a validation limit error.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            dynamic.schema.incompatible.json.schema.update: The JSON schema provided for update is incompatible with the previous version.
            dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded: A field name cannot exceed 100 characters
            dynamic.schema.validation.limit.missing: The schema is missing a validation limit.
            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.
            dynamic.schema.length.limits.would.be.exceeded: The schema title should not exceed 50 characters.  The schema description should not exceed 200 characters.
            dynamic.schema.duplicate.property.title: The property title in the schema has to be unique.
            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.
            dynamic.schema.version.conflict: A valid version is required.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            dynamic.schema.payload.too.large: Payload too large.
            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:
            dynamic.schema.expand.failed: Unable to expand the schema.
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:externalEventsSchema:add
      x-purecloud-method-name: postJourneyExternaleventsSchemas
  /api/v2/journey/flows/paths/query:
    post:
      tags:
      - Journey
      summary: Query for flow paths.
      description: ''
      operationId: postJourneyFlowsPathsQuery
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/FlowPathsQuery'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/FlowPaths'
        '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]
            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:
            response.too.large: The response payload was too large.
            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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:flowpaths:view
      x-purecloud-method-name: postJourneyFlowsPathsQuery
  /api/v2/journey/outcomes/{outcomeId}:
    get:
      tags:
      - Journey
      summary: Deprecated. Retrieve a single outcome.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: getJourneyOutcome
      produces:
      - application/json
      parameters:
      - name: outcomeId
        in: path
        description: ID of the outcome.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Outcome'
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcome:view
      x-purecloud-method-name: getJourneyOutcome
    delete:
      tags:
      - Journey
      summary: Deprecated. Delete an outcome.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: deleteJourneyOutcome
      produces:
      - application/json
      parameters:
      - name: outcomeId
        in: path
        description: ID of the outcome.
        required: true
        type: string
      responses:
        '204':
          description: Outcome deleted.
        '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.
      security:
      - PureCloud OAuth:
        - journey
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcome:delete
      x-purecloud-method-name: deleteJourneyOutcome
    patch:
      tags:
      - Journey
      summary: Deprecated. Update an outcome.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: patchJourneyOutcome
      produces:
      - application/json
      parameters:
      - name: outcomeId
        in: path
        description: ID of the outcome.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/PatchOutcome'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Outcome'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcome:edit
      x-purecloud-method-name: patchJourneyOutcome
  /api/v2/journey/outcomes:
    get:
      tags:
      - Journey
      summary: Deprecated. Retrieve all outcomes.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: getJourneyOutcomes
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      - name: sortBy
        in: query
        description: Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
        required: false
        type: string
      - name: outcomeIds
        in: query
        description: IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: queryFields
        in: query
        description: Outcome field(s) to query on. Requires 'queryValue' to also be set.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: queryValue
        in: query
        description: Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/OutcomeListing'
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcome:view
      x-purecloud-method-name: getJourneyOutcomes
    post:
      tags:
      - Journey
      summary: Deprecated. Create an outcome.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: postJourneyOutcomes
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/OutcomeRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Outcome'
        '201':
          description: Outcome created.
          schema:
            $ref: '#/definitions/Outcome'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcome:add
      x-purecloud-method-name: postJourneyOutcomes
  /api/v2/journey/sessions/{sessionId}/outcomescores:
    get:
      tags:
      - Journey
      summary: Deprecated. Retrieve latest outcome score associated with a session for all outcomes.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: getJourneySessionOutcomescores
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: ID of the session.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/OutcomeScoresResult'
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcomescores:view
      x-purecloud-method-name: getJourneySessionOutcomescores
  /api/v2/journey/outcomes/predictors/{predictorId}:
    get:
      tags:
      - Journey
      summary: Deprecated. Retrieve a single outcome predictor.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: getJourneyOutcomesPredictor
      produces:
      - application/json
      parameters:
      - name: predictorId
        in: path
        description: ID of predictor
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/OutcomePredictor'
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcomepredictor:view
      x-purecloud-method-name: getJourneyOutcomesPredictor
    delete:
      tags:
      - Journey
      summary: Deprecated. Delete an outcome predictor.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: deleteJourneyOutcomesPredictor
      produces:
      - application/json
      parameters:
      - name: predictorId
        in: path
        description: ID of predictor
        required: true
        type: string
      responses:
        '204':
          description: Predictor deleted.
        '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.
      security:
      - PureCloud OAuth:
        - journey
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcomepredictor:delete
      x-purecloud-method-name: deleteJourneyOutcomesPredictor
  /api/v2/journey/outcomes/predictors:
    get:
      tags:
      - Journey
      summary: Deprecated. Retrieve all outcome predictors.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: getJourneyOutcomesPredictors
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/OutcomePredictorListing'
        '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:
        - journey
        - journey:readonly
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcomepredictor:view
      x-purecloud-method-name: getJourneyOutcomesPredictors
    post:
      tags:
      - Journey
      summary: Deprecated. Create an outcome predictor.
      description: Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
      operationId: postJourneyOutcomesPredictors
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/OutcomePredictorRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/OutcomePredictor'
        '201':
          description: Predictor created.
          schema:
            $ref: '#/definitions/OutcomePredictor'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      deprecated: true
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:outcomepredictor:add
      x-purecloud-method-name: postJourneyOutcomesPredictors
  /api/v2/journey/segments/{segmentId}:
    get:
      tags:
      - Journey
      summary: Retrieve a single segment.
      description: ''
      operationId: getJourneySegment
      produces:
      - application/json
      parameters:
      - name: segmentId
        in: path
        description: ID of the segment.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneySegment'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:segment:view
      x-purecloud-method-name: getJourneySegment
    delete:
      tags:
      - Journey
      summary: Delete a segment.
      description: ''
      operationId: deleteJourneySegment
      produces:
      - application/json
      parameters:
      - name: segmentId
        in: path
        description: ID of the segment.
        required: true
        type: string
      responses:
        '204':
          description: Segment deleted.
        '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.
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:segment:delete
      x-purecloud-method-name: deleteJourneySegment
    patch:
      tags:
      - Journey
      summary: Update a segment.
      description: ''
      operationId: patchJourneySegment
      produces:
      - application/json
      parameters:
      - name: segmentId
        in: path
        description: ID of the segment.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/PatchSegment'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneySegment'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:segment:edit
      x-purecloud-method-name: patchJourneySegment
  /api/v2/journey/segments:
    get:
      tags:
      - Journey
      summary: Retrieve all segments.
      description: ''
      operationId: getJourneySegments
      produces:
      - application/json
      parameters:
      - name: sortBy
        in: query
        description: Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
        required: false
        type: string
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: isActive
        in: query
        description: Determines whether or not to show only active segments.
        required: false
        type: boolean
      - name: segmentIds
        in: query
        description: IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: queryFields
        in: query
        description: Segment field(s) to query on. Requires 'queryValue' to also be set.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: queryValue
        in: query
        description: Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SegmentListing'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:segment:view
      x-purecloud-method-name: getJourneySegments
    post:
      tags:
      - Journey
      summary: Create a segment.
      description: ''
      operationId: postJourneySegments
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/JourneySegmentRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneySegment'
        '201':
          description: Segment created.
          schema:
            $ref: '#/definitions/JourneySegment'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
        - journey
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:segment:add
      x-purecloud-method-name: postJourneySegments
  /api/v2/journey/sessions/{sessionId}:
    get:
      tags:
      - Journey
      summary: Retrieve a single session.
      description: ''
      operationId: getJourneySession
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: ID of the session.
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Session'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - journey:session:view
        - externalContacts:session:view
      x-purecloud-method-name: getJourneySession
  /api/v2/journey/views/{viewId}:
    get:
      tags:
      - Journey
      summary: Get a Journey View by ID
      description: returns the latest version
      operationId: getJourneyView
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: viewId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyView'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            blocked: The request is blocked for your organization
            missing.required: Some headers or the body of the request are missing
            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:
            entity.not.found: The journey was not found in database
            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.
            transaction.conflict: Database raises transaction conflict
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:view
      x-purecloud-method-name: getJourneyView
    delete:
      tags:
      - Journey
      summary: Delete a Journey View by ID
      description: deletes all versions
      operationId: deleteJourneyView
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: viewId
        required: true
        type: string
      responses:
        '204':
          description: 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:
            blocked: The request is blocked for your organization
            missing.required: Some headers or the body of the request are missing
            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:
            entity.not.found: The journey was not found in database
            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.
            transaction.conflict: Database raises transaction conflict
        '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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:delete
      x-purecloud-method-name: deleteJourneyView
  /api/v2/journey/views/{viewId}/versions/{versionId}:
    get:
      tags:
      - Journey
      summary: Get a Journey View by ID and version
      description: ''
      operationId: getJourneyViewVersion
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: viewId
        required: true
        type: string
      - name: versionId
        in: path
        description: versionId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyView'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            blocked: The request is blocked for your organization
            missing.required: Some headers or the body of the request are missing
            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:
            entity.not.found: The journey was not found in database
            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.
            transaction.conflict: Database raises transaction conflict
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:view
      x-purecloud-method-name: getJourneyViewVersion
    put:
      tags:
      - Journey
      summary: Update a Journey View by ID and version
      description: does not create a new version
      operationId: putJourneyViewVersion
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: viewId
        required: true
        type: string
      - name: versionId
        in: path
        description: versionId
        required: true
        type: string
      - in: body
        name: body
        description: JourneyView
        required: true
        schema:
          $ref: '#/definitions/JourneyView'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyView'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            limit.exceeded: Body content has exceeded the authorized limit
            missing.required: Some headers or the body of the request are missing
            bad.request: The request could not be understood by the server due to malformed syntax.
            malformed.value: Some content of body contains malformed value
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            not.allowed: Some content of body is not allowed
            blocked: The request is blocked for your organization
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            request.invalidates.job.results: The request invalidates the job results for this journey id version.
            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.value: Some content of body contains invalid value
        '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:
            entity.not.found: The journey was not found in database
            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.
            transaction.conflict: Database raises transaction conflict
        '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:
            external.query.failure: The request to external service failed
            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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:edit
      x-purecloud-method-name: putJourneyViewVersion
  /api/v2/journey/views/{viewId}/versions:
    post:
      tags:
      - Journey
      summary: Update a Journey View by ID
      description: creates a new version
      operationId: postJourneyViewVersions
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: viewId
        required: true
        type: string
      - in: body
        name: body
        description: JourneyView
        required: true
        schema:
          $ref: '#/definitions/JourneyView'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyView'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            limit.exceeded: Body content has exceeded the authorized limit
            missing.required: Some headers or the body of the request are missing
            bad.request: The request could not be understood by the server due to malformed syntax.
            malformed.value: Some content of body contains malformed value
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            not.allowed: Some content of body is not allowed
            blocked: The request is blocked for your organization
            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.value: Some content of body contains invalid value
        '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:
            entity.not.found: The journey was not found in database
            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.
            transaction.conflict: Database raises transaction conflict
        '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:
            external.query.failure: The request to external service failed
            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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:edit
      x-purecloud-method-name: postJourneyViewVersions
  /api/v2/journey/views:
    get:
      tags:
      - Journey
      summary: Get a list of Journey Views
      description: ''
      operationId: getJourneyViews
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      - name: nameOrCreatedBy
        in: query
        description: Journey View Name or Created By
        required: false
        type: string
      - name: expand
        in: query
        description: Parameter to request additional data to return in Journey payload
        required: false
        type: string
        enum:
        - charts
      - name: id
        in: query
        description: Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            blocked: The request is blocked for your organization
            missing.required: Some headers or the body of the request are missing
            limit.exceeded: Query parameter has exceed the authorize limit
            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]
            response.too.large: The payload of the response is too large
            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.
            transaction.conflict: Database raises transaction conflict
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:view
      x-purecloud-method-name: getJourneyViews
    post:
      tags:
      - Journey
      summary: Create a new Journey View
      description: ''
      operationId: postJourneyViews
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: JourneyView
        required: true
        schema:
          $ref: '#/definitions/JourneyView'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyView'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            missing.required: Some headers or the body of the request are missing
            limit.exceeded: Body content has exceeded the authorized limit
            bad.request: The request could not be understood by the server due to malformed syntax.
            malformed.value: Some content of body contains malformed value
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            not.allowed: Some content of body is not allowed
            blocked: The request is blocked for your organization
            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.value: Some content of body contains invalid value
        '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.
            transaction.conflict: Database raises transaction conflict
        '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:
            external.query.failure: The request to external service failed
            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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:add
      x-purecloud-method-name: postJourneyViews
  /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}:
    get:
      tags:
      - Journey
      summary: Get a Chart by ID
      description: returns the latest version
      operationId: getJourneyViewVersionChart
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: viewId
        required: true
        type: string
      - name: journeyViewVersion
        in: path
        description: Journey View Version
        required: true
        type: string
      - name: chartId
        in: path
        description: chartId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewChart'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            blocked: The request is blocked for your organization
            missing.required: Some headers or the body of the request are missing
            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:
            entity.not.found: The journey or chart was not found in database
            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.
            transaction.conflict: Database raises transaction conflict
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:view
      x-purecloud-method-name: getJourneyViewVersionChart
  /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}:
    get:
      tags:
      - Journey
      summary: Get a Chart by ID and version
      description: ''
      operationId: getJourneyViewVersionChartVersion
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: viewId
        required: true
        type: string
      - name: journeyViewVersion
        in: path
        description: Journey View Version
        required: true
        type: string
      - name: chartId
        in: path
        description: chartId
        required: true
        type: string
      - name: chartVersion
        in: path
        description: chartVersion
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewChart'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            blocked: The request is blocked for your organization
            missing.required: Some headers or the body of the request are missing
            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:
            entity.not.found: The journey or chart was not found in database
            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.
            transaction.conflict: Database raises transaction conflict
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:views:view
      x-purecloud-method-name: getJourneyViewVersionChartVersion
  /api/v2/journey/views/data/details:
    get:
      tags:
      - Journey
      summary: Get details about the data available for journey queries including oldest and newest event dates
      description: ''
      operationId: getJourneyViewsDataDetails
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DataRange'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:dataDetails:view
      x-purecloud-method-name: getJourneyViewsDataDetails
  /api/v2/journey/views/encodings/validate:
    post:
      tags:
      - Journey
      summary: Validate whether an encoding exist for a label/value combination.
      description: True indicates a valid encoding
      operationId: postJourneyViewsEncodingsValidate
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/Label'
      responses:
        '200':
          description: Execution submitted successfully.
          schema:
            $ref: '#/definitions/EntityListing'
        '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]
            custom.bad.request: The request could not be understood by the server due to malformed syntax.
            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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsEncodings:view
      x-purecloud-method-name: postJourneyViewsEncodingsValidate
  /api/v2/journey/views/eventdefinitions/{eventDefinitionId}:
    get:
      tags:
      - Journey
      summary: Get an Event Definition
      description: ''
      operationId: getJourneyViewsEventdefinition
      produces:
      - application/json
      parameters:
      - name: eventDefinitionId
        in: path
        description: Event Definition ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyEventDefinition'
        '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.
        '501':
          description: Not Implemented
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            organization.forbidden: Access denied to external events for this organization
      security:
      - PureCloud OAuth:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:eventDefinition:view
      x-purecloud-method-name: getJourneyViewsEventdefinition
    put:
      tags:
      - Journey
      summary: Update external event for journey views
      description: ''
      operationId: putJourneyViewsEventdefinition
      produces:
      - application/json
      parameters:
      - name: eventDefinitionId
        in: path
        description: Event Definition ID
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/UpdateExternalEventRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/UpdateExternalEventResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            display.name.conflict: A conflicting display name already exists
            bad.request: The request could not be understood by the server due to malformed syntax.
            rank.invalid: The rank value is invalid
            schema.not.enabled: The schema is not enabled
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.request.format: The request body format is invalid
            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.
            missing.required.fields: Required fields are missing from the request
            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: An internal server error occurred
        '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.
        '501':
          description: Not Implemented
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            organization.forbidden: Access denied to external events for this organization
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:externalEvents:edit
      x-purecloud-method-name: putJourneyViewsEventdefinition
  /api/v2/journey/views/eventdefinitions:
    get:
      tags:
      - Journey
      summary: Get a list of Event Definitions
      description: ''
      operationId: getJourneyViewsEventdefinitions
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyEventDefinitionListing'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:eventDefinition:view
      x-purecloud-method-name: getJourneyViewsEventdefinitions
  /api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate:
    put:
      tags:
      - Journey
      summary: Activate external event for journey views
      description: ''
      operationId: putJourneyViewsEventdefinitionActivate
      produces:
      - application/json
      parameters:
      - name: eventDefinitionId
        in: path
        description: Event Definition ID
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/ActivateExternalEventRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ActivateExternalEventResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            display.name.conflict: A conflicting display name already exists
            schema.already.enabled: The schema is already enabled
            bad.request: The request could not be understood by the server due to malformed syntax.
            rank.invalid: The rank value is invalid
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.request.format: The request body format is invalid
            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.
            missing.required.fields: Required fields are missing from the request
            dss.deactivated: The DSS service is deactivated
            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: An internal server error occurred
        '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.
        '501':
          description: Not Implemented
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            organization.forbidden: Access denied to external events for this organization
      security:
      - PureCloud OAuth:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:externalEvents:activate
      x-purecloud-method-name: putJourneyViewsEventdefinitionActivate
  /api/v2/journey/views/eventdefinitions/external/changes:
    get:
      tags:
      - Journey
      summary: Get changes in external event definitions
      description: ''
      operationId: getJourneyViewsEventdefinitionsExternalChanges
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ExternalEventChangesResponse'
        '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: An internal server error occurred
        '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.
        '501':
          description: Not Implemented
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            organization.forbidden: Access denied to external events for this organization
      security:
      - PureCloud OAuth:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:externalEvents:view
      x-purecloud-method-name: getJourneyViewsEventdefinitionsExternalChanges
  /api/v2/journey/views/eventdefinitions/external:
    get:
      tags:
      - Journey
      summary: Get external events for journey views
      description: ''
      operationId: getJourneyViewsEventdefinitionsExternal
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/GetExternalEventsResponse'
        '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: An internal server error occurred
        '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.
        '501':
          description: Not Implemented
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            organization.forbidden: Access denied to external events for this organization
      security:
      - PureCloud OAuth:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:externalEvents:view
      x-purecloud-method-name: getJourneyViewsEventdefinitionsExternal
  /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest:
    get:
      tags:
      - Journey
      summary: Get the latest job of a journey view version.
      description: ''
      operationId: getJourneyViewVersionJobsLatest
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      - name: journeyVersionId
        in: path
        description: Journey View Version
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewJob'
        '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]
            custom.bad.request: The request could not be understood by the server due to malformed syntax.
            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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsJobs:view
      x-purecloud-method-name: getJourneyViewVersionJobsLatest
  /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}:
    get:
      tags:
      - Journey
      summary: Get the job for a journey view version.
      description: ''
      operationId: getJourneyViewVersionJob
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      - name: journeyVersionId
        in: path
        description: Journey View Version
        required: true
        type: string
      - name: jobId
        in: path
        description: JobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewJob'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsJobs:view
      x-purecloud-method-name: getJourneyViewVersionJob
    patch:
      tags:
      - Journey
      summary: Update the job for a journey view version. Only the status can be changed and only to Cancelled
      description: ''
      operationId: patchJourneyViewVersionJob
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      - name: journeyVersionId
        in: path
        description: Journey View Version
        required: true
        type: string
      - name: jobId
        in: path
        description: JobId
        required: true
        type: string
      - in: body
        name: body
        description: journeyViewJob
        required: true
        schema:
          $ref: '#/definitions/JourneyViewJob'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewJob'
        '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]
            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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsJobs:edit
      x-purecloud-method-name: patchJourneyViewVersionJob
  /api/v2/journey/views/jobs/me:
    get:
      tags:
      - Journey
      summary: Get my jobs
      description: ''
      operationId: getJourneyViewsJobsMe
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: The number of the page to return
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Max number of entities to return
        required: false
        type: integer
        default: 25
        format: int32
      - name: interval
        in: query
        description: An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
        required: false
        type: string
        format: interval
        x-example: 2023-07-17T00:00:00Z/2023-07-18T00:00:00Z
      - name: statuses
        in: query
        description: Job statuses to filter for
        required: false
        type: string
        x-example: statuses=Accepted,Executing,Complete,Failed,Scheduled
      responses:
        '200':
          description: Request completed successfully
          schema:
            $ref: '#/definitions/JourneyViewJobListing'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsJobs:view
      x-purecloud-method-name: getJourneyViewsJobsMe
  /api/v2/journey/views/jobs:
    get:
      tags:
      - Journey
      summary: Get the jobs for an organization.
      description: ''
      operationId: getJourneyViewsJobs
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: The number of the page to return
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Max number of entities to return
        required: false
        type: integer
        default: 25
        format: int32
      - name: interval
        in: query
        description: An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
        required: false
        type: string
        format: interval
        x-example: 2023-07-17T00:00:00Z/2023-07-18T00:00:00Z
      - name: statuses
        in: query
        description: Job statuses to filter for
        required: false
        type: string
        x-example: statuses=Accepted,Executing,Complete,Failed,Scheduled
      responses:
        '200':
          description: Request completed successfully
          schema:
            $ref: '#/definitions/JourneyViewJobListing'
        '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:
            custom.resource.not.found: Resource 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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsJobs:view
      x-purecloud-method-name: getJourneyViewsJobs
  /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs:
    post:
      tags:
      - Journey
      summary: Submit a job request for a journey view version.
      description: ''
      operationId: postJourneyViewVersionJobs
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      - name: journeyVersionId
        in: path
        description: Journey View Version
        required: true
        type: string
      responses:
        '202':
          description: Job submitted successfully.
          schema:
            $ref: '#/definitions/JourneyViewJob'
        '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]
            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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsJobs:add
      x-purecloud-method-name: postJourneyViewVersionJobs
  /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}:
    get:
      tags:
      - Journey
      summary: Get the chart result associated with a journey view job.
      description: ''
      operationId: getJourneyViewVersionJobResultsChart
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      - name: journeyVersionId
        in: path
        description: Journey View Version
        required: true
        type: string
      - name: jobId
        in: path
        description: JobId
        required: true
        type: string
      - name: chartId
        in: path
        description: ChartId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewChartResult'
        '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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsResults:view
      x-purecloud-method-name: getJourneyViewVersionJobResultsChart
  /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results:
    get:
      tags:
      - Journey
      summary: Get the result of a job for a journey view version.
      description: ''
      operationId: getJourneyViewVersionJobResults
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: JourneyViewResult id
        required: true
        type: string
      - name: journeyViewVersion
        in: path
        description: Journey View Version
        required: true
        type: string
      - name: jobId
        in: path
        description: Id of the executing job
        required: true
        type: string
      responses:
        '200':
          description: Result received successfully
          schema:
            $ref: '#/definitions/JourneyViewResult'
        '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:
            custom.resource.not.found: Resource 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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsResults:view
      x-purecloud-method-name: getJourneyViewVersionJobResults
  /api/v2/journey/views/schedules:
    get:
      tags:
      - Journey
      summary: Get the journey schedules for an organization.
      description: ''
      operationId: getJourneyViewsSchedules
      produces:
      - application/json
      parameters:
      - name: pageNumber
        in: query
        description: The number of the page to return
        required: false
        type: integer
        default: 1
        format: int32
      - name: pageSize
        in: query
        description: Max number of entities to return
        required: false
        type: integer
        default: 25
        format: int32
      responses:
        '200':
          description: Request completed successfully
          schema:
            $ref: '#/definitions/JourneyViewScheduleListing'
        '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:
            custom.resource.not.found: Resource 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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsSchedule:view
      x-purecloud-method-name: getJourneyViewsSchedules
  /api/v2/journey/views/{viewId}/schedules:
    get:
      tags:
      - Journey
      summary: Get the Schedule for a JourneyView
      description: ''
      operationId: getJourneyViewSchedules
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewSchedule'
        '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]
            custom.bad.request: The request could not be understood by the server due to malformed syntax.
            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:
        - journey
        - journey:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsSchedule:view
      x-purecloud-method-name: getJourneyViewSchedules
    post:
      tags:
      - Journey
      summary: Add a new Schedule to a JourneyView
      description: ''
      operationId: postJourneyViewSchedules
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      - in: body
        name: body
        description: journeyViewSchedule
        required: true
        schema:
          $ref: '#/definitions/JourneyViewSchedule'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewSchedule'
        '201':
          description: Schedule created successfully.
          schema:
            $ref: '#/definitions/JourneyViewSchedule'
        '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]
            custom.bad.request: The request could not be understood by the server due to malformed syntax.
            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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsSchedule:add
      x-purecloud-method-name: postJourneyViewSchedules
    put:
      tags:
      - Journey
      summary: Update the Schedule for a JourneyView
      description: ''
      operationId: putJourneyViewSchedules
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      - in: body
        name: body
        description: journeyViewSchedule
        required: true
        schema:
          $ref: '#/definitions/JourneyViewSchedule'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewSchedule'
        '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]
            custom.bad.request: The request could not be understood by the server due to malformed syntax.
            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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsSchedule:edit
      x-purecloud-method-name: putJourneyViewSchedules
    delete:
      tags:
      - Journey
      summary: Delete the Schedule of a JourneyView
      description: ''
      operationId: deleteJourneyViewSchedules
      produces:
      - application/json
      parameters:
      - name: viewId
        in: path
        description: Journey View Id
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/JourneyViewSchedule'
        '204':
          description: Scheduling 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
            custom.bad.request: The request could not be understood by the server due to malformed syntax.
        '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:
        - journey
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - journey:viewsSchedule:delete
      x-purecloud-method-name: deleteJourneyViewSchedules
  /api/v2/journey/deployments/{deploymentId}/actionevent:
    post:
      tags:
      - Journey
      summary: Sends an action event, which is used for changing the state of actions that have been offered to the user.
      description: ''
      operationId: postJourneyDeploymentActionevent
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The ID of the deployment sending the beacon.
        required: true
        type: string
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/ActionEventRequest'
      responses:
        '204':
          description: Successfully transitioned the actions state. This does not return the action.
        '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: There was an issue with this transition. The reason is returned in the body.
            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]
            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]'
            access.denied: Event Collection is not enabled
            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:
            invalid.action: The Action, Deployment, or Session was not was 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.
            invalid.action.state: Invalid Action state transition
        '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: postJourneyDeploymentActionevent
  /api/v2/journey/deployments/{deploymentId}/appevents:
    post:
      tags:
      - Journey
      summary: Send a journey app event, used for tracking customer activity on an application.
      description: ''
      operationId: postJourneyDeploymentAppevents
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The ID of the deployment sending the app event.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/AppEventRequest'
      responses:
        '200':
          description: Request completed successfully.
          schema:
            $ref: '#/definitions/AppEventResponse'
        '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]
            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'
            forbidden: Forbidden from sending a journey app event.
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
            unprocessable.entity: The app event on the request is older than the start date of the active session and will not be processed.
      x-purecloud-method-name: postJourneyDeploymentAppevents
  /api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping:
    get:
      tags:
      - Journey
      summary: Send a ping.
      description: ''
      operationId: getJourneyDeploymentCustomerPing
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The ID of the deployment sending the ping.
        required: true
        type: string
      - name: customerCookieId
        in: path
        description: ID of the customer associated with the ping.
        required: true
        type: string
      - name: dl
        in: query
        description: 'Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR  2) Application screen name that the ping request was sent from in the app. e.g. ''home'' or ''help. Pings without this parameter will not return actions.'
        required: false
        type: string
      - name: dt
        in: query
        description: Document Title.  A human readable name for the page or screen
        required: false
        type: string
      - name: appNamespace
        in: query
        description: Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
        required: false
        type: string
      - name: sessionId
        in: query
        description: UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
        required: false
        type: string
      - name: sinceLastBeaconMilliseconds
        in: query
        description: How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.
        required: false
        type: integer
        format: int64
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DeploymentPing'
        '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'
            forbidden: Unauthorized to send ping request.
            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).
            server.unavailable: The service is currently unavailable.
        '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: getJourneyDeploymentCustomerPing
  /api/v2/journey/deployments/{deploymentId}/webevents:
    post:
      tags:
      - Journey
      summary: Send a journey web event, used for tracking customer activity on a website.
      description: ''
      operationId: postJourneyDeploymentWebevents
      produces:
      - application/json
      parameters:
      - name: deploymentId
        in: path
        description: The ID of the deployment sending the web event.
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/WebEventRequest'
      responses:
        '200':
          description: Request completed successfully.
          schema:
            $ref: '#/definitions/WebEventResponse'
        '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]
            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.
            limit.exceeded: The limit allowed has been exceeded for this 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:
            unprocessable.entity: The web event on the request is older than the start date of the active session and will not be processed.
      x-purecloud-method-name: postJourneyDeploymentWebevents
definitions:
  SegmentAssignmentSegment:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The ID of the segment.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  OutcomeQuantileCondition:
    type: object
    required:
    - maxQuantileThreshold
    - outcomeId
    properties:
      outcomeId:
        type: string
        description: The outcome ID.
      maxQuantileThreshold:
        type: number
        format: float
        description: This Outcome Quantile Condition is met when sessionMaxQuantile of the OutcomeScore is above this value, (unless fallbackQuantile is set). Range 0.00-1.00
      fallbackQuantileThreshold:
        type: number
        format: float
        description: (Optional) If set, this Condition is met when maxQuantileThreshold is met, AND the current quantile of the OutcomeScore is below this fallbackQuantileThreshold. Range 0.00-1.00
  ExternalEventIdentifiers:
    type: object
    required:
    - externalIds
    properties:
      externalIds:
        type: array
        description: The list of identifiers of the contact
        items:
          $ref: '#/definitions/ExternalEventExternalId'
        maxItems: 1
        minItems: 1
  JourneyEventDefinition:
    type: object
    required:
    - description
    - jsonSchema
    - name
    - source
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The name of the event definition
        readOnly: true
      source:
        type: string
        description: The source of the event definition
        readOnly: true
        enum:
        - Native
        - External
      rank:
        type: integer
        format: int32
        description: The rank of the event definition
        readOnly: true
      displayName:
        type: string
        description: The display name of the event definition
        readOnly: true
      description:
        type: string
        description: The description of this event definition
        readOnly: true
      jsonSchema:
        description: The JSON schema of this event definition
        readOnly: true
        $ref: '#/definitions/JsonSchemaDocument'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: An event definition used when creating journey views
  ExternalEvent:
    type: object
    required:
    - attributes
    - dateCreated
    - id
    - identifiers
    properties:
      id:
        type: string
        description: The ID of the event.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the event actually took place. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      identifiers:
        description: The identifiers of the contact the event is for.
        $ref: '#/definitions/ExternalEventIdentifiers'
      attributes:
        type: object
        description: The event attributes.
        additionalProperties:
          type: object
  AddressableEntityRef:
    type: object
    properties:
      id:
        type: string
      selfUri:
        type: string
        format: uri
  UnprocessedSegmentAssignments:
    type: object
    required:
    - count
    properties:
      assign:
        description: The segment assignments to apply.
        $ref: '#/definitions/SegmentAssignments'
      unassign:
        description: The segment unassignments to apply.
        $ref: '#/definitions/SegmentUnassignments'
      count:
        type: integer
        format: int32
        description: The total number of segment assignments and unassignments that were not successfully processed.
  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.
  JourneyViewSchedule:
    type: object
    required:
    - dateModified
    - frequency
    - user
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      frequency:
        type: string
        description: Frequency of execution
        enum:
        - Daily
        - Weekly
        - Monthly
      dateModified:
        type: string
        format: date-time
        description: 'Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      user:
        description: Last modified user
        readOnly: true
        $ref: '#/definitions/AddressableEntityRef'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ActionEventRequest:
    type: object
    required:
    - actionId
    - actionState
    - sessionId
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      sessionId:
        type: string
        description: UUID of the customer session for this action.
      actionId:
        type: string
        description: UUID for the action, as returned by the Ping endpoint when the action was qualified.
      actionState:
        type: string
        description: State the action is transitioning to.
        enum:
        - accepted
        - rejected
        - timedout
        - errored
        - ignored
        - qualified
        - offered
        - started
        - engaged
        - qualifiedOutsideSchedule
        - offeredOutsideSchedule
        - abandoned
        - completed
        - frequencyCapReached
      errorCode:
        type: string
        description: Client defined error code (when state transitions to errored)
      errorMessage:
        type: string
        description: Message of the error returned when the action fails (when state transitions to errored)
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  SegmentAssignment:
    type: object
    required:
    - dateAssigned
    - dateForUnassignment
    - externalContact
    - segment
    properties:
      dateAssigned:
        type: string
        format: date-time
        description: 'Date when the segment was assigned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateForUnassignment:
        type: string
        format: date-time
        description: 'Date indicating when a segment is scheduled to be unassigned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      segment:
        description: The segment the assignment is for.
        $ref: '#/definitions/SegmentAssignmentSegment'
      externalContact:
        description: External contact of the customer to which the segment is assigned.
        $ref: '#/definitions/AddressableEntityRef'
      session:
        description: For session-scoped segments, the session for which the segment was assigned.
        $ref: '#/definitions/SegmentAssignmentSession'
  AsyncQueryStatus:
    type: object
    properties:
      state:
        type: string
        description: The current state of the asynchronous query
        enum:
        - QUEUED
        - PENDING
        - FAILED
        - CANCELLED
        - FULFILLED
        - EXPIRED
      errorMessage:
        type: string
        description: The error associated with the current query, if the state is FAILED
      expirationDate:
        type: string
        format: date-time
        description: 'The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      submissionDate:
        type: string
        format: date-time
        description: 'The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      completionDate:
        type: string
        format: date-time
        description: 'The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  PatchCloseButtonStyleProperties:
    type: object
    properties:
      color:
        type: string
        description: 'Color of button. (eg. #FF0000)'
      opacity:
        type: number
        format: float
        description: Opacity of button.
  CustomEventAttribute:
    type: object
    required:
    - dataType
    - value
    properties:
      dataType:
        type: string
        description: The data type of the custom attribute.
      value:
        type: string
        description: The value of the custom attribute.
  StatisticalResponse:
    type: object
    properties:
      interval:
        type: string
      metrics:
        type: array
        items:
          $ref: '#/definitions/AggregateMetricData'
      views:
        type: array
        items:
          $ref: '#/definitions/AggregateViewData'
  JourneyViewResult:
    type: object
    properties:
      elements:
        type: array
        description: The elements within the journey view result
        readOnly: true
        items:
          $ref: '#/definitions/JourneyViewResultElement'
      charts:
        type: array
        description: The chart results within the journey view result
        readOnly: true
        items:
          $ref: '#/definitions/JourneyViewChartResult'
    description: A journey view result
  ActionMapAction:
    type: object
    properties:
      actionTemplate:
        description: Action template associated with the action map.
        $ref: '#/definitions/ActionMapActionTemplate'
      mediaType:
        type: string
        description: Media type of action.
        enum:
        - webchat
        - webMessagingOffer
        - contentOffer
        - integrationAction
        - architectFlow
        - openAction
      actionTargetId:
        type: string
        description: Deprecated. Action target ID.
      isPacingEnabled:
        type: boolean
        description: Deprecated. Whether this action should be throttled.
      props:
        description: Deprecated. Additional properties.
        $ref: '#/definitions/ActionProperties'
      architectFlowFields:
        description: Architect Flow Id and input contract.
        $ref: '#/definitions/ArchitectFlowFields'
      webMessagingOfferFields:
        description: Admin-configurable fields of a web messaging offer action.
        $ref: '#/definitions/WebMessagingOfferFields'
      openActionFields:
        description: Admin-configurable fields of an open action.
        $ref: '#/definitions/OpenActionFields'
  AggregateViewData:
    type: object
    properties:
      name:
        type: string
      stats:
        $ref: '#/definitions/StatisticalSummary'
  PatchActionTarget:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      serviceLevel:
        description: Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.
        $ref: '#/definitions/ServiceLevel'
      shortAbandonThreshold:
        type: integer
        format: int32
        description: Indicates the non-default short abandon threshold
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  JourneyViewLink:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The identifier of the element downstream
      constraintWithin:
        description: A time constraint on this link, which requires a customer to complete the downstream element within this amount of time to be counted.
        $ref: '#/definitions/JourneyViewLinkTimeConstraint'
      constraintAfter:
        description: A time constraint on this link, which requires a customer must complete the downstream element after this amount of time to be counted.
        $ref: '#/definitions/JourneyViewLinkTimeConstraint'
      eventCountType:
        type: string
        description: 'The type of events that will be counted. Note: Concurrent will override any JourneyViewLinkTimeConstraint. Default is Sequential.'
        enum:
        - All
        - Concurrent
        - Sequential
      joinAttributes:
        type: array
        description: Other (secondary) attributes on which this link should join the customers being counted
        items:
          type: string
    description: A link between elements in a journey view
  JourneyViewElementFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: 'Boolean operation to apply to the provided predicates and clauses. Valid values: And'
        enum:
        - And
      predicates:
        type: array
        description: predicates
        items:
          $ref: '#/definitions/JourneyViewElementFilterPredicate'
      numberPredicates:
        type: array
        description: numberPredicates
        items:
          $ref: '#/definitions/JourneyViewElementFilterNumberPredicate'
    description: A set of filters on an element within a journey view
  EventSession:
    type: object
    required:
    - id
    - type
    properties:
      id:
        type: string
        description: The ID of the session.
      selfUri:
        type: string
        format: uri
      type:
        type: string
        description: Session types indicate the type or category of sessions (e.g. web, app).
  EventListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/Event'
      nextUri:
        type: string
      selfUri:
        type: string
      previousUri:
        type: string
  StatisticalSummary:
    type: object
    properties:
      max:
        type: number
      min:
        type: number
      count:
        type: integer
        format: int64
      countNegative:
        type: integer
        format: int64
      countPositive:
        type: integer
        format: int64
      sum:
        type: number
      current:
        type: number
      ratio:
        type: number
      numerator:
        type: number
      denominator:
        type: number
      target:
        type: number
      p95:
        type: integer
        format: int64
      p99:
        type: integer
        format: int64
      calculatedMetricValue:
        type: integer
        format: int64
  PatchSurveyQuestion:
    type: object
    required:
    - label
    properties:
      type:
        type: string
        description: Type of survey question.
        enum:
        - text
        - hidden
        - select
        - checkbox
        - textarea
      label:
        type: string
        description: Label of question.
      customerProperty:
        type: string
        description: The customer property that the answer maps to.
        enum:
        - givenName
        - familyName
        - email
        - phone
        - gender
        - companyName
      choices:
        type: array
        description: Choices available to user.
        items:
          type: string
      isMandatory:
        type: boolean
        description: Whether answering this question is mandatory.
  SdkLibrary:
    type: object
    required:
    - name
    - version
    properties:
      name:
        type: string
        description: The name of the SDK.
      version:
        type: string
        description: The version of the SDK.
  FlowPathsFlowDetails:
    type: object
    required:
    - count
    - flow
    - type
    - version
    properties:
      flow:
        description: The identifier of the flow.
        $ref: '#/definitions/AddressableEntityRef'
      version:
        type: string
        description: The version of the flow.
      type:
        type: string
        description: The type of the flow.
        enum:
        - DigitalBot
        - Bot
        - InboundCall
        - SecureCall
        - InboundShortMessage
        - InboundEmail
        - OutboundCall
      count:
        type: integer
        format: int32
        description: Count of all journeys that include this element in the given flow.
  JourneyViewLinkTimeConstraint:
    type: object
    properties:
      unit:
        type: string
        description: The unit for the link's time constraint
        enum:
        - Seconds
        - Minutes
        - Hours
        - Days
        - Weeks
        - Months
      value:
        type: integer
        format: int32
        description: The value for the link's time constraint
  CoretypeListing:
    type: object
    properties:
      total:
        type: integer
        format: int64
      entities:
        type: array
        items:
          $ref: '#/definitions/Coretype'
      selfUri:
        type: string
        format: uri
  SegmentAssignmentEvent:
    type: object
    required:
    - segment
    properties:
      segment:
        description: The segment which was assigned.
        $ref: '#/definitions/AddressableEntityRef'
  ExternalEventChange:
    type: object
    properties:
      changeCategory:
        type: string
        description: The category of the change
        readOnly: true
        enum:
        - Error
        - Updated
        - New
      schemaId:
        type: string
        description: The unique identifier for the schema
        readOnly: true
      eventName:
        type: string
        description: The name of the event
        readOnly: true
      dateDetected:
        type: string
        format: date-time
        description: 'The timestamp when the change was detected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      systemStatus:
        type: string
        description: The status of the change
        readOnly: true
        enum:
        - New
        - Updated
        - Active
        - Inactive
        - Error
      errorCode:
        type: string
        description: A code representing the error, only present for ERROR category changes
        readOnly: true
      errorDescription:
        type: string
        description: A description of the error, only present for ERROR category changes
        readOnly: true
    description: A change in an external event definition
  OutcomeScore:
    type: object
    properties:
      outcome:
        description: The outcome that the score was calculated for.
        $ref: '#/definitions/AddressableEntityRef'
      sessionMaxProbability:
        type: number
        format: float
        description: Represents the max probability reached in the session.
      probability:
        type: number
        format: float
        description: Represents the likelihood of a customer reaching or achieving a given outcome.
      percentile:
        type: integer
        format: int32
        description: '(Deprecated: use the ''quantile'' field instead) Represents the predicted probability''s percentile score when compared with all other generated probabilities for a given outcome.'
      sessionMaxPercentile:
        type: integer
        format: int32
        description: '(Deprecated: use the ''quantile'' field instead) Represents the maximum likelihood percentile score reached for a given outcome by the current session.'
      quantile:
        type: number
        format: float
        description: Represents the quantity of sessions that have a maximum probability less than the predicted probability.
      sessionMaxQuantile:
        type: number
        format: float
        description: Represents the quantity of sessions that have a maximum probability less than the predicted session max probability.
  DataRange:
    type: object
    properties:
      dateMin:
        type: string
        format: date-time
        description: 'The first event timestamp found. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateMax:
        type: string
        format: date-time
        description: 'The last event timestamp found. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
  OutcomeAchievedEventOutcome:
    type: object
    required:
    - displayName
    - id
    - version
    properties:
      id:
        type: string
        description: ID of the outcome.
      selfUri:
        type: string
        format: uri
      displayName:
        type: string
        description: The display name of the outcome.
      version:
        type: integer
        format: int32
        description: The version of the outcome.
  Referrer:
    type: object
    required:
    - domain
    - hostname
    - medium
    - pathname
    - url
    properties:
      url:
        type: string
        description: Referrer URL.
      domain:
        type: string
        description: Referrer URL domain.
      hostname:
        type: string
        description: Referrer URL hostname.
      keywords:
        type: string
        description: Referrer keywords.
      pathname:
        type: string
        description: Referrer URL pathname.
      queryString:
        type: string
        description: Referrer URL querystring.
      fragment:
        type: string
        description: Referrer URL fragment.
      name:
        type: string
        description: Name of referrer (e.g. Yahoo!, Google, InfoSpace).
      medium:
        type: string
        description: Type of referrer (e.g. search, social).
        enum:
        - internal
        - search
        - social
        - email
        - unknown
        - paid
  AppEvent:
    type: object
    required:
    - app
    - attributes
    - device
    - eventName
    - screenName
    - traits
    properties:
      eventName:
        type: string
        description: Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. screen_viewed, order_completed, user_registered).
      screenName:
        type: string
        description: The name of the screen in the app that the event took place.
      app:
        description: Application that the customer is interacting with.
        $ref: '#/definitions/JourneyApp'
      device:
        description: Customer's device.
        $ref: '#/definitions/Device'
      ipAddress:
        type: string
        description: Customer's IP address. May be null if the business configures the tracker to not collect IP addresses.
      ipOrganization:
        type: string
        description: Customer's IP-based organization or ISP name.
      geolocation:
        description: Customer's geolocation.
        $ref: '#/definitions/JourneyGeolocation'
      sdkLibrary:
        description: SDK library used to generate the event.
        $ref: '#/definitions/SdkLibrary'
      networkConnectivity:
        description: Information relating to the device's network connectivity.
        $ref: '#/definitions/NetworkConnectivity'
      mktCampaign:
        description: Marketing / traffic source information.
        $ref: '#/definitions/JourneyCampaign'
      searchQuery:
        type: string
        description: Represents the keywords in a customer search query.
      attributes:
        type: object
        description: User-defined attributes associated with a particular event.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      traits:
        type: object
        description: Traits are attributes intrinsic to the customer that may be sent in selected events. Examples are email, givenName, cellPhone.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
  MaxLength:
    type: object
    required:
    - max
    - min
    properties:
      min:
        type: integer
        format: int64
        description: A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance.
      max:
        type: integer
        format: int64
        description: A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance.
  OutcomePredictorRequest:
    type: object
    required:
    - outcome
    properties:
      outcome:
        description: The outcome for which this predictor will provide predictions.
        $ref: '#/definitions/OutcomeRefRequest'
  WebEventResponseSession:
    type: object
    required:
    - createdDate
    - durationInSeconds
    - eventCount
    - pageviewCount
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      durationInSeconds:
        type: integer
        format: int32
        description: Indicates how long the customer has been on the site within this session.
      eventCount:
        type: integer
        format: int32
        description: The count of all events recorded during this session.
      pageviewCount:
        type: integer
        format: int32
        description: The count of all pageviews performed during this session.
      referrer:
        description: The referrer of the first event in the web session.
        $ref: '#/definitions/Referrer'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: 'Date of the session''s first event, that is when the session starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  OutcomeAchievedEvent:
    type: object
    required:
    - outcome
    properties:
      outcome:
        description: The outcome achieved.
        $ref: '#/definitions/OutcomeAchievedEventOutcome'
      userAgentString:
        type: string
        description: HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15).
      browser:
        description: Customer's browser.
        $ref: '#/definitions/Browser'
      device:
        description: Customer's device.
        $ref: '#/definitions/Device'
      geolocation:
        description: Customer's geolocation.
        $ref: '#/definitions/JourneyGeolocation'
      ipAddress:
        type: string
        description: Visitor's IP address.
      ipOrganization:
        type: string
        description: Visitor's IP-based organization or ISP name.
      mktCampaign:
        description: Marketing / traffic source information.
        $ref: '#/definitions/JourneyCampaign'
      visitReferrer:
        description: Visit's referrer.
        $ref: '#/definitions/Referrer'
      visitCreatedDate:
        type: string
        format: date-time
        description: 'When visit was created (e.g. timestamp of the first event in visit). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  JourneyViewElementFilterNumberPredicate:
    type: object
    required:
    - dimension
    - range
    properties:
      dimension:
        type: string
        description: the element's attribute being filtered on
      operator:
        type: string
        description: 'Optional operator, default is Matches. Valid values: Matches'
        enum:
        - Matches
        - NotMatches
      noValue:
        type: boolean
        description: set this to true if no specific value to be considered
      range:
        description: the range of comparators to filter on
        $ref: '#/definitions/JourneyViewElementFilterRange'
    description: A numeric filter on an element within a journey view
  OutcomePredictorListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/OutcomePredictor'
  WebEventBrowser:
    type: object
    required:
    - family
    - version
    properties:
      family:
        type: string
        description: Browser family (e.g. Chrome, Safari, Firefox).
      version:
        type: string
        description: Browser version (e.g. 68.0.3440.84).
      lang:
        type: string
        description: Language the browser is set to. Must conform to BCP 47.
  RequestEntityTypeCriteria:
    type: object
    required:
    - entityType
    - key
    - values
    properties:
      key:
        type: string
        description: The criteria key.
      values:
        type: array
        description: The criteria values.
        items:
          type: string
      shouldIgnoreCase:
        type: boolean
        description: Should criteria be case insensitive.
      operator:
        type: string
        description: The comparison operator.
        enum:
        - containsAll
        - containsAny
        - notContainsAll
        - notContainsAny
        - equal
        - notEqual
        - greaterThan
        - greaterThanOrEqual
        - lessThan
        - lessThanOrEqual
        - startsWith
        - endsWith
      entityType:
        type: string
        description: The entity to match the pattern against.
        enum:
        - visit
  JourneyViewScheduleListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/JourneyViewSchedule'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  ConversationUserDisposition:
    type: object
    required:
    - code
    - user
    properties:
      code:
        type: string
        description: User-defined wrap-up code for the conversation.
      notes:
        type: string
        description: Text entered by the user to describe the call or disposition.
      user:
        description: The user that wrapped up the conversation.
        $ref: '#/definitions/AddressableEntityRef'
  UpdateSegmentAssignmentRequest:
    type: object
    properties:
      assign:
        description: The segment assignments to apply.
        $ref: '#/definitions/SegmentAssignments'
      unassign:
        description: The segment unassignments to apply.
        $ref: '#/definitions/SegmentUnassignments'
  TextStyleProperties:
    type: object
    properties:
      color:
        type: string
        description: 'Color of the text. (eg. #FFFFFF)'
      font:
        type: string
        description: Font of the text. (eg. Helvetica)
      fontSize:
        type: string
        description: Font size of the text. (eg. '12')
      textAlign:
        type: string
        description: Text alignment.
        enum:
        - Left
        - Right
        - Center
  JourneyViewUser:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      emailAddress:
        type: string
        description: Email address of the user
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  AsyncQueryResponse:
    type: object
    properties:
      jobId:
        type: string
        description: Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results.
  JourneyPattern:
    type: object
    required:
    - count
    - criteria
    - sessionType
    - streamType
    properties:
      criteria:
        type: array
        description: A list of one or more criteria to satisfy.
        items:
          $ref: '#/definitions/Criteria'
      count:
        type: integer
        format: int32
        description: The number of times the pattern must match.
      streamType:
        type: string
        description: The stream type for which this pattern can be matched on.
        enum:
        - Web
        - Custom
        - Conversation
        - App
      sessionType:
        type: string
        description: The session type for which this pattern can be matched on.
      eventName:
        type: string
        description: The name of the event for which this pattern can be matched on.
  EntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          type: object
  ActionTemplate:
    type: object
    required:
    - mediaType
    - name
    - state
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: Name of the action template.
      description:
        type: string
        description: Description of the action template's functionality.
      version:
        type: integer
        format: int32
        description: The version of the action template.
        readOnly: true
      mediaType:
        type: string
        description: Media type of action described by the action template.
        enum:
        - webchat
        - webMessagingOffer
        - contentOffer
        - integrationAction
        - architectFlow
        - openAction
      state:
        type: string
        description: Whether the action template is currently active, inactive or deleted.
        enum:
        - Active
        - Inactive
        - Deleted
      contentOffer:
        description: Properties used to configure an action of type content offer
        $ref: '#/definitions/ContentOffer'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: Date when action template was created in ISO-8601 format.
        readOnly: true
      modifiedDate:
        type: string
        format: date-time
        description: Date when action template was last modified in ISO-8601 format.
        readOnly: true
  WebActionEvent:
    type: object
    required:
    - action
    - actionMap
    - actionTarget
    - browser
    - device
    - userAgentString
    properties:
      action:
        description: The action that triggered the event.
        $ref: '#/definitions/EventAction'
      actionMap:
        description: The action map that triggered the action.
        $ref: '#/definitions/ActionEventActionMap'
      actionTarget:
        description: Deprecated. The target for engagement actions.
        $ref: '#/definitions/AddressableEntityRef'
      timeToDisposition:
        type: integer
        format: int64
        description: Milliseconds elapsed until the action is disposed.
      errorCode:
        type: string
        description: Code of the error returned when the action fails.
      errorMessage:
        type: string
        description: Message of the error returned when the action fails.
      userAgentString:
        type: string
        description: HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15).
      browser:
        description: Customer's browser.
        $ref: '#/definitions/Browser'
      device:
        description: Customer's device.
        $ref: '#/definitions/Device'
      geolocation:
        description: Customer's geolocation.
        $ref: '#/definitions/JourneyGeolocation'
      ipAddress:
        type: string
        description: Visitor's IP address.
      ipOrganization:
        type: string
        description: Visitor's IP-based organization or ISP name.
      mktCampaign:
        description: Marketing / traffic source information.
        $ref: '#/definitions/JourneyCampaign'
      visitReferrer:
        description: Visit's referrer.
        $ref: '#/definitions/Referrer'
  JourneyAggregateQueryPredicate:
    type: object
    properties:
      type:
        type: string
        description: Optional type, can usually be inferred
        enum:
        - dimension
        - property
        - metric
      dimension:
        type: string
        description: Left hand side for dimension predicates
        enum:
        - containsAllCondition
        - containsAnyCondition
        - endsWithCondition
        - equalCondition
        - journeyActionId
        - journeyActionMapId
        - journeyActionMapVersion
        - journeyActionMediaType
        - journeyActionTargetId
        - journeyActionTemplateId
        - journeyBlockingActionMapId
        - journeyBlockingEmergencyScheduleGroupId
        - journeyBlockingReason
        - journeyBlockingScheduleGroupId
        - journeyDeviceCategory
        - journeyDeviceType
        - journeyFrequencyCapReason
        - journeyIpGeolocationCountry
        - journeyOutcomeId
        - journeySegmentAssignmentState
        - journeySegmentId
        - journeySessionId
        - journeySessionSegmentId
        - journeySessionType
        - notContainsAllCondition
        - notContainsAnyCondition
        - notEqualCondition
        - startsWithCondition
        - touchpointActionMapId
        - touchpointAgentId
        - touchpointAttributionScope
        - touchpointChannelMessageType
        - touchpointChannelPlatform
        - touchpointChannelType
        - touchpointConversationId
        - touchpointInteractionType
        - touchpointQueueId
        - touchpointRequestedRouting
        - touchpointUsedRouting
        - touchpointWrapupCode
        x-genesys-entity-type:
          value: DIMENSION_TYPE
      operator:
        type: string
        description: Optional operator, default is matches
        enum:
        - matches
        - exists
        - notExists
      value:
        type: string
        description: Right hand side for dimension predicates
        x-genesys-entity-type:
          value: DIMENSION_SELECTOR
      range:
        description: Right hand side for dimension predicates
        $ref: '#/definitions/NumericRange'
  JourneyViewElementAttributes:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: The type of the element (e.g. Event)
        enum:
        - Event
      id:
        type: string
        description: The identifier for the element based on its type
      source:
        type: string
        description: The source for the element (e.g. IVR, Voice, Chat). Used for informational purposes only
    description: Attributes on an element in a journey view
  PatchExternalSegment:
    type: object
    properties:
      name:
        type: string
        description: Name for the external segment in the system where it originates from.
  PatchCriteria:
    type: object
    properties:
      key:
        type: string
        description: The criteria key.
      values:
        type: array
        description: The criteria values.
        items:
          type: string
      shouldIgnoreCase:
        type: boolean
        description: Should criteria be case insensitive.
      operator:
        type: string
        description: The comparison operator.
        enum:
        - containsAll
        - containsAny
        - notContainsAll
        - notContainsAny
        - equal
        - notEqual
        - greaterThan
        - greaterThanOrEqual
        - lessThan
        - lessThanOrEqual
        - startsWith
        - endsWith
  ExternalEventSummary:
    type: object
    properties:
      schemaId:
        type: string
        description: The schema ID of the external event
        readOnly: true
      eventName:
        type: string
        description: The name of the external event
        readOnly: true
      displayName:
        type: string
        description: The display name of the external event
        readOnly: true
      rank:
        type: integer
        format: int32
        description: The rank of the external event
        readOnly: true
      activationStatus:
        type: string
        description: The activation status of the external event
        readOnly: true
        enum:
        - Activated
        - Deactivated
      systemStatus:
        type: string
        description: The system status of the external event
        readOnly: true
        enum:
        - New
        - Updated
        - Active
        - Inactive
        - Error
      dateCreated:
        type: string
        format: date-time
        description: 'The timestamp when the external event 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 timestamp when the external event was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateFirstActivated:
        type: string
        format: date-time
        description: 'The timestamp when the external event was first activated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
    description: Summary of an external event definition
  RequestMapping:
    type: object
    properties:
      name:
        type: string
        description: Name of the Integration Action Attribute to supply the value for
      attributeType:
        type: string
        description: Type of the value supplied
        enum:
        - String
        - Number
        - Integer
        - Boolean
      mappingType:
        type: string
        description: Method of finding value to use with Attribute
        enum:
        - Lookup
        - HardCoded
      value:
        type: string
        description: Value to supply for the specified Attribute
  AssignedSegment:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The ID of the segment assigned.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ExternalEventsResponse:
    type: object
    required:
    - unprocessedEntities
    properties:
      unprocessedEntities:
        type: array
        description: List of events that failed processing.
        items:
          $ref: '#/definitions/UnprocessedExternalEvent'
  ConnectedQueue:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  OutcomeProbabilityCondition:
    type: object
    required:
    - maximumProbability
    - outcomeId
    properties:
      outcomeId:
        type: string
        description: The outcome ID.
      maximumProbability:
        type: number
        format: float
        description: Probability value for the selected outcome at or above which the action map will trigger.
      probability:
        type: number
        format: float
        description: Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value.
  ActionMapActionTemplate:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  CallToAction:
    type: object
    required:
    - url
    properties:
      text:
        type: string
        description: Text displayed on the call to action button.
      url:
        type: string
        description: URL to open when user clicks on the call to action button.
      target:
        type: string
        description: Where the URL should be opened when the user clicks on the call to action button.
        enum:
        - Blank
        - Self
  ExternalSegment:
    type: object
    required:
    - id
    - name
    - source
    properties:
      id:
        type: string
        description: Identifier for the external segment in the system where it originates from.
      name:
        type: string
        description: Name for the external segment in the system where it originates from.
      source:
        type: string
        description: The external system where the segment originates from.
        enum:
        - AdobeExperiencePlatform
        - Custom
  ActionMapEstimateOutcomeCriteria:
    type: object
    required:
    - outcomeId
    properties:
      outcomeId:
        type: string
        description: ID of outcome.
      maxProbability:
        type: number
        format: float
        description: Probability value for the selected outcome at or above which the action map will trigger.
      probability:
        type: number
        format: float
        description: Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value.
      quantile:
        type: number
        format: float
        description: Represents the quantity of sessions that have a maximum probability less than the predicted probability.
      maxQuantile:
        type: number
        format: float
        description: Represents the quantity of sessions that have a maximum probability less than the predicted session max probability.
  KeyValue:
    type: object
    required:
    - key
    - value
    properties:
      key:
        type: string
        description: Key for free-form data.
      value:
        type: string
        description: Value for free-form data.
  RequestPage:
    type: object
    required:
    - title
    - url
    properties:
      url:
        type: string
        description: The page URL.
      title:
        type: string
        description: Title of the page.
      keywords:
        type: string
        description: Keywords from the HTML <meta> tag of the page.
      lang:
        type: string
        description: ISO 639-1 language code for the page as defined in the <html> tag.
  RequestJourneyPattern:
    type: object
    required:
    - count
    - criteria
    - sessionType
    - streamType
    properties:
      criteria:
        type: array
        description: A list of one or more criteria to satisfy.
        items:
          $ref: '#/definitions/RequestCriteria'
      count:
        type: integer
        format: int32
        description: The number of times the pattern must match.
      streamType:
        type: string
        description: The stream type for which this pattern can be matched on.
        enum:
        - Web
        - Custom
        - Conversation
        - App
      sessionType:
        type: string
        description: The session type for which this pattern can be matched on.
      eventName:
        type: string
        description: The name of the event for which this pattern can be matched on.
  JourneyExternalEventsSchema:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the schema.
      version:
        type: integer
        format: int32
        description: The schema's version, a positive integer.
      enabled:
        type: boolean
        description: The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists.
      dateCreated:
        type: string
        format: date-time
        description: 'The date and time this schema version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      createdBy:
        description: The URI of the user that created this schema.
        readOnly: true
        $ref: '#/definitions/DomainEntityRef'
      jsonSchema:
        description: A JSON schema defining the extension to the built-in entity type.
        $ref: '#/definitions/JourneyJsonSchemaDocument'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  PatchTextStyleProperties:
    type: object
    properties:
      color:
        type: string
        description: 'Color of the text. (eg. #FFFFFF)'
      font:
        type: string
        description: Font of the text. (eg. Helvetica)
      fontSize:
        type: string
        description: Font size of the text. (eg. '12')
      textAlign:
        type: string
        description: Text alignment.
        enum:
        - Left
        - Right
        - Center
  PatchActionTemplate:
    type: object
    required:
    - name
    properties:
      name:
        type: string
        description: Name of the action template.
      description:
        type: string
        description: Description of the action template's functionality.
      version:
        type: integer
        format: int32
        description: The version of the action template.
      mediaType:
        type: string
        description: Media type of action described by the action template.
        enum:
        - webchat
        - webMessagingOffer
        - contentOffer
        - integrationAction
        - architectFlow
        - openAction
      state:
        type: string
        description: Whether the action template is currently active, inactive or deleted.
        enum:
        - Active
        - Inactive
        - Deleted
      contentOffer:
        description: Properties used to configure an action of type content offer
        $ref: '#/definitions/PatchContentOffer'
  EventAction:
    type: object
    required:
    - createdDate
    - id
    - mediaType
    - prompt
    - state
    properties:
      id:
        type: string
        description: ID of the action.
      state:
        type: string
        description: Current state of the action (e.g. qualified, succeeded, errored).
        enum:
        - accepted
        - rejected
        - timedout
        - errored
        - ignored
        - qualified
        - offered
        - started
        - engaged
        - qualifiedOutsideSchedule
        - offeredOutsideSchedule
        - abandoned
        - completed
        - frequencyCapReached
      mediaType:
        type: string
        description: The media type used to deliver the action (e.g. email, webhook).
        enum:
        - webchat
        - webMessagingOffer
        - contentOffer
        - integrationAction
        - architectFlow
        - openAction
      prompt:
        type: string
        description: Prompt of the action to be displayed/sent to the visitor.
      createdDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the action was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  JourneyAggregationView:
    type: object
    required:
    - function
    - name
    - target
    properties:
      target:
        type: string
        description: Target metric name
        enum:
        - nDistinctJourneyActions
        - nDistinctJourneySessions
        - nJourneyActionsBlocked
        - nJourneyOutcomesAchieved
        - nJourneyOutcomesAttributed
        - nJourneySegmentsAssigned
        - nJourneySessions
        - nWebActionsAbandoned
        - nWebActionsAccepted
        - nWebActionsEngaged
        - nWebActionsErrored
        - nWebActionsFrequencyCapReached
        - nWebActionsIgnored
        - nWebActionsOffered
        - nWebActionsOfferedOutsideSchedule
        - nWebActionsQualified
        - nWebActionsQualifiedOutsideSchedule
        - nWebActionsRejected
        - nWebActionsStarted
        - nWebActionsTimedout
        - oJourneyOutcomeTouchpointValue
        - oJourneyOutcomeValue
      name:
        type: string
        description: A unique name for this view. Must be distinct from other views and built-in metric names.
      function:
        type: string
        description: Type of view you wish to create
        enum:
        - rangeBound
      range:
        description: Range of numbers for slicing up data
        $ref: '#/definitions/AggregationRange'
  JourneyViewResultMetrics:
    type: object
    properties:
      participantCount:
        type: integer
        format: int64
        description: number of external contacts who participated at the element
        readOnly: true
      activeCount:
        type: integer
        format: int64
        description: number of external contacts who could still complete the journey
        readOnly: true
      completedCount:
        type: integer
        format: int64
        description: number of external contacts who completed the journey forward
        readOnly: true
      dropoutCount:
        type: integer
        format: int64
        description: number of external contacts who did not make it to the next element
        readOnly: true
      flowCount:
        type: integer
        format: int64
        description: number of external contacts who moved from one element to next element but did not complete the journey
        readOnly: true
    description: 'The metrics of an element or a link in journey '
  WebMessagingOfferProperties:
    type: object
    properties:
      offerText:
        type: string
        description: Text value to be used when inviting a visitor to engage with a web messaging offer.
  JourneySurveyQuestion:
    type: object
    required:
    - label
    properties:
      type:
        type: string
        description: Type of survey question.
        enum:
        - text
        - hidden
        - select
        - checkbox
        - textarea
      label:
        type: string
        description: Label of question.
      customerProperty:
        type: string
        description: The customer property that the answer maps to.
        enum:
        - givenName
        - familyName
        - email
        - phone
        - gender
        - companyName
      choices:
        type: array
        description: Choices available to user.
        items:
          type: string
      isMandatory:
        type: boolean
        description: Whether answering this question is mandatory.
  Event:
    type: object
    required:
    - correlationId
    - createdDate
    - eventType
    - id
    - session
    properties:
      id:
        type: string
        description: System-generated UUID for the event.
      correlationId:
        type: string
        description: UUID corresponding to triggering action that caused this event (e.g. HTTP POST, SIP invite, another event).
      customerId:
        type: string
        description: Primary identifier of the customer in the source of the events.
      customerIdType:
        type: string
        description: Type of primary identifier (e.g. cookie, email, phone).
      session:
        description: The session that the event belongs to.
        $ref: '#/definitions/EventSession'
      eventType:
        type: string
        description: The name representing the type of event.
      outcomeAchievedEvent:
        description: Deprecated. Event where a customer has achieved a specific outcome or goal. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
        $ref: '#/definitions/OutcomeAchievedEvent'
      segmentAssignmentEvent:
        description: Event that represents a segment being assigned.
        $ref: '#/definitions/SegmentAssignmentEvent'
      webActionEvent:
        description: Event triggered by web actions.
        $ref: '#/definitions/WebActionEvent'
      webEvent:
        description: Event that tracks user interactions with content in a browser such as pageviews, downloads, mobile ad clicks, etc.
        $ref: '#/definitions/WebEvent'
      appEvent:
        description: Event that tracks user interactions with content in an application such as screen views, searches, etc.
        $ref: '#/definitions/AppEvent'
      createdDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the event actually took place. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  OutcomePercentileCondition:
    type: object
    required:
    - maximumPercentile
    - outcomeId
    properties:
      outcomeId:
        type: string
        description: The outcome ID.
      maximumPercentile:
        type: number
        format: float
        description: Percentile value for the selected outcome, at or above which the action map will trigger.
      fallbackPercentile:
        type: number
        format: float
        description: Additional percentile condition, where if set, the action map will trigger if the current outcome percentile is lower or equal to the value.
  PatchCtaButtonStyleProperties:
    type: object
    properties:
      color:
        type: string
        description: 'Color of the text. (eg. #FFFFFF)'
      font:
        type: string
        description: Font of the text. (eg. Helvetica)
      fontSize:
        type: string
        description: Font size of the text. (eg. '12')
      textAlign:
        type: string
        description: Text alignment.
        enum:
        - Left
        - Right
        - Center
      backgroundColor:
        type: string
        description: 'Background color of the CTA button. (eg. #A04033)'
  SegmentListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/JourneySegment'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  SegmentForUnassignment:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The ID of the segment to be unassigned.
  ContentOffer:
    type: object
    required:
    - displayMode
    - layoutMode
    properties:
      imageUrl:
        type: string
        description: URL for image displayed to the customer when displaying content offer.
      displayMode:
        type: string
        description: The display mode of Genesys Widgets when displaying content offer.
        enum:
        - Modal
        - Overlay
        - Toast
      layoutMode:
        type: string
        description: The layout mode of the text shown to the user when displaying content offer.
        enum:
        - TextOnly
        - ImageOnly
        - LeftText
        - RightText
        - TopText
        - BottomText
      title:
        type: string
        description: Title used in the header of the content offer.
      headline:
        type: string
        description: Headline displayed above the body text of the content offer.
      body:
        type: string
        description: Body text of the content offer.
      callToAction:
        description: Properties customizing the call to action button on the content offer.
        $ref: '#/definitions/CallToAction'
      style:
        description: Properties customizing the styling of the content offer.
        $ref: '#/definitions/ContentOfferStylingConfiguration'
      imageAltText:
        type: string
        description: Image description text for accessibility compliance and assistive technology support.
  JourneyExternalEventsSchemaListing:
    type: object
    properties:
      total:
        type: integer
        format: int64
      entities:
        type: array
        items:
          $ref: '#/definitions/JourneyExternalEventsSchema'
      selfUri:
        type: string
        format: uri
  AppEventResponseSession:
    type: object
    required:
    - createdDate
    - durationInSeconds
    - eventCount
    - id
    - screenviewCount
    properties:
      id:
        type: string
        description: ID of the app session.
      durationInSeconds:
        type: integer
        format: int32
        description: Indicates how long the customer has been in the app within this session.
      eventCount:
        type: integer
        format: int32
        description: The count of all events recorded during this session.
      screenviewCount:
        type: integer
        format: int32
        description: The count of all screen views recorded during this session.
      referrer:
        description: The referrer of the first event in the app session.
        $ref: '#/definitions/Referrer'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: 'UTC timestamp of the session''s first event, that is when the session starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  NumericRange:
    type: object
    properties:
      gt:
        type: number
        description: Greater than
      gte:
        type: number
        description: Greater than or equal to
      lt:
        type: number
        description: Less than
      lte:
        type: number
        description: Less than or equal to
  JourneyAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/JourneyAggregateDataContainer'
  PatchJourney:
    type: object
    properties:
      patterns:
        type: array
        description: A list of zero or more patterns to match.
        items:
          $ref: '#/definitions/PatchJourneyPattern'
  MinLength:
    type: object
    required:
    - max
    - min
    properties:
      min:
        type: integer
        format: int64
        description: A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance.
      max:
        type: integer
        format: int64
        description: A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance.
  SegmentUnassignments:
    type: object
    required:
    - segments
    properties:
      segments:
        type: array
        description: The segments to be unassigned.
        items:
          $ref: '#/definitions/SegmentForUnassignment'
  UpdateExternalEventRequest:
    type: object
    required:
    - displayName
    - rank
    properties:
      displayName:
        type: string
        description: The display name of the external event
      rank:
        type: integer
        format: int32
        description: The rank of the external event
    description: Request to update an external event
  PatchContentOfferStyleProperties:
    type: object
    properties:
      padding:
        type: string
        description: Padding of the offer. (eg. 10px)
      color:
        type: string
        description: 'Text color of the offer. (eg. #FF0000)'
      backgroundColor:
        type: string
        description: 'Background color of the offer. (eg. #000000)'
  SessionLastEvent:
    type: object
    required:
    - createdDate
    - eventName
    - id
    properties:
      id:
        type: string
        description: The ID of the last event.
      eventName:
        type: string
        description: The name of the event.
      createdDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the event was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  UpdateSegmentAssignmentResponse:
    type: object
    required:
    - unprocessedItems
    properties:
      unprocessedItems:
        description: The segment assignments and unassignments which could not be processed.
        $ref: '#/definitions/UnprocessedSegmentAssignments'
  WebMessagingOfferFields:
    type: object
    properties:
      offerText:
        type: string
        description: Text value to be used when inviting a visitor to engage with a web messaging offer.
      architectFlow:
        description: Flow to be invoked, overrides default flow when specified.
        $ref: '#/definitions/AddressableEntityRef'
  ExternalEventsRequest:
    type: object
    required:
    - entities
    properties:
      entities:
        type: array
        description: External events to ingest.
        items:
          $ref: '#/definitions/ExternalEvent'
        maxItems: 10
        minItems: 1
  ContentOfferStyleProperties:
    type: object
    properties:
      padding:
        type: string
        description: Padding of the offer. (eg. 10px)
      color:
        type: string
        description: 'Text color of the offer. (eg. #FF0000)'
      backgroundColor:
        type: string
        description: 'Background color of the offer. (eg. #000000)'
  RequestDevice:
    type: object
    required:
    - category
    - osFamily
    - osVersion
    - type
    properties:
      category:
        type: string
        description: Device category.
        enum:
        - desktop
        - mobile
        - tablet
        - other
      type:
        type: string
        description: Device type (e.g. iPad, iPhone, Other).
      isMobile:
        type: boolean
        description: Flag that is true for mobile devices.
      screenHeight:
        type: integer
        format: int32
        description: Device's screen height.
      screenWidth:
        type: integer
        format: int32
        description: Device's screen width.
      screenDensity:
        type: integer
        format: int32
        description: Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels.
      fingerprint:
        type: string
        description: Fingerprint generated by looking at the individual device features.
      osFamily:
        type: string
        description: Operating system family.
      osVersion:
        type: string
        description: Operating system version.
      manufacturer:
        type: string
        description: Manufacturer of the device.
  DomainEntityRef:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      selfUri:
        type: string
        format: uri
  PatchAction:
    type: object
    required:
    - mediaType
    properties:
      mediaType:
        type: string
        description: Media type of action.
        enum:
        - webchat
        - webMessagingOffer
        - contentOffer
        - integrationAction
        - architectFlow
        - openAction
      actionTemplate:
        description: Action template associated with the action map.
        $ref: '#/definitions/ActionMapActionTemplate'
      actionTargetId:
        type: string
        description: Deprecated. Action target ID.
      isPacingEnabled:
        type: boolean
        description: Deprecated. Whether this action should be throttled.
      props:
        description: Deprecated. Additional properties.
        $ref: '#/definitions/PatchActionProperties'
      architectFlowFields:
        description: Architect Flow Id and input contract.
        $ref: '#/definitions/ArchitectFlowFields'
      webMessagingOfferFields:
        description: Admin-configurable fields of a web messaging offer action.
        $ref: '#/definitions/PatchWebMessagingOfferFields'
      openActionFields:
        description: Admin-configurable fields of an open action.
        $ref: '#/definitions/OpenActionFields'
  ActivateExternalEventRequest:
    type: object
    required:
    - displayName
    - rank
    properties:
      displayName:
        type: string
        description: The display name of the external event
      rank:
        type: integer
        format: int32
        description: The rank of the external event
    description: Request to activate an external event
  FlowPaths:
    type: object
    required:
    - category
    - elements
    properties:
      category:
        type: string
        description: Category (use case) of the paths within a given domain.
        enum:
        - All
        - Abandoned
        - AgentEscalation
        - Complete
        - Disconnect
        - Error
        - RecognitionFailure
        - Transfer
      dateStart:
        type: string
        format: date-time
        description: 'Start date of the date range included in the flow paths data. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateEnd:
        type: string
        format: date-time
        description: 'End date of the date range included in the flow paths data. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      elements:
        type: object
        description: Unique element identifiers and their corresponding elements in the trie data structure representing the paths.
        additionalProperties:
          $ref: '#/definitions/FlowPathsElement'
  UnprocessedExternalEvent:
    type: object
    required:
    - errorMessage
    - event
    - isRetryable
    - originalRequestIndex
    properties:
      event:
        description: The event that failed processing.
        $ref: '#/definitions/ExternalEvent'
      originalRequestIndex:
        type: integer
        format: int32
        description: The index of the event in the original request.
      isRetryable:
        type: boolean
        description: Whether the error is retryable.
      errorMessage:
        type: string
        description: The error message.
      statusCode:
        type: integer
        format: int32
        description: The HTTP status code associated with the error.
  JourneyViewElement:
    type: object
    required:
    - attributes
    - id
    - name
    properties:
      id:
        type: string
        description: The unique identifier of the element within the elements list
      name:
        type: string
        description: The unique name of the element within the view
      attributes:
        description: Required attributes of the element
        $ref: '#/definitions/JourneyViewElementAttributes'
      displayAttributes:
        description: Attributes that defines the visualization of the element in the journey view
        $ref: '#/definitions/JourneyViewElementDisplayAttributes'
      filter:
        description: Any filters applied to this element
        $ref: '#/definitions/JourneyViewElementFilter'
      followedBy:
        type: array
        description: A list of JourneyViewLink objects, listing the elements downstream of this element
        items:
          $ref: '#/definitions/JourneyViewLink'
    description: An element within a journey view
  ArchitectFlowFields:
    type: object
    properties:
      architectFlow:
        description: The architect flow.
        $ref: '#/definitions/AddressableEntityRef'
      flowRequestMappings:
        type: array
        description: Collection of Architect Flow Request Mappings to use.
        items:
          $ref: '#/definitions/RequestMapping'
  FlowPathsFlowFilter:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The identifier of the flow.
  ActionMapListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ActionMap'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  SegmentAssignments:
    type: object
    required:
    - segments
    properties:
      segments:
        type: array
        description: The segments to be assigned.
        items:
          $ref: '#/definitions/SegmentForAssignment'
  ContextPattern:
    type: object
    required:
    - criteria
    properties:
      criteria:
        type: array
        description: A list of one or more criteria to satisfy.
        items:
          $ref: '#/definitions/EntityTypeCriteria'
  ActionSurvey:
    type: object
    required:
    - questions
    properties:
      questions:
        type: array
        description: Questions shown to the user.
        items:
          $ref: '#/definitions/JourneySurveyQuestion'
  CustomEventAttributeList:
    type: object
    required:
    - dataType
    - values
    properties:
      dataType:
        type: string
        description: The data type of the custom attributes.
      values:
        type: array
        description: The list of custom event attribute values.
        items:
          type: string
  ActionMapScheduleGroups:
    type: object
    required:
    - actionMapScheduleGroup
    properties:
      actionMapScheduleGroup:
        description: The actions map's associated schedule group.
        $ref: '#/definitions/ActionMapScheduleGroup'
      emergencyActionMapScheduleGroup:
        description: The action map's associated emergency schedule group.
        $ref: '#/definitions/ActionMapScheduleGroup'
  JourneySchemaUpdateRequest:
    type: object
    required:
    - enabled
    - jsonSchema
    - version
    properties:
      version:
        type: integer
        format: int32
        description: The schema's version, a positive integer.
      enabled:
        type: boolean
        description: The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists.
      jsonSchema:
        description: A JSON schema defining the extension to the built-in entity type.
        $ref: '#/definitions/JourneyJsonSchemaRequest'
    description: Update an external event schema
  ActionMapEstimateRequest:
    type: object
    properties:
      segmentIds:
        type: array
        description: List of Segment IDs.
        items:
          type: string
      outcomeCriteria:
        description: Outcome Criteria containing outcomeId and probability thresholds.
        $ref: '#/definitions/ActionMapEstimateOutcomeCriteria'
  PatchCallToAction:
    type: object
    properties:
      text:
        type: string
        description: Text displayed on the call to action button.
      url:
        type: string
        description: URL to open when user clicks on the call to action button.
      target:
        type: string
        description: Where the URL should be opened when the user clicks on the call to action button.
        enum:
        - Blank
        - Self
  JourneyAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/JourneyAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  JourneyAggregateQueryClause:
    type: object
    required:
    - predicates
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates
        enum:
        - and
        - or
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/JourneyAggregateQueryPredicate'
  JourneyViewElementDisplayAttributes:
    type: object
    required:
    - col
    - x
    - y
    properties:
      x:
        type: integer
        format: int32
        description: The horizontal position (x-coordinate) of the element on the journey view canvas
      y:
        type: integer
        format: int32
        description: The vertical position (y-coordinate) of the element on the journey view canvas
      col:
        type: integer
        format: int32
        description: The column position for the element in the journey view canvas
    description: Display attributes for an element in a journey view
  RequestCriteria:
    type: object
    required:
    - key
    - values
    properties:
      key:
        type: string
        description: The criteria key.
      values:
        type: array
        description: The criteria values.
        items:
          type: string
      shouldIgnoreCase:
        type: boolean
        description: Should criteria be case insensitive.
      operator:
        type: string
        description: The comparison operator.
        enum:
        - containsAll
        - containsAny
        - notContainsAll
        - notContainsAny
        - equal
        - notEqual
        - greaterThan
        - greaterThanOrEqual
        - lessThan
        - lessThanOrEqual
        - startsWith
        - endsWith
  NetworkConnectivity:
    type: object
    required:
    - bluetoothEnabled
    - cellularEnabled
    - wifiEnabled
    properties:
      carrier:
        type: string
        description: The name of the network carrier.
      bluetoothEnabled:
        type: boolean
        description: Whether Bluetooth is enabled.
      cellularEnabled:
        type: boolean
        description: Whether Cellular is enabled.
      wifiEnabled:
        type: boolean
        description: Whether Wi-Fi is enabled.
  OutcomeRefRequest:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: ID of outcome.
  ServiceLevel:
    type: object
    properties:
      percentage:
        type: number
        format: double
        description: The desired Service Level. A value between 0 and 1.
      durationMs:
        type: integer
        format: int64
        description: Service Level target in milliseconds.
  JourneyAsyncAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - containsAllCondition
          - containsAnyCondition
          - endsWithCondition
          - equalCondition
          - journeyActionId
          - journeyActionMapId
          - journeyActionMapVersion
          - journeyActionMediaType
          - journeyActionTargetId
          - journeyActionTemplateId
          - journeyBlockingActionMapId
          - journeyBlockingEmergencyScheduleGroupId
          - journeyBlockingReason
          - journeyBlockingScheduleGroupId
          - journeyDeviceCategory
          - journeyDeviceType
          - journeyFrequencyCapReason
          - journeyIpGeolocationCountry
          - journeyOutcomeId
          - journeySegmentAssignmentState
          - journeySegmentId
          - journeySessionId
          - journeySessionSegmentId
          - journeySessionType
          - notContainsAllCondition
          - notContainsAnyCondition
          - notEqualCondition
          - startsWithCondition
          - touchpointActionMapId
          - touchpointAgentId
          - touchpointAttributionScope
          - touchpointChannelMessageType
          - touchpointChannelPlatform
          - touchpointChannelType
          - touchpointConversationId
          - touchpointInteractionType
          - touchpointQueueId
          - touchpointRequestedRouting
          - touchpointUsedRouting
          - touchpointWrapupCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/JourneyAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nDistinctJourneyActions
          - nDistinctJourneySessions
          - nJourneyActionsBlocked
          - nJourneyOutcomesAchieved
          - nJourneyOutcomesAttributed
          - nJourneySegmentsAssigned
          - nJourneySessions
          - nWebActionsAbandoned
          - nWebActionsAccepted
          - nWebActionsEngaged
          - nWebActionsErrored
          - nWebActionsFrequencyCapReached
          - nWebActionsIgnored
          - nWebActionsOffered
          - nWebActionsOfferedOutsideSchedule
          - nWebActionsQualified
          - nWebActionsQualifiedOutsideSchedule
          - nWebActionsRejected
          - nWebActionsStarted
          - nWebActionsTimedout
          - oJourneyOutcomeTouchpointValue
          - oJourneyOutcomeValue
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/JourneyAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  JourneyAggregationQuery:
    type: object
    required:
    - interval
    - metrics
    properties:
      interval:
        type: string
        format: interval
        description: 'Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
        x-genesys-entity-type:
          value: INTERVAL
      granularity:
        type: string
        description: 'Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      timeZone:
        type: string
        description: 'Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London'
      groupBy:
        type: array
        description: Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - containsAllCondition
          - containsAnyCondition
          - endsWithCondition
          - equalCondition
          - journeyActionId
          - journeyActionMapId
          - journeyActionMapVersion
          - journeyActionMediaType
          - journeyActionTargetId
          - journeyActionTemplateId
          - journeyBlockingActionMapId
          - journeyBlockingEmergencyScheduleGroupId
          - journeyBlockingReason
          - journeyBlockingScheduleGroupId
          - journeyDeviceCategory
          - journeyDeviceType
          - journeyFrequencyCapReason
          - journeyIpGeolocationCountry
          - journeyOutcomeId
          - journeySegmentAssignmentState
          - journeySegmentId
          - journeySessionId
          - journeySessionSegmentId
          - journeySessionType
          - notContainsAllCondition
          - notContainsAnyCondition
          - notEqualCondition
          - startsWithCondition
          - touchpointActionMapId
          - touchpointAgentId
          - touchpointAttributionScope
          - touchpointChannelMessageType
          - touchpointChannelPlatform
          - touchpointChannelType
          - touchpointConversationId
          - touchpointInteractionType
          - touchpointQueueId
          - touchpointRequestedRouting
          - touchpointUsedRouting
          - touchpointWrapupCode
      filter:
        description: Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
        $ref: '#/definitions/JourneyAggregateQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nDistinctJourneyActions
          - nDistinctJourneySessions
          - nJourneyActionsBlocked
          - nJourneyOutcomesAchieved
          - nJourneyOutcomesAttributed
          - nJourneySegmentsAssigned
          - nJourneySessions
          - nWebActionsAbandoned
          - nWebActionsAccepted
          - nWebActionsEngaged
          - nWebActionsErrored
          - nWebActionsFrequencyCapReached
          - nWebActionsIgnored
          - nWebActionsOffered
          - nWebActionsOfferedOutsideSchedule
          - nWebActionsQualified
          - nWebActionsQualifiedOutsideSchedule
          - nWebActionsRejected
          - nWebActionsStarted
          - nWebActionsTimedout
          - oJourneyOutcomeTouchpointValue
          - oJourneyOutcomeValue
      flattenMultivaluedDimensions:
        type: boolean
        description: Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
      views:
        type: array
        description: Custom derived metric views
        items:
          $ref: '#/definitions/JourneyAggregationView'
      alternateTimeDimension:
        type: string
        description: Dimension to use as the alternative timestamp for data in the aggregate.  Choosing "eventTime" uses the actual time of the data event.
        enum:
        - eventTime
  PatchContext:
    type: object
    properties:
      patterns:
        type: array
        description: A list of one or more patterns to match.
        items:
          $ref: '#/definitions/PatchContextPattern'
  Detail:
    type: object
    properties:
      errorCode:
        type: string
      fieldName:
        type: string
      entityId:
        type: string
      entityName:
        type: string
  PatchActionMap:
    type: object
    required:
    - displayName
    - pageUrlConditions
    - triggerWithSegments
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      version:
        type: integer
        format: int32
        description: The version of the action map.
      isActive:
        type: boolean
        description: Whether the action map is active.
      displayName:
        type: string
        description: Display name of the action map.
      triggerWithSegments:
        type: array
        description: Trigger action map if any segment in the list is assigned to a given customer.
        items:
          type: string
      triggerWithEventConditions:
        type: array
        description: List of event conditions that must be satisfied to trigger the action map.
        items:
          $ref: '#/definitions/EventCondition'
      triggerWithOutcomeProbabilityConditions:
        type: array
        description: Deprecated. Probability conditions for outcomes that must be satisfied to trigger the action map.
        items:
          $ref: '#/definitions/OutcomeProbabilityCondition'
      triggerWithOutcomePercentileConditions:
        type: array
        description: Deprecated. Percentile conditions for outcomes that must be satisfied to trigger the action map.
        items:
          $ref: '#/definitions/OutcomePercentileCondition'
      triggerWithOutcomeQuantileConditions:
        type: array
        description: Deprecated. Quantile conditions for outcomes that must be satisfied to trigger the action map. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
        items:
          $ref: '#/definitions/OutcomeQuantileCondition'
      pageUrlConditions:
        type: array
        description: URL conditions that a page must match for web actions to be displayable.
        items:
          $ref: '#/definitions/UrlCondition'
      activation:
        description: Type of activation.
        $ref: '#/definitions/Activation'
      weight:
        type: integer
        format: int32
        description: Weight of the action map with higher number denoting higher weight.
      action:
        description: The action that will be executed if this action map is triggered.
        $ref: '#/definitions/PatchAction'
      actionMapScheduleGroups:
        description: The action map's associated schedule groups.
        $ref: '#/definitions/PatchActionMapScheduleGroups'
      ignoreFrequencyCap:
        type: boolean
        description: Override organization-level frequency cap and always offer web engagements from this action map.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      modifiedDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      startDate:
        type: string
        format: date-time
        description: 'Timestamp at which the action map is scheduled to start firing. 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: 'Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  SegmentEstimateCount:
    type: object
    properties:
      segmentId:
        type: string
        description: ID of Segment.
      count:
        type: integer
        format: int32
        description: Estimate count per segment.
  UpdateExternalEventResponse:
    type: object
    properties:
      schemaId:
        type: string
        description: The schema ID of the external event
        readOnly: true
      eventName:
        type: string
        description: The name of the external event
        readOnly: true
      displayName:
        type: string
        description: The display name of the external event
        readOnly: true
      rank:
        type: integer
        format: int32
        description: The rank of the external event
        readOnly: true
      activationStatus:
        type: string
        description: The activation status of the external event
        readOnly: true
        enum:
        - Activated
        - Deactivated
    description: Response for updating an external event definition
  ResponsePage:
    type: object
    required:
    - domain
    - hostname
    - pathname
    - title
    - url
    properties:
      url:
        type: string
        description: The page URL.
      title:
        type: string
        description: Title of the page.
      domain:
        type: string
        description: Domain of the page's URL.
      fragment:
        type: string
        description: Fragment or hash of the page's URL.
      hostname:
        type: string
        description: Hostname of the page's URL.
      keywords:
        type: string
        description: Keywords from the HTML <meta> tag of the page.
      lang:
        type: string
        description: ISO 639-1 language code for the page as defined in the <html> tag.
      pathname:
        type: string
        description: Path name of the page for the event.
      queryString:
        type: string
        description: Query string that is passed to the page in the current event.
  ActionMap:
    type: object
    required:
    - displayName
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      version:
        type: integer
        format: int32
        description: The version of the action map.
      isActive:
        type: boolean
        description: Whether the action map is active.
      displayName:
        type: string
        description: Display name of the action map.
      triggerWithSegments:
        type: array
        description: Trigger action map if any segment in the list is assigned to a given customer.
        items:
          type: string
      triggerWithEventConditions:
        type: array
        description: List of event conditions that must be satisfied to trigger the action map.
        items:
          $ref: '#/definitions/EventCondition'
      triggerWithOutcomeProbabilityConditions:
        type: array
        description: Deprecated. Probability conditions for outcomes that must be satisfied to trigger the action map.
        items:
          $ref: '#/definitions/OutcomeProbabilityCondition'
      triggerWithOutcomePercentileConditions:
        type: array
        description: Deprecated. Percentile conditions for outcomes that must be satisfied to trigger the action map.
        items:
          $ref: '#/definitions/OutcomePercentileCondition'
      triggerWithOutcomeQuantileConditions:
        type: array
        description: Deprecated. Quantile conditions for outcomes that must be satisfied to trigger the action map. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
        items:
          $ref: '#/definitions/OutcomeQuantileCondition'
      pageUrlConditions:
        type: array
        description: URL conditions that a page must match for web actions to be displayable.
        items:
          $ref: '#/definitions/UrlCondition'
      activation:
        description: Type of activation.
        $ref: '#/definitions/Activation'
      weight:
        type: integer
        format: int32
        description: Weight of the action map with higher number denoting higher weight.
      action:
        description: The action that will be executed if this action map is triggered.
        $ref: '#/definitions/ActionMapAction'
      actionMapScheduleGroups:
        description: The action map's associated schedule groups.
        $ref: '#/definitions/ActionMapScheduleGroups'
      ignoreFrequencyCap:
        type: boolean
        description: Override organization-level frequency cap and always offer web engagements from this action map.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      modifiedDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      startDate:
        type: string
        format: date-time
        description: 'Timestamp at which the action map is scheduled to start firing. 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: 'Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  OutcomeRequest:
    type: object
    required:
    - displayName
    properties:
      isActive:
        type: boolean
        description: Whether or not the outcome is active.
      displayName:
        type: string
        description: The display name of the outcome.
      version:
        type: integer
        format: int32
        description: The version of the outcome.
      description:
        type: string
        description: A description of the outcome.
      isPositive:
        type: boolean
        description: Whether or not the outcome is positive.
      context:
        description: The context of the outcome.
        $ref: '#/definitions/RequestContext'
      journey:
        description: The pattern of rules defining the filter of the outcome.
        $ref: '#/definitions/RequestJourney'
      associatedValueField:
        description: The field from the event indicating the associated value.
        $ref: '#/definitions/AssociatedValueField'
  ConversationChannel:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: The type or category of this channel.
        enum:
        - Unknown
        - Call
        - Callback
        - Email
        - GenericObject
        - Messaging
        - Social
        - Webchat
        - Voice
        - Chat
        - Cobrowse
        - Video
        - Screenshare
        - Message
        - InternalMessage
      messageType:
        type: string
        description: Message type for messaging conversations.
        enum:
        - Unknown
        - Sms
        - Twitter
        - Facebook
        - Line
        - WhatsApp
        - WebMessaging
        - Open
        - Instagram
        - Apple
      platform:
        type: string
        description: The source provider for the conversation (e.g. Edge, PureCloud Messaging, PureCloud Email).
  OutcomeScoresResult:
    type: object
    properties:
      outcomeScores:
        type: array
        description: List of scored outcomes in the session.
        items:
          $ref: '#/definitions/OutcomeScore'
      modifiedDate:
        type: string
        format: date-time
        description: 'Timestamp indicating the last time that the event was scored. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
  JourneyViewJobListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/JourneyViewJob'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  EstimateJobAsyncResponse:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  JourneyAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/StatisticalResponse'
  ValidationLimits:
    type: object
    properties:
      minLength:
        $ref: '#/definitions/MinLength'
      maxLength:
        $ref: '#/definitions/MaxLength'
      minItems:
        $ref: '#/definitions/MinLength'
      maxItems:
        $ref: '#/definitions/MaxLength'
      minimum:
        $ref: '#/definitions/MinLength'
      maximum:
        $ref: '#/definitions/MaxLength'
  JourneyViewJob:
    type: object
    required:
    - dateCompleted
    - dateCompletionEstimated
    - dateCreated
    - estimatedCompletionMargin
    - journeyView
    - status
    - userId
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp of execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateCompleted:
        type: string
        format: date-time
        description: 'Timestamp of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      status:
        type: string
        description: The status of the job
        enum:
        - Accepted
        - Executing
        - Complete
        - Failed
        - Cancelled
        - Scheduled
      journeyView:
        description: The journey view for which the job is executed
        $ref: '#/definitions/JourneyView'
      dateCompletionEstimated:
        type: string
        format: date-time
        description: 'Timestamp for the estimated time of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      estimatedCompletionMargin:
        type: integer
        format: int64
        description: Margin of error of the estimated time of completion
        readOnly: true
      userId:
        type: string
        description: Id of the user who submitted the request
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  JourneyViewChartMetric:
    type: object
    required:
    - elementId
    - id
    properties:
      id:
        type: string
        description: The unique identifier of the metric within the chart
      elementId:
        type: string
        description: The element in the list of elements which the metric is measuring
      aggregate:
        type: string
        description: How to aggregate the given element, defaults to CustomerCount
        enum:
        - EventCount
        - CustomerCount
        - Minimum
        - Maximum
        - Average
        - Sum
      displayLabel:
        type: string
        description: A display label for the metric
    description: A metric to measure within the chart
  ExternalEventsConfigurationListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ExternalEventsConfiguration'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  AppEventResponse:
    type: object
    required:
    - app
    - attributes
    - createdDate
    - customerId
    - customerIdType
    - device
    - eventName
    - id
    - screenName
    - session
    - traits
    properties:
      id:
        type: string
        description: System-generated UUID for the event.
      customerId:
        type: string
        description: Identifier of the customer in the source of the event.
      customerIdType:
        type: string
        description: Type of identifier for the customer ID (cookie, email etc.).
      eventName:
        type: string
        description: Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. screen_viewed, order_completed, user_registered).
      screenName:
        type: string
        description: The name of the screen in the app that the event took place.
      app:
        description: Application that the customer is interacting with.
        $ref: '#/definitions/JourneyApp'
      device:
        description: Customer's device.
        $ref: '#/definitions/Device'
      ipOrganization:
        type: string
        description: Customer's IP-based organization or ISP name.
      geolocation:
        description: Customer's geolocation.
        $ref: '#/definitions/JourneyGeolocation'
      sdkLibrary:
        description: SDK library used to generate the event.
        $ref: '#/definitions/SdkLibrary'
      networkConnectivity:
        description: Information relating to the device's network connectivity.
        $ref: '#/definitions/NetworkConnectivity'
      mktCampaign:
        description: Marketing / traffic source information.
        $ref: '#/definitions/JourneyCampaign'
      session:
        description: The app session the event belongs to.
        $ref: '#/definitions/AppEventResponseSession'
      searchQuery:
        type: string
        description: Represents the keywords in a customer search query.
      attributes:
        type: object
        description: User-defined attributes associated with a particular event.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      traits:
        type: object
        description: Traits are attributes intrinsic to the customer that may be sent in selected events (e.g. email, givenName, cellPhone).
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      externalId:
        type: string
        description: An external identifier for the customer.
      createdDate:
        type: string
        format: date-time
        description: 'UTC timestamp indicating when the event actually took place. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  PatchOutcome:
    type: object
    required:
    - displayName
    properties:
      isActive:
        type: boolean
        description: Whether or not the outcome is active.
      displayName:
        type: string
        description: The display name of the outcome.
      version:
        type: integer
        format: int32
        description: The version of the outcome.
      description:
        type: string
        description: A description of the outcome.
      isPositive:
        type: boolean
        description: Whether or not the outcome is positive.
      context:
        description: The context of the outcome.
        $ref: '#/definitions/PatchContext'
      journey:
        description: The pattern of rules defining the filter of the outcome.
        $ref: '#/definitions/PatchJourney'
      associatedValueField:
        description: The field from the event indicating the associated value.
        $ref: '#/definitions/PatchAssociatedValueField'
  PatchContentOfferStylingConfiguration:
    type: object
    properties:
      position:
        description: Properties for customizing the positioning of the content offer.
        $ref: '#/definitions/PatchContentPositionProperties'
      offer:
        description: Properties for customizing the appearance of the content offer.
        $ref: '#/definitions/PatchContentOfferStyleProperties'
      closeButton:
        description: Properties for customizing the appearance of the close button.
        $ref: '#/definitions/PatchCloseButtonStyleProperties'
      ctaButton:
        description: Properties for customizing the appearance of the CTA button.
        $ref: '#/definitions/PatchCtaButtonStyleProperties'
      title:
        description: Properties for customizing the appearance of the title text.
        $ref: '#/definitions/PatchTextStyleProperties'
      headline:
        description: Properties for customizing the appearance of the headline text.
        $ref: '#/definitions/PatchTextStyleProperties'
      body:
        description: Properties for customizing the appearance of the body text.
        $ref: '#/definitions/PatchTextStyleProperties'
  ExternalEventChangesResponse:
    type: object
    properties:
      changes:
        type: array
        description: The list of changes
        readOnly: true
        items:
          $ref: '#/definitions/ExternalEventChange'
    description: Response for getting changes in external event definitions
  JourneyViewResultLink:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      connectionCount:
        type: integer
        format: int64
        description: the number of connections for the journey view link
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Represents a link between 2 elements in a journey view result
  SegmentForAssignment:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The ID of the segment to be assigned.
  AchievedOutcome:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The ID of the outcome achieved.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ExternalEventExternalId:
    type: object
    required:
    - externalSourceId
    - value
    properties:
      value:
        type: string
        description: The value of the identifier.
      externalSourceId:
        type: string
        description: The id of the external source.
  OutcomeAchievement:
    type: object
    required:
    - achievedDate
    - outcome
    properties:
      outcome:
        description: The outcome that was achieved.
        $ref: '#/definitions/AchievedOutcome'
      achievedDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the outcome was achieved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  WebEvent:
    type: object
    required:
    - attributes
    - authenticated
    - browser
    - device
    - eventName
    - page
    - totalEventCount
    - totalPageviewCount
    - traits
    - userAgentString
    properties:
      eventName:
        type: string
        description: Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. page_viewed, order_completed, user_registered).
      totalEventCount:
        type: integer
        format: int32
        description: The total count of events performed by the customer across all sessions.
      totalPageviewCount:
        type: integer
        format: int32
        description: The total count of pageviews performed by the customer across all sessions.
      page:
        description: The webpage where the user interaction occurred.
        $ref: '#/definitions/JourneyPage'
      userAgentString:
        type: string
        description: HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15).
      browser:
        description: Customer's browser.
        $ref: '#/definitions/Browser'
      device:
        description: Customer's device.
        $ref: '#/definitions/Device'
      geolocation:
        description: Customer's geolocation.
        $ref: '#/definitions/JourneyGeolocation'
      ipAddress:
        type: string
        description: Customer's IP address. May be null if the business configures the tracker to not collect IP addresses.
      ipOrganization:
        type: string
        description: Customer's IP-based organization or ISP name.
      mktCampaign:
        description: Marketing / traffic source information.
        $ref: '#/definitions/JourneyCampaign'
      referrer:
        description: Identifies the page URL that originally generated the request for the current page being viewed.
        $ref: '#/definitions/Referrer'
      attributes:
        type: object
        description: User-defined attributes associated with a particular event.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      traits:
        type: object
        description: User-defined traits associated with a particular event.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      searchQuery:
        type: string
        description: Represents the keywords in a customer search query.
      authenticated:
        type: boolean
        description: Indicates whether the event was produced during an authenticated session.
  Device:
    type: object
    required:
    - category
    - isMobile
    - osFamily
    - osVersion
    - type
    properties:
      category:
        type: string
        description: Device category.
        enum:
        - desktop
        - mobile
        - tablet
        - other
      type:
        type: string
        description: Device type (e.g. iPad, iPhone, Other).
      isMobile:
        type: boolean
        description: Flag that is true for mobile devices.
      screenHeight:
        type: integer
        format: int32
        description: Device's screen height.
      screenWidth:
        type: integer
        format: int32
        description: Device's screen width.
      screenDensity:
        type: integer
        format: int32
        description: Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels.
      fingerprint:
        type: string
        description: Fingerprint generated by looking at the individual device features.
      osFamily:
        type: string
        description: Operating system family.
      osVersion:
        type: string
        description: Operating system version.
      manufacturer:
        type: string
        description: Manufacturer of the device.
  AggregateMetricData:
    type: object
    properties:
      metric:
        type: string
      qualifier:
        type: string
      stats:
        $ref: '#/definitions/StatisticalSummary'
  PatchContextPattern:
    type: object
    properties:
      criteria:
        type: array
        description: A list of one or more criteria to satisfy.
        items:
          $ref: '#/definitions/PatchEntityTypeCriteria'
  GroupByAttribute:
    type: object
    properties:
      attribute:
        type: string
        description: Group by attribute
        readOnly: true
      value:
        type: string
        description: Value of this group by attribute
        readOnly: true
  PatchContentOffer:
    type: object
    properties:
      imageUrl:
        type: string
        description: URL for image displayed to the customer when displaying content offer.
      displayMode:
        type: string
        description: The display mode of Genesys Widgets when displaying content offer.
        enum:
        - Modal
        - Overlay
        - Toast
      layoutMode:
        type: string
        description: The layout mode of the text shown to the user when displaying content offer.
        enum:
        - TextOnly
        - ImageOnly
        - LeftText
        - RightText
        - TopText
        - BottomText
      title:
        type: string
        description: Title used in the header of the content offer.
      headline:
        type: string
        description: Headline displayed above the body text of the content offer.
      body:
        type: string
        description: Body text of the content offer.
      callToAction:
        description: Properties customizing the call to action button on the content offer.
        $ref: '#/definitions/PatchCallToAction'
      style:
        description: Properties customizing the styling of the content offer.
        $ref: '#/definitions/PatchContentOfferStylingConfiguration'
      imageAltText:
        type: string
        description: Image description text for accessibility compliance and assistive technology support.
  Context:
    type: object
    required:
    - patterns
    properties:
      patterns:
        type: array
        description: A list of one or more patterns to match.
        items:
          $ref: '#/definitions/ContextPattern'
  JourneyViewChartDisplayAttributes:
    type: object
    properties:
      type:
        type: string
        description: The type of chart to display
        enum:
        - Column
        - Bar
        - Line
      groupByTitle:
        type: string
        description: A title for the grouped by attributes (aka the x axis)
      metricsTitle:
        type: string
        description: A title for the metrics (aka the y axis)
      showLegend:
        type: boolean
        description: Whether to show a legend
    description: Display attributes for the chart, such as type, labels and legends
  OpenActionProperties:
    type: object
    properties:
      openActionName:
        type: string
        description: The specific type of the open action.
      configurationFields:
        type: object
        description: Custom fields defined in the schema referenced by the open action type selected.
        additionalProperties:
          type: object
  Criteria:
    type: object
    required:
    - key
    - operator
    - shouldIgnoreCase
    - values
    properties:
      key:
        type: string
        description: The criteria key.
      values:
        type: array
        description: The criteria values.
        items:
          type: string
      shouldIgnoreCase:
        type: boolean
        description: Should criteria be case insensitive.
      operator:
        type: string
        description: The comparison operator.
        enum:
        - containsAll
        - containsAny
        - notContainsAll
        - notContainsAny
        - equal
        - notEqual
        - greaterThan
        - greaterThanOrEqual
        - lessThan
        - lessThanOrEqual
        - startsWith
        - endsWith
  ContentOfferStylingConfiguration:
    type: object
    properties:
      position:
        description: Properties for customizing the positioning of the content offer.
        $ref: '#/definitions/ContentPositionProperties'
      offer:
        description: Properties for customizing the appearance of the content offer.
        $ref: '#/definitions/ContentOfferStyleProperties'
      closeButton:
        description: Properties for customizing the appearance of the close button.
        $ref: '#/definitions/CloseButtonStyleProperties'
      ctaButton:
        description: Properties for customizing the appearance of the CTA button.
        $ref: '#/definitions/CtaButtonStyleProperties'
      title:
        description: Properties for customizing the appearance of the title text.
        $ref: '#/definitions/TextStyleProperties'
      headline:
        description: Properties for customizing the appearance of the headline text.
        $ref: '#/definitions/TextStyleProperties'
      body:
        description: Properties for customizing the appearance of the body text.
        $ref: '#/definitions/TextStyleProperties'
  Browser:
    type: object
    required:
    - family
    - featuresFlash
    - featuresJava
    - featuresPdf
    - featuresWebrtc
    - version
    properties:
      family:
        type: string
        description: Browser family (e.g. Chrome, Safari, Firefox).
      version:
        type: string
        description: Browser version (e.g. 68.0.3440.84).
      lang:
        type: string
        description: Language the browser is set to. Must conform to BCP 47.
      fingerprint:
        type: string
        description: Fingerprint generated by looking at the individual browser features.
      isMobile:
        type: boolean
        description: (Deprecated, use Device.isMobile instead) Flag that is true for mobile devices.
      viewHeight:
        type: integer
        format: int32
        description: Browser's viewport height.
      viewWidth:
        type: integer
        format: int32
        description: Browser's viewport width.
      featuresFlash:
        type: boolean
        description: Whether Flash is installed.
      featuresJava:
        type: boolean
        description: Whether Java is installed.
      featuresPdf:
        type: boolean
        description: Whether the browser recognizes PDFs.
      featuresWebrtc:
        type: boolean
        description: Whether WebRTC is supported.
  JourneyViewChartMetricResultValue:
    type: object
    properties:
      value:
        description: Value for this metric
        readOnly: true
        $ref: '#/definitions/Number'
      groupByAttributes:
        type: array
        description: Group by attributes for this metric
        readOnly: true
        items:
          $ref: '#/definitions/GroupByAttribute'
  OutcomeRef:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  PatchActionSurvey:
    type: object
    required:
    - questions
    properties:
      questions:
        type: array
        description: Questions shown to the user.
        items:
          $ref: '#/definitions/PatchSurveyQuestion'
  ActionEventActionMap:
    type: object
    required:
    - displayName
    - id
    - version
    properties:
      id:
        type: string
        description: The ID of the action map.
      selfUri:
        type: string
        format: uri
      version:
        type: integer
        format: int32
        description: The version of the action map.
      displayName:
        type: string
        description: Display name of the action map.
  JourneyAggregateQueryFilter:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Boolean operation to apply to the provided predicates and clauses
        enum:
        - and
        - or
      clauses:
        type: array
        description: Boolean 'and/or' logic with up to two-levels of nesting
        items:
          $ref: '#/definitions/JourneyAggregateQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/JourneyAggregateQueryPredicate'
  CreateExternalEventsConfigurationRequest:
    type: object
    required:
    - description
    - divisionId
    - name
    - schemaId
    - source
    properties:
      name:
        type: string
        description: The name of the external event configuration.
      description:
        type: string
        description: A description of the external event configuration.
      divisionId:
        type: string
        description: The division ID associated with this configuration.
      schemaId:
        type: string
        description: The dynamic schema ID that defines the structure of external events.
      source:
        type: string
        description: The source of the external events e.g. Adobe, Salesforce. This cannot be changed after creation.
  PatchEntityTypeCriteria:
    type: object
    properties:
      key:
        type: string
        description: The criteria key.
      values:
        type: array
        description: The criteria values.
        items:
          type: string
      shouldIgnoreCase:
        type: boolean
        description: Should criteria be case insensitive.
      operator:
        type: string
        description: The comparison operator.
        enum:
        - containsAll
        - containsAny
        - notContainsAll
        - notContainsAny
        - equal
        - notEqual
        - greaterThan
        - greaterThanOrEqual
        - lessThan
        - lessThanOrEqual
        - startsWith
        - endsWith
      entityType:
        type: string
        description: The entity to match the pattern against.
        enum:
        - visit
  CloseButtonStyleProperties:
    type: object
    properties:
      color:
        type: string
        description: 'Color of button. (eg. #FF0000)'
      opacity:
        type: number
        format: float
        description: Opacity of button.
  JourneyViewChart:
    type: object
    required:
    - metrics
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      version:
        type: integer
        format: int32
        description: The version of the journey view chart
        readOnly: true
      rank:
        type: integer
        format: int32
        description: The rank of the journey view chart for ordering display
      groupByTime:
        type: string
        description: A time unit to group the metrics by. There is a limit on the number of groupBy properties which can be specified.
        enum:
        - Day
        - Week
        - Month
        - Year
      groupByAttributes:
        type: array
        description: A list of attributes to group the metrics by. There is a limit on the number of groupBy properties which can be specified.
        items:
          $ref: '#/definitions/JourneyViewChartGroupByAttribute'
      metrics:
        type: array
        description: A list of metrics to calculate within the chart by (aka the y axis)
        items:
          $ref: '#/definitions/JourneyViewChartMetric'
      displayAttributes:
        description: Optional display attributes for rendering the chart
        $ref: '#/definitions/JourneyViewChartDisplayAttributes'
      groupByMax:
        type: integer
        format: int64
        description: A maximum on the number of values being grouped by
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: A chart within the context of the elements of the the journey view
  PatchContentPositionProperties:
    type: object
    properties:
      top:
        type: string
        description: Top positioning offset.
      bottom:
        type: string
        description: Bottom positioning offset.
      left:
        type: string
        description: Left positioning offset.
      right:
        type: string
        description: Right positioning offset.
  RequestContextPattern:
    type: object
    required:
    - criteria
    properties:
      criteria:
        type: array
        description: A list of one or more criteria to satisfy.
        items:
          $ref: '#/definitions/RequestEntityTypeCriteria'
  JourneyViewElementFilterPredicate:
    type: object
    required:
    - dimension
    - values
    properties:
      dimension:
        type: string
        description: the element's attribute being filtered on
      values:
        type: array
        description: the values of the attribute to filter on
        items:
          type: string
      operator:
        type: string
        description: 'Optional operator, default is Matches. Valid values: Matches'
        enum:
        - Matches
        - NotMatches
      noValue:
        type: boolean
        description: set this to true if no specific value to be considered
    description: A filter on an element within a journey view
  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
  WebEventRequest:
    type: object
    required:
    - createdDate
    - customerCookieId
    - eventName
    - page
    properties:
      customerCookieId:
        type: string
        description: A UUID representing the customer making the request.
      eventName:
        type: string
        description: Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. page_viewed, order_completed, user_registered.
      page:
        description: The webpage where the user interaction occurred.
        $ref: '#/definitions/RequestPage'
      userAgentString:
        type: string
        description: Override for HTTP User-Agent string from request header (see https://tools.ietf.org/html/rfc1945#section-10.15).
      browser:
        description: Customer's browser.
        $ref: '#/definitions/WebEventBrowser'
      device:
        description: Customer's device.
        $ref: '#/definitions/WebEventDevice'
      searchQuery:
        type: string
        description: Represents the keywords in a customer search query.
      ipAddress:
        type: string
        description: Customer's IP address.
      referrerUrl:
        type: string
        description: Identifies the referrer URL that originally generated the request for the current page being viewed.
      attributes:
        type: object
        description: User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      traits:
        type: object
        description: Traits are attributes intrinsic to the customer that may be sent in selected events, e.g. email, givenName, cellPhone. Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      externalId:
        type: string
        description: An external identifier for the customer.
      createdDate:
        type: string
        format: date-time
        description: 'UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  ActionTargetListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ActionTarget'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  JourneyCaseAssociation:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The ID of the association.
      associatedCase:
        description: The case that was associated with the journey session.
        $ref: '#/definitions/AddressableEntityRef'
      caseReference:
        type: string
        description: The reference for the case that was associated with the journey session.
      dateAssociated:
        type: string
        format: date-time
        description: 'The date of the association. 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
    description: The representation of a case association on a journey session.
  JourneyPage:
    type: object
    required:
    - breadcrumb
    - domain
    - hostname
    - pathname
    - url
    properties:
      url:
        type: string
        description: The page URL.
      title:
        type: string
        description: Title of the page.
      domain:
        type: string
        description: Domain of the page's URL.
      fragment:
        type: string
        description: Fragment or hash of the page's URL.
      hostname:
        type: string
        description: Hostname of the page's URL.
      keywords:
        type: string
        description: Keywords from the HTML {@code <meta>} tag of the page.
      lang:
        type: string
        description: ISO 639-1 language code for the page as defined in the {@code <html>} tag.
      pathname:
        type: string
        description: Path name of the page for the event.
      queryString:
        type: string
        description: Query string that is passed to the page in the current event.
      breadcrumb:
        type: array
        description: Hierarchy of the current page in relation to the website's structure.
        items:
          type: string
  JourneyGeolocation:
    type: object
    properties:
      country:
        type: string
        description: Geolocation's ISO 3166-1 alpha-2 country code.
      countryName:
        type: string
        description: Geolocation's country name.
      latitude:
        type: number
        format: double
        description: Geolocation's latitude.
      longitude:
        type: number
        format: double
        description: Geolocation's longitude.
      locality:
        type: string
        description: Geolocation's locality or city.
      postalCode:
        type: string
        description: Geolocation's postal code or ZIP code.
      region:
        type: string
        description: Geolocation's ISO-3166-2 region code.
      regionName:
        type: string
        description: Geolocation's region name.
      source:
        type: string
        description: The source that was used to determine the geolocation information.
      timezone:
        type: string
        description: Geolocation's timezone.
  WebEventResponse:
    type: object
    required:
    - attributes
    - authenticated
    - browser
    - createdDate
    - customerId
    - customerIdType
    - device
    - eventName
    - page
    - session
    - traits
    - userAgentString
    properties:
      customerId:
        type: string
        description: Identifier of the customer in the source of the event.
      eventName:
        type: string
        description: Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. page_viewed, order_completed, user_registered.
      customerIdType:
        type: string
        description: Type of identifier for the customer ID (e.g., cookie).
      page:
        description: The webpage where the user interaction occurred.
        $ref: '#/definitions/ResponsePage'
      userAgentString:
        type: string
        description: HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15).
      browser:
        description: Customer's browser.
        $ref: '#/definitions/WebEventBrowser'
      device:
        description: Customer's device.
        $ref: '#/definitions/WebEventDevice'
      searchQuery:
        type: string
        description: Represents the keywords in a customer search query.
      ipOrganization:
        type: string
        description: Customer's IP-based organization or ISP name.
      geolocation:
        description: Customer's geolocation.
        $ref: '#/definitions/JourneyGeolocation'
      mktCampaign:
        description: Urchin Tracking Module (UTM) parameters used to track the effectiveness of online marketing campaigns.
        $ref: '#/definitions/JourneyCampaign'
      session:
        description: The session that the event belongs to.
        $ref: '#/definitions/WebEventResponseSession'
      referrer:
        description: Identifies the web page that originally generated the request for the current page being viewed.
        $ref: '#/definitions/Referrer'
      attributes:
        type: object
        description: User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      traits:
        type: object
        description: Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, givenName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      authenticated:
        type: boolean
        description: Indicates whether the event was produced during an authenticated session.
      externalId:
        type: string
        description: An external identifier for the customer.
      createdDate:
        type: string
        format: date-time
        description: 'UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  JourneyJsonSchemaRequest:
    type: object
    required:
    - $schema
    - properties
    - title
    properties:
      $schema:
        type: string
        description: The JSON Schema specification link. The only value currently supported is "http://json-schema.org/draft-04/schema#".
      title:
        type: string
        description: The title of the schema. Must be unique across all enabled External Event schemas.
      description:
        type: string
        description: The schema description.
      required:
        type: array
        description: The list of required schema properties. All fields are optional unless listed. Optional fields can't be changed to required after the schema is saved.
        items:
          type: string
      properties:
        type: object
        description: The map of schema properties and their limits.
        additionalProperties:
          type: object
    description: A JSON Schema for create/update requests.
  GetExternalEventsResponse:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ExternalEventSummary'
    description: Response for listing external events
  ActionTarget:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      userData:
        type: array
        description: Additional user data associated with the target in key/value format.
        items:
          $ref: '#/definitions/KeyValue'
      supportedMediaTypes:
        type: array
        description: Supported media types of the target.
        items:
          type: string
          enum:
          - callback
          - call
          - email
          - generic
          - messaging
          - social
          - webchat
      state:
        type: string
        description: Indicates the state of the target.
        enum:
        - active
        - inactive
        - deleted
      description:
        type: string
        description: Description of the target.
      serviceLevel:
        description: Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.
        $ref: '#/definitions/ServiceLevel'
      shortAbandonThreshold:
        type: integer
        format: int32
        description: Indicates the non-default short abandon threshold
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: 'The date the target was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      modifiedDate:
        type: string
        format: date-time
        description: 'The date the target was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  FlowPathsElement:
    type: object
    required:
    - count
    - flows
    - type
    properties:
      parentId:
        type: string
        description: Unique identifier of the parent element. Will be null for the root element.
      type:
        type: string
        description: Type of the element.
        enum:
        - Abandoned
        - AgentEscalation
        - Disconnect
        - Error
        - Exit
        - Milestone
        - Outcome
        - RecognitionFailure
        - Root
        - TransferReturnToAgent
        - TransferToAcd
        - TransferToAcdVoicemail
        - TransferToFlow
        - TransferToGroup
        - TransferToGroupVoicemail
        - TransferToNumber
        - TransferToSecureFlow
        - TransferToUser
        - TransferToUserVoicemail
      count:
        type: integer
        format: int32
        description: Count of all journeys that include this element.
      flows:
        type: array
        description: Details of flows involved in journeys that include this element.
        items:
          $ref: '#/definitions/FlowPathsFlowDetails'
      flowMilestone:
        description: The flow milestone, set if the element type is Milestone.
        $ref: '#/definitions/AddressableEntityRef'
      flowOutcome:
        description: The flow outcome, set if the element type is Outcome or Milestone.
        $ref: '#/definitions/AddressableEntityRef'
      flowOutcomeValue:
        type: string
        description: The value of the flow outcome, if the element type is Outcome.
        enum:
        - FAILURE
        - SUCCESS
        - UNKNOWN
  Activation:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Type of activation.
      delayInSeconds:
        type: integer
        format: int32
        description: Activation delay time amount.
  JourneyView:
    type: object
    required:
    - elements
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      description:
        type: string
        description: A description of the journey view
      version:
        type: integer
        format: int32
        description: The version of the journey view
        readOnly: true
      createdBy:
        description: User that has created the view.
        readOnly: true
        $ref: '#/definitions/JourneyViewUser'
      modifiedBy:
        description: User that has modified the view.
        readOnly: true
        $ref: '#/definitions/JourneyViewUser'
      interval:
        type: string
        format: interval
        description: 'An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss'
      duration:
        type: string
        description: 'A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H'
      elements:
        type: array
        description: The elements within the journey view
        items:
          $ref: '#/definitions/JourneyViewElement'
      charts:
        type: array
        description: A list of charts to measure within context of the elements of the the journey view
        items:
          $ref: '#/definitions/JourneyViewChart'
      dateCreated:
        type: string
        format: date-time
        description: 'The date when the journey view 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 this version of the journey view was modified. 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
    description: A journey view
  PatchActionProperties:
    type: object
    properties:
      webchatPrompt:
        type: string
        description: Prompt message shown to user, used for webchat type action.
      webchatTitleText:
        type: string
        description: Title shown to the user, used for webchat type action.
      webchatAcceptText:
        type: string
        description: Accept button text shown to user, used for webchat type action.
      webchatDeclineText:
        type: string
        description: Decline button text shown to user, used for webchat type action.
      webchatSurvey:
        description: Survey provided to the user, used for webchat type action.
        $ref: '#/definitions/PatchActionSurvey'
  SessionListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/Session'
      nextUri:
        type: string
      selfUri:
        type: string
      previousUri:
        type: string
  JourneySegment:
    type: object
    required:
    - color
    - context
    - createdDate
    - displayName
    - id
    - isActive
    - journey
    - modifiedDate
    - scope
    - shouldDisplayToAgent
    - version
    properties:
      id:
        type: string
        description: The ID of the segment.
      isActive:
        type: boolean
        description: Whether or not the segment is active.
      displayName:
        type: string
        description: The display name of the segment.
      version:
        type: integer
        format: int32
        description: The version of the segment.
      description:
        type: string
        description: A description of the segment.
      color:
        type: string
        description: The hexadecimal color value of the segment.
      scope:
        type: string
        description: The target entity that a segment applies to.
        enum:
        - Session
        - Customer
      shouldDisplayToAgent:
        type: boolean
        description: Whether or not the segment should be displayed to agent/supervisor users.
      context:
        description: The context of the segment.
        $ref: '#/definitions/Context'
      journey:
        description: The pattern of rules defining the segment.
        $ref: '#/definitions/Journey'
      externalSegment:
        description: Details of an entity corresponding to this segment in an external system.
        $ref: '#/definitions/ExternalSegment'
      assignmentExpirationDays:
        type: integer
        format: int32
        description: Time, in days, from when the segment is assigned until it is automatically unassigned.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      modifiedDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  EntityTypeCriteria:
    type: object
    required:
    - entityType
    - key
    - operator
    - shouldIgnoreCase
    - values
    properties:
      key:
        type: string
        description: The criteria key.
      values:
        type: array
        description: The criteria values.
        items:
          type: string
      shouldIgnoreCase:
        type: boolean
        description: Should criteria be case insensitive.
      operator:
        type: string
        description: The comparison operator.
        enum:
        - containsAll
        - containsAny
        - notContainsAll
        - notContainsAny
        - equal
        - notEqual
        - greaterThan
        - greaterThanOrEqual
        - lessThan
        - lessThanOrEqual
        - startsWith
        - endsWith
      entityType:
        type: string
        description: The entity to match the pattern against.
        enum:
        - visit
  Items:
    type: object
    properties:
      type:
        type: string
      pattern:
        type: string
  SchemaQuantityLimits:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      minFieldNameCharacters:
        type: integer
        format: int32
        example: '"minFieldNameCharacters":1'
        description: The minimum number of schema field name characters allowed.
        readOnly: true
      maxFieldNameCharacters:
        type: integer
        format: int32
        example: '"maxFieldNameCharacters":100'
        description: The maximum number of schema field name characters allowed.
        readOnly: true
      minFieldTitleCharacters:
        type: integer
        format: int32
        example: '"minFieldTitleCharacters":1'
        description: The minimum number of schema field title characters allowed.
        readOnly: true
      maxFieldTitleCharacters:
        type: integer
        format: int32
        example: '"maxFieldTitleCharacters":100'
        description: The maximum number of schema field title characters allowed.
        readOnly: true
      minFieldDescriptionCharacters:
        type: integer
        format: int32
        example: '"minFieldDescriptionCharacters":0'
        description: The minimum number of schema field description characters allowed.
        readOnly: true
      maxFieldDescriptionCharacters:
        type: integer
        format: int32
        example: '"maxFieldDescriptionCharacters":200'
        description: The maximum number of schema field description characters allowed.
        readOnly: true
      minSchemaNameCharacters:
        type: integer
        format: int32
        example: '"minSchemaNameCharacters":1'
        description: The minimum number of schema name characters allowed.
        readOnly: true
      maxSchemaNameCharacters:
        type: integer
        format: int32
        example: '"maxSchemaNameCharacters":50'
        description: The maximum number of schema name characters allowed.
        readOnly: true
      minSchemaDescriptionCharacters:
        type: integer
        format: int32
        example: '"minSchemaDescriptionCharacters":0'
        description: The minimum number of schema description characters allowed.
        readOnly: true
      maxSchemaDescriptionCharacters:
        type: integer
        format: int32
        example: '"maxSchemaDescriptionCharacters":200'
        description: The maximum number of schema description characters allowed.
        readOnly: true
      maxNumberOfSchemasPerOrg:
        type: integer
        format: int32
        example: '"maxNumberOfSchemasPerOrg":20'
        description: The maximum number of schema allowed per org.
        readOnly: true
      maxNumberOfFieldsPerSchema:
        type: integer
        format: int32
        example: '"maxNumberOfFieldsPerSchema":25'
        description: The maximum number of schema fields allowed per schema.
        readOnly: true
      maxNumberOfFieldsPerOrg:
        type: integer
        format: int32
        example: '"maxNumberOfFieldsPerOrg":500'
        description: The maximum number of schema fields allowed per organization across all of their schemas.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ActivateExternalEventResponse:
    type: object
    properties:
      schemaId:
        type: string
        description: The schema ID of the external event
        readOnly: true
      eventName:
        type: string
        description: The name of the external event
        readOnly: true
      displayName:
        type: string
        description: The display name of the external event
        readOnly: true
      rank:
        type: integer
        format: int32
        description: The rank of the external event
        readOnly: true
      activationStatus:
        type: string
        description: The activation status of the external event
        readOnly: true
        enum:
        - Activated
        - Deactivated
    description: Response for activation of an external event
  Journey:
    type: object
    required:
    - patterns
    properties:
      patterns:
        type: array
        description: A list of zero or more patterns to match.
        items:
          $ref: '#/definitions/JourneyPattern'
  JourneyViewChartResult:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      version:
        type: integer
        format: int32
        description: Version of the chart
        readOnly: true
      metrics:
        type: array
        description: Metric results for this chart
        readOnly: true
        items:
          $ref: '#/definitions/JourneyViewChartMetricResult'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ActionMapEstimateResult:
    type: object
    properties:
      qualifiedSessionCount:
        type: integer
        format: int32
        description: Number of sessions qualified for Action map.
      totalSessionCount:
        type: integer
        format: int32
        description: Total number of sessions.
      perSegmentCounts:
        type: array
        description: Number of sessions qualified for Action map per segment.
        items:
          $ref: '#/definitions/SegmentEstimateCount'
      outcomesScoresCount:
        type: integer
        format: int32
        description: Difference made by outcome criteria to number of sessions qualified for Action map.
  Coretype:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      version:
        type: integer
        format: int32
        description: A positive integer denoting the core type's version
      dateCreated:
        type: string
        format: date-time
        description: 'The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      schema:
        description: The core type's built-in schema
        $ref: '#/definitions/Schema'
      current:
        type: boolean
        description: A boolean indicating if the core type's version is the current one in use by the system
      validationFields:
        type: array
        description: An array of strings naming the fields of the core type subject to validation.  Validation constraints are specified by a schema author using the core type.
        items:
          type: string
      validationLimits:
        example: '"validationLimits": {

          "minLength": {"min": 0, "max": 100},

          "maxLength": {"min": 1, "max": 100}

          }'
        description: A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types.  For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.
        $ref: '#/definitions/ValidationLimits'
      itemValidationFields:
        type: array
        description: Specific to the "tag" core type, this is an array of strings naming the tag item fields of the core type subject to validation
        items:
          type: string
      itemValidationLimits:
        example: "\"validationLimits\": {\n     \"minLength\": {\"min\": 1, \"max\": 100},\n     \"maxLength\": {\"min\": 1, \"max\": 100}\n}"
        description: A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as "tag" and "enum".  Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags.
        $ref: '#/definitions/ItemValidationLimits'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  FlowPathsQuery:
    type: object
    required:
    - category
    - flows
    properties:
      category:
        type: string
        description: Category (use case) of the paths within a given domain.
        enum:
        - All
        - Abandoned
        - AgentEscalation
        - Complete
        - Disconnect
        - Error
        - RecognitionFailure
        - Transfer
      flows:
        type: array
        description: List of flows to query the paths result.
        items:
          $ref: '#/definitions/FlowPathsFlowFilter'
  PatchAssociatedValueField:
    type: object
    properties:
      dataType:
        type: string
        description: The data type of the value field.
        enum:
        - Number
        - Integer
      name:
        type: string
        description: The field name for extracting value from event.
  SessionSegmentAssignment:
    type: object
    required:
    - assignedDate
    - segment
    properties:
      segment:
        description: The segment that was assigned.
        $ref: '#/definitions/AssignedSegment'
      assignedDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the segment was assigned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  UrlCondition:
    type: object
    required:
    - operator
    - values
    properties:
      values:
        type: array
        description: The URL condition value.
        items:
          type: string
      operator:
        type: string
        description: The comparison operator.
        enum:
        - containsAll
        - containsAny
        - notContainsAll
        - notContainsAny
        - equal
        - notEqual
        - greaterThan
        - greaterThanOrEqual
        - lessThan
        - lessThanOrEqual
        - startsWith
        - endsWith
  ActionTemplateListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/ActionTemplate'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  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'
  ContentPositionProperties:
    type: object
    properties:
      top:
        type: string
        description: Top positioning offset.
      bottom:
        type: string
        description: Bottom positioning offset.
      left:
        type: string
        description: Left positioning offset.
      right:
        type: string
        description: Right positioning offset.
  WebEventDevice:
    type: object
    required:
    - category
    - osFamily
    - osVersion
    - type
    properties:
      category:
        type: string
        description: Device category.
        enum:
        - desktop
        - mobile
        - tablet
        - other
      type:
        type: string
        description: Device type (e.g. iPad, iPhone, Other).
      isMobile:
        type: boolean
        description: Flag that is true for mobile devices.
      screenHeight:
        type: integer
        format: int32
        description: Device's screen height.
      screenWidth:
        type: integer
        format: int32
        description: Device's screen width.
      screenDensity:
        type: integer
        format: int32
        description: Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels.
      osFamily:
        type: string
        description: Operating system family.
      osVersion:
        type: string
        description: Operating system version.
      manufacturer:
        type: string
        description: Manufacturer of the device.
  ActionMapScheduleGroup:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The ID of the action maps's associated schedule group.
  ActionProperties:
    type: object
    properties:
      webchatPrompt:
        type: string
        description: Prompt message shown to user, used for webchat type action.
      webchatTitleText:
        type: string
        description: Title shown to the user, used for webchat type action.
      webchatAcceptText:
        type: string
        description: Accept button text shown to user, used for webchat type action.
      webchatDeclineText:
        type: string
        description: Decline button text shown to user, used for webchat type action.
      webchatSurvey:
        description: Survey provided to the user, used for webchat type action.
        $ref: '#/definitions/ActionSurvey'
  OpenActionFields:
    type: object
    required:
    - openAction
    properties:
      openAction:
        description: The specific type of the open action.
        $ref: '#/definitions/DomainEntityRef'
      configurationFields:
        type: object
        description: Custom fields defined in the schema referenced by the open action type selected.
        additionalProperties:
          type: object
  SegmentAssignmentSession:
    type: object
    required:
    - id
    - type
    properties:
      id:
        type: string
        description: The ID of the session.
      type:
        type: string
        description: The type or category of session (e.g. web, app).
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  JourneyViewListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/JourneyView'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  Number:
    type: object
    properties:
      start:
        type: string
      end:
        type: string
  Outcome:
    type: object
    required:
    - context
    - createdDate
    - displayName
    - id
    - isActive
    - isPositive
    - journey
    - modifiedDate
    - version
    properties:
      id:
        type: string
        description: ID of the outcome.
      isActive:
        type: boolean
        description: Whether or not the outcome is active.
      displayName:
        type: string
        description: The display name of the outcome.
      version:
        type: integer
        format: int32
        description: The version of the outcome.
      description:
        type: string
        description: A description of the outcome.
      isPositive:
        type: boolean
        description: Whether or not the outcome is positive.
      context:
        description: The context of the outcome.
        $ref: '#/definitions/Context'
      journey:
        description: The pattern of rules defining the filter of the outcome.
        $ref: '#/definitions/Journey'
      associatedValueField:
        description: The field from the event indicating the associated value.
        $ref: '#/definitions/AssociatedValueField'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      modifiedDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  JourneyViewChartGroupByAttribute:
    type: object
    required:
    - attribute
    - elementId
    properties:
      elementId:
        type: string
        description: The element in the list of elements which is being grouped by
      attribute:
        type: string
        description: The attribute of the element being grouped by
    description: A journey element attribute to group by within the chart
  PatchSegment:
    type: object
    properties:
      isActive:
        type: boolean
        description: Whether or not the segment is active.
      displayName:
        type: string
        description: The display name of the segment.
      version:
        type: integer
        format: int32
        description: The version of the segment.
      description:
        type: string
        description: A description of the segment.
      color:
        type: string
        description: The hexadecimal color value of the segment.
      shouldDisplayToAgent:
        type: boolean
        description: Whether or not the segment should be displayed to agent/supervisor users.
      context:
        description: The context of the segment.
        $ref: '#/definitions/PatchContext'
      journey:
        description: The pattern of rules defining the segment.
        $ref: '#/definitions/PatchJourney'
      externalSegment:
        description: Details of an entity corresponding to this segment in an external system.
        $ref: '#/definitions/PatchExternalSegment'
      assignmentExpirationDays:
        type: integer
        format: int32
        description: Time, in days, from when the segment is assigned until it is automatically unassigned.
  DeploymentWebAction:
    type: object
    required:
    - actionMapId
    - actionMapVersion
    - id
    - mediaType
    - sessionId
    properties:
      id:
        type: string
        description: System-generated UUID for the action.
      mediaType:
        type: string
        description: Action media type used to deliver the action.
        enum:
        - webchat
        - webMessagingOffer
        - contentOffer
        - integrationAction
        - architectFlow
        - openAction
      customerId:
        type: string
        description: ID string of the customer that the action was triggered for.
      customerIdType:
        type: string
        description: Type of the customer ID that the action was triggered for.
      actionMapId:
        type: string
        description: ID of the action map that triggered the action.
      actionMapVersion:
        type: integer
        format: int32
        description: Version of the action map that triggered the action.
      sessionId:
        type: string
        description: ID of the session that the action was triggered for.
      webMessagingOfferProperties:
        description: Web messaging offer specific properties.
        $ref: '#/definitions/WebMessagingOfferProperties'
      contentOfferProperties:
        description: Content offer specific properties.
        $ref: '#/definitions/ContentOffer'
      openActionProperties:
        description: Open action specific properties.
        $ref: '#/definitions/OpenActionProperties'
  JourneyJsonSchemaDocument:
    type: object
    required:
    - $schema
    - title
    properties:
      $schema:
        type: string
        description: The JSON Schema specification link. The only value currently supported is "http://json-schema.org/draft-04/schema#".
      title:
        type: string
        description: The title of the schema. Must be unique across all enabled External Event schemas.
      description:
        type: string
        description: The schema description.
      required:
        type: array
        description: The list of required schema properties. All fields are optional unless listed. Optional fields can't be changed to required after the schema is saved.
        items:
          type: string
      properties:
        type: object
        description: The map of schema properties and their limits.
        additionalProperties:
          type: object
    description: An External Events JSON Schema
  AssociatedValueField:
    type: object
    required:
    - dataType
    - name
    properties:
      dataType:
        type: string
        description: The data type of the value field.
        enum:
        - Number
        - Integer
      name:
        type: string
        description: The field name for extracting value from event.
  AppEventRequest:
    type: object
    required:
    - app
    - createdDate
    - customerCookieId
    - device
    - eventName
    - screenName
    properties:
      eventName:
        type: string
        description: Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. screen_viewed, search_performed, user_registered.
      screenName:
        type: string
        description: The name of the screen, view, or fragment in the app where the event took place.
      app:
        description: Application that the customer is interacting with.
        $ref: '#/definitions/JourneyApp'
      device:
        description: Customer's device.
        $ref: '#/definitions/RequestDevice'
      sdkLibrary:
        description: SDK library used to generate the event.
        $ref: '#/definitions/SdkLibrary'
      networkConnectivity:
        description: Information relating to the device's network connectivity.
        $ref: '#/definitions/NetworkConnectivity'
      referrerUrl:
        type: string
        description: The referrer URL of the first event in the app session.
      searchQuery:
        type: string
        description: Represents the keywords in a customer search query.
      attributes:
        type: object
        description: User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      traits:
        type: object
        description: Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, givenName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      externalId:
        type: string
        description: An external identifier for the customer.
      customerCookieId:
        type: string
        description: A UUID representing the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution.
      createdDate:
        type: string
        format: date-time
        description: 'UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  RequestExternalSegment:
    type: object
    required:
    - id
    - name
    properties:
      id:
        type: string
        description: Identifier for the external segment in the system where it originates from.
      name:
        type: string
        description: Name for the external segment in the system where it originates from.
      source:
        type: string
        description: The external system where the segment originates from.
        enum:
        - AdobeExperiencePlatform
        - Custom
  JourneyViewResultElement:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      metrics:
        description: the metrics of the current element
        readOnly: true
        $ref: '#/definitions/JourneyViewResultMetrics'
      followedBy:
        type: array
        description: the list of links following the current element in the journey
        readOnly: true
        items:
          $ref: '#/definitions/JourneyViewResultLink'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: An element within a journey view result
  JourneyEventDefinitionListing:
    type: object
    properties:
      total:
        type: integer
        format: int64
      entities:
        type: array
        items:
          $ref: '#/definitions/JourneyEventDefinition'
      selfUri:
        type: string
        format: uri
  JourneyViewElementFilterRangeData:
    type: object
    properties:
      duration:
        type: string
        description: An ISO 8601 time duration. Only one of number or duration must be specified.
      number:
        type: number
        format: double
        description: A numeric value. Only one of number or duration must be specified.
  RequestContext:
    type: object
    properties:
      patterns:
        type: array
        description: A list of one or more patterns to match. Defaults to an empty list if not provided.
        items:
          $ref: '#/definitions/RequestContextPattern'
  Session:
    type: object
    required:
    - authenticated
    - createdDate
    - eventCount
    - id
    - lastEvent
    - type
    properties:
      id:
        type: string
        description: The ID of the session.
      externalContact:
        description: The external contact associated with this session.
        $ref: '#/definitions/AddressableEntityRef'
      customerId:
        type: string
        description: Primary identifier of the customer in the source where the events for the session originate from.
      customerIdType:
        type: string
        description: Type of source customer identifier (e.g. cookie, email, phone).
      type:
        type: string
        description: Session types indicate the type or category of sessions (e.g. web, app).
      externalId:
        type: string
        description: Unique identifier in the external system where the events for the session originate from.
      externalUrl:
        type: string
        description: A URL that identifies an external system-of-record resource that may have more detailed information on the session.
      shortId:
        type: string
        description: Shortened numeric identifier of 4-6 digits.
      outcomeAchievements:
        type: array
        description: Deprecated. List of the outcome achievements by the customer in this session. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/
        items:
          $ref: '#/definitions/OutcomeAchievement'
      segmentAssignments:
        type: array
        description: List of the segment assignments to the customer in this session.
        items:
          $ref: '#/definitions/SessionSegmentAssignment'
      attributes:
        type: object
        description: Attributes projected from the session's event stream.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttribute'
      attributeLists:
        type: object
        description: List-type attributes projected from the session's event stream.
        additionalProperties:
          $ref: '#/definitions/CustomEventAttributeList'
      browser:
        description: Customer's browser.
        $ref: '#/definitions/Browser'
      device:
        description: Customer's device.
        $ref: '#/definitions/Device'
      geolocation:
        description: Customer's geolocation.
        $ref: '#/definitions/JourneyGeolocation'
      ipAddress:
        type: string
        description: Customer's IP address.
      ipOrganization:
        type: string
        description: Customer's IP-based organization or ISP name.
      lastPage:
        description: The webpage where the customer's last web interaction occurred.
        $ref: '#/definitions/JourneyPage'
      mktCampaign:
        description: Marketing / traffic source information.
        $ref: '#/definitions/JourneyCampaign'
      referrer:
        description: Identifies the page URL that originally generated the request for the current page being viewed.
        $ref: '#/definitions/Referrer'
      app:
        description: Application that the customer is interacting with (for app sessions).
        $ref: '#/definitions/JourneyApp'
      sdkLibrary:
        description: SDK library used to generate the events for the session (for app and web sessions).
        $ref: '#/definitions/SdkLibrary'
      networkConnectivity:
        description: Information relating to the device's network connectivity (for app sessions).
        $ref: '#/definitions/NetworkConnectivity'
      searchTerms:
        type: array
        description: Search terms associated with the session.
        items:
          type: string
      userAgentString:
        type: string
        description: String identifying the user agent.
      durationInSeconds:
        type: integer
        format: int32
        description: Indicates how long the session has been active (valid for an individual device).
      eventCount:
        type: integer
        format: int32
        description: The count of all events performed during the session.
      pageviewCount:
        type: integer
        format: int32
        description: The count of all pageviews performed during the session.
      screenviewCount:
        type: integer
        format: int32
        description: The count of all screenviews performed during the session.
      lastEvent:
        description: Information about the most recent event in this session.
        $ref: '#/definitions/SessionLastEvent'
      conversation:
        description: The conversation for this session.
        $ref: '#/definitions/AddressableEntityRef'
      lastConnectedQueue:
        description: The last queue connected to this session.
        $ref: '#/definitions/ConnectedQueue'
      lastConnectedUser:
        description: The last user connected to this session.
        $ref: '#/definitions/ConnectedUser'
      lastUserDisposition:
        description: The last user disposition connected to this session.
        $ref: '#/definitions/ConversationUserDisposition'
      conversationChannels:
        type: array
        description: Represents the channels used for this conversation.
        items:
          $ref: '#/definitions/ConversationChannel'
      originatingDirection:
        type: string
        description: The original direction of the conversation.
        enum:
        - Unknown
        - Inbound
        - Outbound
      conversationSubject:
        type: string
        description: The subject for the conversation, for example an email subject.
      lastUserDisconnectType:
        type: string
        description: Disconnect reason for the last user connected to the conversation.
        enum:
        - Unknown
        - Endpoint
        - Client
        - System
        - Transfer
        - Error
        - Peer
        - Other
        - Spam
        - Timeout
        - TransportFailure
        - ConferenceTransfer
        - ConsultTransfer
        - ForwardTransfer
        - NoAnswerTransfer
        - NotAvailableTransfer
        - Uncallable
        - DoNotDisturbEndpoint
        - DoNotDisturbTransfer
        - SessionExpired
        - Takeover
      lastAcdOutcome:
        type: string
        description: Last ACD outcome for the conversation.
        enum:
        - Unknown
        - Abandon
        - Answered
        - FlowOut
      authenticated:
        type: boolean
        description: Indicates whether or not the session is authenticated.
      divisionIds:
        type: array
        description: List of division IDs associated with the session.
        items:
          type: string
      lastScreen:
        type: string
        description: The app screen name where the customer's last app interaction occurred.
      caseAssociations:
        type: array
        description: Cases associated with the session - conversation only.
        items:
          $ref: '#/definitions/JourneyCaseAssociation'
      caseEntity:
        description: The case this session refers to.
        $ref: '#/definitions/AddressableEntityRef'
      caseReference:
        type: string
        description: The reference for this case.
      caseStatus:
        type: string
        description: The status of this case.
        enum:
        - Unknown
        - Open
        - InProgress
        - Terminated
        - Closed
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
      createdDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the session was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      endedDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the session was ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      awayDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the visitor should be considered as away. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      idleDate:
        type: string
        format: date-time
        description: 'Timestamp indicating when the visitor should be considered as idle. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  JourneySegmentRequest:
    type: object
    required:
    - displayName
    properties:
      isActive:
        type: boolean
        description: Whether or not the segment is active.
      displayName:
        type: string
        description: The display name of the segment.
      version:
        type: integer
        format: int32
        description: The version of the segment.
      description:
        type: string
        description: A description of the segment.
      color:
        type: string
        description: The hexadecimal color value of the segment. Defaults if not provided.
      shouldDisplayToAgent:
        type: boolean
        description: Whether or not the segment should be displayed to agent/supervisor users.
      context:
        description: The context of the segment. Defaults if not provided.
        $ref: '#/definitions/RequestContext'
      journey:
        description: The pattern of rules defining the segment. Defaults if not provided.
        $ref: '#/definitions/RequestJourney'
      externalSegment:
        description: Details of an entity corresponding to this segment in an external system.
        $ref: '#/definitions/RequestExternalSegment'
      assignmentExpirationDays:
        type: integer
        format: int32
        description: Time, in days, from when the segment is assigned until it is automatically unassigned.
  JourneyViewElementFilterRange:
    type: object
    properties:
      lt:
        description: 'comparator: less than'
        $ref: '#/definitions/JourneyViewElementFilterRangeData'
      lte:
        description: 'comparator: less than or equal'
        $ref: '#/definitions/JourneyViewElementFilterRangeData'
      gt:
        description: 'comparator: greater than'
        $ref: '#/definitions/JourneyViewElementFilterRangeData'
      gte:
        description: 'comparator: greater than or equal'
        $ref: '#/definitions/JourneyViewElementFilterRangeData'
      eq:
        description: 'comparator: is equal to'
        $ref: '#/definitions/JourneyViewElementFilterRangeData'
      neq:
        description: 'comparator: is not equal to'
        $ref: '#/definitions/JourneyViewElementFilterRangeData'
    description: the range of attribute values to filter on. At least one comparator must be defined
  PatchJourneyPattern:
    type: object
    properties:
      criteria:
        type: array
        description: A list of one or more criteria to satisfy.
        items:
          $ref: '#/definitions/PatchCriteria'
      count:
        type: integer
        format: int32
        description: The number of times the pattern must match.
      streamType:
        type: string
        description: The stream type for which this pattern can be matched on.
        enum:
        - Web
        - Custom
        - Conversation
        - App
      sessionType:
        type: string
        description: The session type for which this pattern can be matched on.
      eventName:
        type: string
        description: The name of the event for which this pattern can be matched on.
  Label:
    type: object
    required:
    - encoded
    - name
    - value
    properties:
      name:
        type: string
        description: Name of the label
      value:
        type: string
        description: Value of the label
      encoded:
        type: boolean
        description: Whether the label is encoded or not
        readOnly: true
  RequestJourney:
    type: object
    properties:
      patterns:
        type: array
        description: A list of zero or more patterns to match. Defaults to an empty list if not provided.
        items:
          $ref: '#/definitions/RequestJourneyPattern'
  JourneyViewChartMetricResult:
    type: object
    properties:
      id:
        type: string
        description: Id of the metric
        readOnly: true
      values:
        type: array
        description: Metric result values
        readOnly: true
        items:
          $ref: '#/definitions/JourneyViewChartMetricResultValue'
  JourneyApp:
    type: object
    required:
    - buildNumber
    - name
    - namespace
    - version
    properties:
      name:
        type: string
        description: Name of the application (e.g. mybankingapp).
      namespace:
        type: string
        description: Namespace of the application (e.g. com.genesys.bancodinero).
      version:
        type: string
        description: Version of the application (e.g. 5.9.27).
      buildNumber:
        type: string
        description: Build number of the application (e.g. 701).
  EventCondition:
    type: object
    required:
    - key
    - sessionType
    - streamType
    - values
    properties:
      key:
        type: string
        description: The event key.
      values:
        type: array
        description: The event values.
        items:
          type: string
      operator:
        type: string
        description: The comparison operator.
        enum:
        - containsAll
        - containsAny
        - notContainsAll
        - notContainsAny
        - equal
        - notEqual
        - greaterThan
        - greaterThanOrEqual
        - lessThan
        - lessThanOrEqual
        - startsWith
        - endsWith
      streamType:
        type: string
        description: The stream type for which this condition can be satisfied.
        enum:
        - Web
        - Custom
        - Conversation
        - App
      sessionType:
        type: string
        description: The session type for which this condition can be satisfied.
      eventName:
        type: string
        description: The name of the event for which this condition can be satisfied.
  ConnectedUser:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  SegmentAssignmentListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/SegmentAssignment'
  OutcomePredictor:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      outcome:
        description: The outcome for which this predictor will provide predictions.
        $ref: '#/definitions/OutcomeRef'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Schema:
    type: object
    properties:
      title:
        type: string
        description: A core type's title
        readOnly: true
      description:
        type: string
        description: A core type's description
        readOnly: true
      type:
        type: array
        example: '["string"] for a text-based core type, ["integer"] for a numeric core type, or ["boolean", "null"] for the checkbox core type'
        description: An array of fundamental JSON Schema primitive types on which the core type is based
        readOnly: true
        items:
          type: string
      items:
        example: '{

          type": "string",

          "pattern": "^[\\S]+$"

          }'
        description: Denotes the type and pattern of the items in an enum core type
        readOnly: true
        $ref: '#/definitions/Items'
      pattern:
        type: string
        description: For the "date" and "datetime" core types, denotes the regex prescribing the allowable date/datetime format
        readOnly: true
  UpdateExternalEventsConfigurationRequest:
    type: object
    properties:
      name:
        type: string
        description: The name of the external event configuration.
      description:
        type: string
        description: A description of the external event configuration.
  PatchWebMessagingOfferFields:
    type: object
    properties:
      offerText:
        type: string
        description: Text value to be used when inviting a visitor to engage with a web messaging offer.
      architectFlow:
        description: Flow to be invoked, overrides default flow when specified.
        $ref: '#/definitions/AddressableEntityRef'
  ExternalEventsConfiguration:
    type: object
    required:
    - dateLastModified
    - description
    - divisionId
    - divisionIdActive
    - id
    - schemaActive
    - schemaId
    - source
    properties:
      id:
        type: string
        description: The unique identifier for the external event configuration.
      name:
        type: string
      description:
        type: string
        description: A description of the external event configuration.
      divisionId:
        type: string
        description: The division ID (UUID) associated with this configuration.
      divisionIdActive:
        type: boolean
        description: Indicates whether the divisionId field is valid.
      schemaId:
        type: string
        description: The dynamic schema ID (UUID) that defines the structure of external events.
      schemaActive:
        type: boolean
        description: Indicates whether the schema is active or inactive.
      source:
        type: string
        description: The source of the external events e.g. Adobe, Salesforce.
      dateLastModified:
        type: string
        format: date-time
        description: 'The timestamp when the configuration was last modified. 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
  CtaButtonStyleProperties:
    type: object
    properties:
      color:
        type: string
        description: 'Color of the text. (eg. #FFFFFF)'
      font:
        type: string
        description: Font of the text. (eg. Helvetica)
      fontSize:
        type: string
        description: Font size of the text. (eg. '12')
      textAlign:
        type: string
        description: Text alignment.
        enum:
        - Left
        - Right
        - Center
      backgroundColor:
        type: string
        description: 'Background color of the CTA button. (eg. #FF0000)'
  PatchActionMapScheduleGroups:
    type: object
    required:
    - actionMapScheduleGroup
    properties:
      actionMapScheduleGroup:
        description: The actions map's associated schedule group.
        $ref: '#/definitions/ActionMapScheduleGroup'
      emergencyActionMapScheduleGroup:
        description: The action map's associated emergency schedule group.
        $ref: '#/definitions/ActionMapScheduleGroup'
  DeploymentPing:
    type: object
    properties:
      actions:
        type: array
        description: Collection of actions to be offered or displayed to the visitor.
        items:
          $ref: '#/definitions/DeploymentWebAction'
      pollIntervalMilliseconds:
        type: integer
        format: int32
        description: Custom poll interval in milliseconds; when the return value is -1, disable pings.
  AggregationRange:
    type: object
    properties:
      gte:
        type: number
        description: Greater than or equal to
      lt:
        type: number
        description: Less than
  ItemValidationLimits:
    type: object
    required:
    - maxLength
    - minLength
    properties:
      minLength:
        example: '"minLength": {"min": 0, "max": 100}'
        description: A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types.  For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.
        $ref: '#/definitions/MinLength'
      maxLength:
        example: '"validationLimits": {

          "minLength": {"min": 0, "max": 100},

          "maxLength": {"min": 1, "max": 100}

          }'
        description: A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types.  For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.
        $ref: '#/definitions/MaxLength'
  OutcomeListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/Outcome'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  JourneyCampaign:
    type: object
    properties:
      content:
        type: string
        description: Differentiate ads or links that point to the same URL (e.g. textlink).
      medium:
        type: string
        description: Identify a medium such as email or cost-per-click (e.g. CPC).
      name:
        type: string
        description: Identify a specific product promotion or strategic campaign (e.g. 320banner).
      source:
        type: string
        description: Identify a search engine, newsletter name, or other source (e.g. Google).
      term:
        type: string
        description: Note the keywords for this ad (e.g. running+shoes).
      clickId:
        type: string
        description: The click ID (unique number that is generated when a potential customer clicks on an affiliate link).
      network:
        type: string
        description: The ad network to which the click ID belongs.
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/