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 Social Media 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: Social Media
  description: Resources and analytics related to social media listening and response
paths:
  /api/v2/socialmedia/analytics/aggregates/jobs:
    post:
      tags:
      - Social Media
      summary: Query for social media aggregates asynchronously
      description: ''
      operationId: postSocialmediaAnalyticsAggregatesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/SocialMediaAsyncAggregationQuery'
      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: 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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:postAggregate:view
      x-purecloud-method-name: postSocialmediaAnalyticsAggregatesJobs
  /api/v2/socialmedia/analytics/aggregates/jobs/{jobId}:
    get:
      tags:
      - Social Media
      summary: Get status for async query for social media aggregates
      description: ''
      operationId: getSocialmediaAnalyticsAggregatesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          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: 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
            not.job.owner: Invalid User Operation. User does not have permission to access this job
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:postAggregate:view
      x-purecloud-method-name: getSocialmediaAnalyticsAggregatesJob
  /api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results:
    get:
      tags:
      - Social Media
      summary: Fetch a page of results for an async social media query
      description: ''
      operationId: getSocialmediaAnalyticsAggregatesJobResults
      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/SocialMediaAsyncAggregateQueryResponse'
        '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
            not.job.owner: Invalid User Operation. User does not have permission to access this job
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:postAggregate:view
      x-purecloud-method-name: getSocialmediaAnalyticsAggregatesJobResults
  /api/v2/socialmedia/analytics/messages/jobs/{jobId}:
    get:
      tags:
      - Social Media
      summary: Get status for async query for social media messages job
      description: ''
      operationId: getSocialmediaAnalyticsMessagesJob
      produces:
      - application/json
      parameters:
      - name: jobId
        in: path
        description: jobId
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          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: 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
            not.job.owner: Invalid User Operation. User does not have permission to access this job
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:postDetail:view
      x-purecloud-method-name: getSocialmediaAnalyticsMessagesJob
  /api/v2/socialmedia/analytics/messages/jobs/{jobId}/results:
    get:
      tags:
      - Social Media
      summary: Fetch a page of results for an async social media messages query
      description: ''
      operationId: getSocialmediaAnalyticsMessagesJobResults
      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/SocialMediaAsyncDetailQueryResponse'
        '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
            not.job.owner: Invalid User Operation. User does not have permission to access this job
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:postDetail:view
      x-purecloud-method-name: getSocialmediaAnalyticsMessagesJobResults
  /api/v2/socialmedia/analytics/messages/jobs:
    post:
      tags:
      - Social Media
      summary: Query for social media messages asynchronously
      description: ''
      operationId: postSocialmediaAnalyticsMessagesJobs
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: query
        required: true
        schema:
          $ref: '#/definitions/SocialMediaAsyncDetailQuery'
      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: 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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:postDetail:view
      x-purecloud-method-name: postSocialmediaAnalyticsMessagesJobs
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules:
    get:
      tags:
      - Social Media
      summary: Retrieve all social topic data ingestion rules with pagination.
      description: ''
      operationId: getSocialmediaTopicDataingestionrules
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - 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: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/DataIngestionRuleResponseEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:topic:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrules
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}:
    get:
      tags:
      - Social Media
      summary: Get a single Facebook data ingestion rule.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: facebookIngestionRuleId
        in: path
        description: facebookIngestionRuleId
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/FacebookDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No Facebook Data Ingestion Rule found with given id.
            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.
            status.conflict: Error updating the Ingestion Rule as it is in Pending state.
        '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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:facebookDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId
    put:
      tags:
      - Social Media
      summary: Update the Facebook data ingestion rule.
      description: ''
      operationId: putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: facebookIngestionRuleId
        in: path
        description: facebookIngestionRuleId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/FacebookDataIngestionRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be updated momentarily.
          schema:
            $ref: '#/definitions/FacebookDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            facebook.connector.error: Error calling Facebook while updating the Ingestion Rule.
            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
            duplicate.name: An active Data Ingestion Rule with the same name already exists.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No Facebook Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error updating the Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:facebookDataIngestionRule:edit
      x-purecloud-method-name: putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId
    delete:
      tags:
      - Social Media
      summary: Delete a Facebook data ingestion rule.
      description: ''
      operationId: deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: facebookIngestionRuleId
        in: path
        description: facebookIngestionRuleId
        required: true
        type: string
      - name: hardDelete
        in: query
        description: Determines whether a Facebook data ingestion rule 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
        default: false
      responses:
        '204':
          description: Facebook data ingestion rule deleted.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            facebook.connector.error: Error calling Facebook while deleting the Ingestion Rule.
            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
            escalation.rule.exists: The given Data Ingestion Rule is currently referenced in the Escalation Rules. Please remove the reference before attempting to delete it
            parameter.error: Invalid path parameter(s) passed in the URL path.
        '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:
            dataingestionrule.not.found: No Facebook Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error deleting the Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:facebookDataIngestionRule:delete
      x-purecloud-method-name: deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId
    patch:
      tags:
      - Social Media
      summary: Update the status of a Facebook data ingestion rule.
      description: ''
      operationId: patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: facebookIngestionRuleId
        in: path
        description: facebookIngestionRuleId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/DataIngestionRuleStatusPatchRequest'
      responses:
        '202':
          description: Request accepted - status will be updated momentarily.
          schema:
            $ref: '#/definitions/FacebookDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            facebook.connector.error: Error calling Facebook while updating the status of Ingestion Rule.
            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.
            status.not.updated: This Rule has an Error status and cannot be changed to Active or Paused.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No Facebook Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error updating the status of Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:facebookDataIngestionRule:edit
      x-purecloud-method-name: patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId
  ? /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}
  : get:
      tags:
      - Social Media
      summary: Get a single Facebook data ingestion rule version.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: facebookIngestionRuleId
        in: path
        description: facebookIngestionRuleId
        required: true
        type: string
      - name: dataIngestionRuleVersion
        in: path
        description: version
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted item in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/FacebookDataIngestionRuleVersionResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.version.not.found: No Version found with given Facebook Data Ingestion Rule id and version
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:facebookDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions:
    get:
      tags:
      - Social Media
      summary: Get the Facebook data ingestion rule versions.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: facebookIngestionRuleId
        in: path
        description: facebookIngestionRuleId
        required: true
        type: string
      - 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: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/FacebookDataIngestionRuleVersionResponseEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.versions.not.found: No Versions found for given Data Ingestion Rule id
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:facebookDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook:
    post:
      tags:
      - Social Media
      summary: Create an Facebook data ingestion rule.
      description: ''
      operationId: postSocialmediaTopicDataingestionrulesFacebook
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/FacebookDataIngestionRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be created momentarily.
          schema:
            $ref: '#/definitions/FacebookDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            facebook.connector.error: Error calling Facebook while creating the Ingestion Rule.
            bad.request: The request could not be understood by the server due to malformed syntax.
            duplicate.name: An active Data Ingestion Rule with the same name already exists.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            validation.error: Error validating the request 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.
            limit.exceed.error: Limit exceeded for Data Ingestion Rule creation.
            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.
            topic.not.found: No Topic found with given id.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:facebookDataIngestionRule:add
      x-purecloud-method-name: postSocialmediaTopicDataingestionrulesFacebook
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}:
    get:
      tags:
      - Social Media
      summary: Get a single Instagram data ingestion rule.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: instagramIngestionRuleId
        in: path
        description: instagramIngestionRuleId
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/InstagramDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No Instagram Data Ingestion Rule found with given id.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:instagramDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId
    put:
      tags:
      - Social Media
      summary: Update the Instagram data ingestion rule.
      description: ''
      operationId: putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: instagramIngestionRuleId
        in: path
        description: instagramIngestionRuleId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/InstagramDataIngestionRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be updated momentarily.
          schema:
            $ref: '#/definitions/InstagramDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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
            duplicate.name: An active Data Ingestion Rule with the same name already exists.
            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.
            instagram.connector.error: Error calling Instagram while updating the Ingestion Rule.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No Instagram Data Ingestion Rule found with given id.
            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.
            status.conflict: Error updating the Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:instagramDataIngestionRule:edit
      x-purecloud-method-name: putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId
    delete:
      tags:
      - Social Media
      summary: Delete a Instagram data ingestion rule.
      description: ''
      operationId: deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: instagramIngestionRuleId
        in: path
        description: instagramIngestionRuleId
        required: true
        type: string
      - name: hardDelete
        in: query
        description: Determines whether a Instagram data ingestion rule 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
        default: false
      responses:
        '204':
          description: Instagram data ingestion rule deleted.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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
            escalation.rule.exists: The given Data Ingestion Rule is currently referenced in the Escalation Rules. Please remove the reference before attempting to delete it
            instagram.connector.error: Error calling Instagram while deleting the Ingestion Rule.
            parameter.error: Invalid path parameter(s) passed in the URL path.
        '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:
            dataingestionrule.not.found: No Instagram Data Ingestion Rule found with given id.
            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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:instagramDataIngestionRule:delete
      x-purecloud-method-name: deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId
    patch:
      tags:
      - Social Media
      summary: Update the status of a Instagram data ingestion rule.
      description: ''
      operationId: patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: instagramIngestionRuleId
        in: path
        description: instagramIngestionRuleId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/DataIngestionRuleStatusPatchRequest'
      responses:
        '202':
          description: Request accepted - status will be updated momentarily.
          schema:
            $ref: '#/definitions/InstagramDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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.
            status.not.updated: This Rule has an Error status and cannot be changed to Active or Paused.
            instagram.connector.error: Error calling Instagram while updating the status of Ingestion Rule.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No Instagram Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error updating the status of Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:instagramDataIngestionRule:edit
      x-purecloud-method-name: patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId
  ? /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions/{dataIngestionRuleVersion}
  : get:
      tags:
      - Social Media
      summary: Get a single Instagram data ingestion rule version.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: instagramIngestionRuleId
        in: path
        description: instagramIngestionRuleId
        required: true
        type: string
      - name: dataIngestionRuleVersion
        in: path
        description: version
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted item in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/InstagramDataIngestionRuleVersionResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.version.not.found: No Version found with given Instagram Data Ingestion Rule id and version
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:instagramDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions:
    get:
      tags:
      - Social Media
      summary: Get the Instagram data ingestion rule versions.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: instagramIngestionRuleId
        in: path
        description: instagramIngestionRuleId
        required: true
        type: string
      - 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: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/InstagramDataIngestionRuleVersionResponseEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.versions.not.found: No Versions found for given Data Ingestion Rule id
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:instagramDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram:
    post:
      tags:
      - Social Media
      summary: Create an Instagram data ingestion rule.
      description: ''
      operationId: postSocialmediaTopicDataingestionrulesInstagram
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/InstagramDataIngestionRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be created momentarily.
          schema:
            $ref: '#/definitions/InstagramDataIngestionRuleResponse'
        '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.
            duplicate.name: An active Data Ingestion Rule with the same name already exists.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            validation.error: Error validating the request 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.
            limit.exceed.error: Limit exceeded for Data Ingestion Rule creation.
            instagram.connector.error: Error calling Instagram while creating the Ingestion Rule.
            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.
            topic.not.found: No Topic found with given id.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:instagramDataIngestionRule:add
      x-purecloud-method-name: postSocialmediaTopicDataingestionrulesInstagram
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}:
    get:
      tags:
      - Social Media
      summary: Get a single open data ingestion rule.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesOpenOpenId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: openId
        in: path
        description: openId
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OpenDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No Open Data Ingestion Rule found with given id.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:openDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesOpenOpenId
    put:
      tags:
      - Social Media
      summary: Update the open data ingestion rule.
      description: ''
      operationId: putSocialmediaTopicDataingestionrulesOpenOpenId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: openId
        in: path
        description: openId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/OpenDataIngestionRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be updated momentarily.
          schema:
            $ref: '#/definitions/OpenDataIngestionRuleResponse'
        '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.
            duplicate.name: An active Data Ingestion Rule with the same name already exists.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            external.source.error: Failed to retrieve external source in organization.
            validation.error: Error validating the request.
            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: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
            open.handler.error: Error calling Open while updating the Ingestion Rule.
        '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:
            dataingestionrule.not.found: No Open Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error updating the status of Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:openDataIngestionRule:edit
      x-purecloud-method-name: putSocialmediaTopicDataingestionrulesOpenOpenId
    delete:
      tags:
      - Social Media
      summary: Delete a open data ingestion rule.
      description: ''
      operationId: deleteSocialmediaTopicDataingestionrulesOpenOpenId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: openId
        in: path
        description: openId
        required: true
        type: string
      - name: hardDelete
        in: query
        description: Determines whether a open data ingestion rule 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
        default: false
      responses:
        '204':
          description: Open data ingestion rule deleted.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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
            escalation.rule.exists: The given Data Ingestion Rule is currently referenced in the Escalation Rules. Please remove the reference before attempting to delete it
            parameter.error: Invalid path parameter(s) passed in the URL path.
        '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:
            dataingestionrule.not.found: No Open Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:openDataIngestionRule:delete
      x-purecloud-method-name: deleteSocialmediaTopicDataingestionrulesOpenOpenId
    patch:
      tags:
      - Social Media
      summary: Update the status of a open data ingestion rule.
      description: ''
      operationId: patchSocialmediaTopicDataingestionrulesOpenOpenId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: openId
        in: path
        description: openId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/DataIngestionRuleStatusPatchRequest'
      responses:
        '202':
          description: Request accepted - status will be updated momentarily.
          schema:
            $ref: '#/definitions/OpenDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
            external.source.error: Failed to retrieve external source in organization.
            open.handler.error: Error calling Open while updating the status of Ingestion Rule.
        '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:
            dataingestionrule.not.found: No Open Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error updating the status of Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:openDataIngestionRule:edit
      x-purecloud-method-name: patchSocialmediaTopicDataingestionrulesOpenOpenId
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}:
    get:
      tags:
      - Social Media
      summary: Get a single Open data ingestion rule version.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesOpenOpenIdVersion
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: openId
        in: path
        description: openId
        required: true
        type: string
      - name: dataIngestionRuleVersion
        in: path
        description: version
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted item in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OpenDataIngestionRuleVersionResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.version.not.found: No Version found with given Open Data Ingestion Rule id and version.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:openDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesOpenOpenIdVersion
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions:
    get:
      tags:
      - Social Media
      summary: Get the Open data ingestion rule versions.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesOpenOpenIdVersions
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: openId
        in: path
        description: openId
        required: true
        type: string
      - 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: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OpenDataIngestionRuleVersionResponseEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.versions.not.found: No Versions found with given Open Data Ingestion Rule id.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:openDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesOpenOpenIdVersions
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open:
    post:
      tags:
      - Social Media
      summary: Create an open data ingestion rule.
      description: ''
      operationId: postSocialmediaTopicDataingestionrulesOpen
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/OpenDataIngestionRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be created momentarily.
          schema:
            $ref: '#/definitions/OpenDataIngestionRuleResponse'
        '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.
            duplicate.name: An active Data Ingestion Rule with the same name already exists.
            invalid.property: Value [%s] is not a valid property for object [%s]
            open.connector.error: Error calling Open while creating the Ingestion Rule.
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            external.source.error: Failed to retrieve external source in organization.
            validation.error: Error validating the request 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.
            limit.exceed.error: Limit exceeded for Data Ingestion Rule creation.
            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:
            dataingestionrule.not.found: No Open Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:openDataIngestionRule:add
      x-purecloud-method-name: postSocialmediaTopicDataingestionrulesOpen
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}:
    get:
      tags:
      - Social Media
      summary: Get a single X (formally Twitter) data ingestion rule.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: twitterIngestionRuleId
        in: path
        description: twitterIngestionRuleId
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/TwitterDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No X (formally Twitter) Data Ingestion Rule found with given id.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:twitterDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId
    put:
      tags:
      - Social Media
      summary: Update the X (formally Twitter) data ingestion rule.
      description: ''
      operationId: putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: twitterIngestionRuleId
        in: path
        description: twitterIngestionRuleId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/TwitterDataIngestionRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be updated momentarily.
          schema:
            $ref: '#/definitions/TwitterDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            twitter.connector.error: Error calling X (formally Twitter) while updating the Ingestion Rule.
            duplicate.dataingestionrule: A Twitter Data Ingestion Rule with the same name already exists in topic
            bad.request: The request could not be understood by the server due to malformed syntax.
            duplicate.name: An active Data Ingestion Rule with the same name already exists.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            validation.error: Error validating the request.
            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.
            status.not.updated: This Rule has an Error status and cannot be changed to Active or Paused.
            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:
            dataingestionrule.not.found: No X (formally Twitter) Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error updating the Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:twitterDataIngestionRule:edit
      x-purecloud-method-name: putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId
    delete:
      tags:
      - Social Media
      summary: Delete a X (formally Twitter) data ingestion rule.
      description: ''
      operationId: deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: twitterIngestionRuleId
        in: path
        description: twitterIngestionRuleId
        required: true
        type: string
      - name: hardDelete
        in: query
        description: Determines whether a X (formally Twitter) data ingestion rule 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
        default: false
      responses:
        '204':
          description: X (formally Twitter) data ingestion rule deleted.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            twitter.connector.error: Error calling X (formally Twitter) while deleting the Ingestion Rule.
            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
            status.not.updated: This Rule has an Error status and cannot be changed to Active or Paused.
            escalation.rule.exists: The given Data Ingestion Rule is currently referenced in the Escalation Rules. Please remove the reference before attempting to delete it
            parameter.error: Invalid path parameter(s) passed in the URL path.
        '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:
            dataingestionrule.not.found: No X (formally Twitter) Data Ingestion Rules found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error deleting the Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:twitterDataIngestionRule:delete
      x-purecloud-method-name: deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId
    patch:
      tags:
      - Social Media
      summary: Update the status of a X (formally Twitter) data ingestion rule.
      description: ''
      operationId: patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: twitterIngestionRuleId
        in: path
        description: twitterIngestionRuleId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/DataIngestionRuleStatusPatchRequest'
      responses:
        '202':
          description: Request accepted - status will be updated momentarily.
          schema:
            $ref: '#/definitions/TwitterDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            twitter.connector.error: Error calling X (formally Twitter) while updating the status of Ingestion Rule.
            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.
            status.not.updated: This Rule has an Error status and cannot be changed to Active or Paused.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.not.found: No X (formally Twitter) Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error updating the status of Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:twitterDataIngestionRule:edit
      x-purecloud-method-name: patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId
  ? /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}
  : get:
      tags:
      - Social Media
      summary: Get a single X (formally Twitter) data ingestion rule version.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: twitterIngestionRuleId
        in: path
        description: twitterIngestionRuleId
        required: true
        type: string
      - name: dataIngestionRuleVersion
        in: path
        description: version
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted item in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/TwitterDataIngestionRuleVersionResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.version.not.found: No Version found with given X (formally Twitter) Data Ingestion Rule id and version.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:twitterDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions:
    get:
      tags:
      - Social Media
      summary: Get the Open data ingestion rule versions.
      description: ''
      operationId: getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: twitterIngestionRuleId
        in: path
        description: twitterIngestionRuleId
        required: true
        type: string
      - 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: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/TwitterDataIngestionRuleVersionResponseEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
            dataingestionrule.versions.not.found: No Versions found with given X (formally Twitter) Data Ingestion Rule id.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:twitterDataIngestionRule:view
      x-purecloud-method-name: getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter:
    post:
      tags:
      - Social Media
      summary: Create an twitter data ingestion rule.
      description: ''
      operationId: postSocialmediaTopicDataingestionrulesTwitter
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/TwitterDataIngestionRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be created momentarily.
          schema:
            $ref: '#/definitions/TwitterDataIngestionRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            twitter.connector.error: Error calling X (formally Twitter) while creating the Ingestion Rule.
            duplicate.dataingestionrule: A Twitter Data Ingestion Rule with the same name already exists in topic
            bad.request: The request could not be understood by the server due to malformed syntax.
            duplicate.name: An active Data Ingestion Rule with the same name already exists.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            validation.error: Error validating the request 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.
            limit.exceed.error: Limit exceeded for Data Ingestion Rule creation.
            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:
            dataingestionrule.not.found: No X (formally Twitter) Data Ingestion Rule found with given id.
            not.found: The requested resource was not found.
            topic.not.found: No Topic found with given id.
        '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.
            status.conflict: Error deleting the Ingestion Rule as it is in Pending state.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:twitterDataIngestionRule:add
      x-purecloud-method-name: postSocialmediaTopicDataingestionrulesTwitter
  /api/v2/socialmedia/twitter/historical/tweets:
    post:
      tags:
      - Social Media
      summary: Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
      description: ''
      operationId: postSocialmediaTwitterHistoricalTweets
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: TwitterDataHistoricalTweetRequest
        required: true
        schema:
          $ref: '#/definitions/TwitterDataHistoricalTweetRequest'
      responses:
        '200':
          description: Historical Tweet Count Retrieved.
          schema:
            $ref: '#/definitions/TwitterDataHistoricalTweetResponse'
        '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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:twitterDataIngestionRule:add
      x-purecloud-method-name: postSocialmediaTwitterHistoricalTweets
  /api/v2/socialmedia/escalationrules/{escalationRuleId}:
    get:
      tags:
      - Social Media
      summary: Get a single escalation rule.
      description: ''
      operationId: getSocialmediaEscalationrule
      produces:
      - application/json
      parameters:
      - name: escalationRuleId
        in: path
        description: escalationRuleId
        required: true
        type: string
      - name: expand
        in: query
        description: which fields, if any, to expand
        required: false
        type: string
        enum:
        - dataIngestionRule
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/EscalationRuleResponse'
        '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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:escalationRules:view
      x-purecloud-method-name: getSocialmediaEscalationrule
    put:
      tags:
      - Social Media
      summary: Update the escalation rule.
      description: ''
      operationId: putSocialmediaEscalationrule
      produces:
      - application/json
      parameters:
      - name: escalationRuleId
        in: path
        description: escalationRuleId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/EscalationRuleRequest'
      responses:
        '202':
          description: Request accepted - the data ingestion rule will be updated momentarily.
          schema:
            $ref: '#/definitions/EscalationRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            data.ingestion.rule.integration.mismatch: Data ingestion rule integration platform mismatch
            bad.request: The request could not be understood by the server due to malformed syntax.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            duplicate.escalation.rule.name: 'Social media escalation rule error on duplicate name '
            validation.error: 'Social media escalation rule error on validating the request 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.
            incompatible.integration.and.data.ingestion.rule.source: The integration and data ingestion rule source are incompatible.
            data.ingestion.rule.exceeded: The limit for Social media data ingestion per escalation rule has been exceeded
            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.
            data.ingestion.rule.not.found: Data ingestion rule does not exist
            integration.not.active: Integration is not active
            integration.not.found: Integration does not exist
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:escalationRules:edit
      x-purecloud-method-name: putSocialmediaEscalationrule
    delete:
      tags:
      - Social Media
      summary: Delete an escalation rule.
      description: ''
      operationId: deleteSocialmediaEscalationrule
      produces:
      - application/json
      parameters:
      - name: escalationRuleId
        in: path
        description: escalationRuleId
        required: true
        type: string
      responses:
        '204':
          description: Facebook data ingestion rule 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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:escalationRules:delete
      x-purecloud-method-name: deleteSocialmediaEscalationrule
  /api/v2/socialmedia/escalationrules:
    get:
      tags:
      - Social Media
      summary: Retrieve all escalation rules for a division.
      description: ''
      operationId: getSocialmediaEscalationrules
      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: divisionId
        in: query
        description: One division ID
        required: true
        type: string
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/SocialEscalationResponseEntityListing'
        '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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:escalationRules:view
      x-purecloud-method-name: getSocialmediaEscalationrules
    post:
      tags:
      - Social Media
      summary: Create an escalation rule.
      description: ''
      operationId: postSocialmediaEscalationrules
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/EscalationRuleRequest'
      responses:
        '200':
          description: Escalation rule created.
          schema:
            $ref: '#/definitions/EscalationRuleResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            data.ingestion.rule.integration.mismatch: Data ingestion rule integration platform mismatch
            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]
            escalation.rule.limit.exceeded: 'Social media escalation rule creation limit exceeded  '
            constraint.validation: '%s'
            duplicate.escalation.rule.name: 'Social media escalation rule error on duplicate name '
            validation.error: 'Social media escalation rule error on validating the request 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.
            incompatible.integration.and.data.ingestion.rule.source: The integration and data ingestion rule source are incompatible.
            data.ingestion.rule.exceeded: The limit for Social media data ingestion per escalation rule has been exceeded
            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'
            missing.division.permissions: User does not have the required permission for this division.
            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.
            data.ingestion.rule.not.found: Data ingestion rule does not exist
            integration.not.active: Integration is not active
            integration.not.found: Integration does not exist
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:escalationRules:add
      x-purecloud-method-name: postSocialmediaEscalationrules
  /api/v2/socialmedia/escalations/messages:
    post:
      tags:
      - Social Media
      summary: Escalate message to a conversation manually
      description: ''
      operationId: postSocialmediaEscalationsMessages
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/ManualEscalationRequest'
      - name: divisionId
        in: query
        description: One division ID
        required: true
        type: string
      responses:
        '200':
          description: Message successfully escalated
          schema:
            $ref: '#/definitions/ManualEscalationResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            social.escalation.previously.escalated: Social media escalation of the given post is been previously escalated to a conversation
            bad.request: The request could not be understood by the server due to malformed syntax.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            social.escalation.unknown: Social media escalation of the message are failed due to unknown reason.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            nsfw.escalation.not.allowed: The given social media post cannot be escalated due to NSFW content.
            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.
            messaging.api.bad.request: The given social media post cannot be escalated due to an unknown error.
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
            cross.escalation.not.allowed: The given social media post cannot be escalated to a non-source integration
        '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'
            missing.division.permissions: User does not have the required permission for this division.
            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.
            integration.not.found: The given social media post cannot be escalated because integration is deleted.
        '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.
            integration.not.active: The given social media post cannot be escalated because integration is not active.
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:message:escalate
      x-purecloud-method-name: postSocialmediaEscalationsMessages
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/reactions/bulk:
    post:
      tags:
      - Social Media
      summary: Ingest a list of Open Social Reactions
      description: Ingest a list of open social reactions to an ingestion rule on a topic. This endpoint will ingest these reactions.  In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least social scope.
      operationId: postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: Topic ID
        required: true
        type: string
      - name: ruleId
        in: path
        description: Data Ingestion Rule ID
        required: true
        type: string
      - in: body
        name: body
        description: NormalizedEvent
        required: true
        schema:
          $ref: '#/definitions/OpenSocialMediaReactionsRequest'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/OpenSocialReactionsNormalizedEventEntityListing'
        '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
            not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource.
            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.
            open.reaction.events.too.large: Max bulk reaction events exceeded.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            missing.open.channel.date: Missing open channel date.
            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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:reaction:receive
      x-purecloud-method-name: postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk
  /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/messages/bulk:
    post:
      tags:
      - Social Media
      summary: Ingest a list of Open Social Messages
      description: Ingest a list of open social messages to an ingestion rule on a topic. This endpoint will ingest and enrich these messages.  In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least social scope.
      operationId: postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: Topic ID
        required: true
        type: string
      - name: ruleId
        in: path
        description: Data Ingestion Rule ID
        required: true
        type: string
      - in: body
        name: body
        description: NormalizedMessage
        required: true
        schema:
          type: array
          items:
            $ref: '#/definitions/OpenSocialMediaNormalizedMessage'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/OpenSocialNormalizedMessageEntityListing'
        '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
            not.a.client: This request requires a non-user context. User token cannot be used for requests to this resource.
            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]
            open.messages.too.large: Max bulk messages exceeded.
            constraint.validation: '%s'
            missing.open.channel.date: Missing open channel date.
            empty.open.messages: A list of messages is required.
            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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:message:receive
      x-purecloud-method-name: postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk
  /api/v2/socialmedia/topics/{topicId}:
    get:
      tags:
      - Social Media
      summary: Get a single social topic.
      description: ''
      operationId: getSocialmediaTopic
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/SocialTopicWithDataIngestionRuleMetadataResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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.
            topic.not.found: No Topic found with id
        '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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:topic:view
      x-purecloud-method-name: getSocialmediaTopic
    delete:
      tags:
      - Social Media
      summary: Delete a social topic.
      description: ''
      operationId: deleteSocialmediaTopic
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - name: hardDelete
        in: query
        description: Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default.
        required: false
        type: boolean
      responses:
        '204':
          description: Social topic deleted.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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
            ingestion.rules.exists: You cannot delete a Topic that has Ingestion rules associated with it. Please delete the Ingestion rules first.
            parameter.error: Invalid path parameter(s) passed in the URL path.
        '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.
            topic.not.found: No Topic found with id
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:topic:delete
      x-purecloud-method-name: deleteSocialmediaTopic
    patch:
      tags:
      - Social Media
      summary: Update a social topic.
      description: ''
      operationId: patchSocialmediaTopic
      produces:
      - application/json
      parameters:
      - name: topicId
        in: path
        description: topicId
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/SocialTopicPatchRequest'
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/SocialTopicResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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
            duplicate.name: An active Topic with the same name already exists in orgId
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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.
            topic.not.found: No Topic found with id
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ALL
        permissions:
        - socialmedia:topic:edit
      x-purecloud-method-name: patchSocialmediaTopic
  /api/v2/socialmedia/topics:
    get:
      tags:
      - Social Media
      summary: Retrieve all social topics.
      description: ''
      operationId: getSocialmediaTopics
      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: divisionIds
        in: query
        description: One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: includeDeleted
        in: query
        description: Determines whether to include soft-deleted items in the result.
        required: false
        type: boolean
      - name: name
        in: query
        description: Search for topic by name that contains the given search string, search is case insensitive
        required: false
        type: string
      - name: ids
        in: query
        description: One or more topic IDs to search through the topics.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/SocialTopicWithDataIngestionRuleMetadataResponseEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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:
        - social-media
        - social-media:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:topic:view
      x-purecloud-method-name: getSocialmediaTopics
    post:
      tags:
      - Social Media
      summary: Create a social topic.
      description: ''
      operationId: postSocialmediaTopics
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/SocialTopicRequest'
      responses:
        '200':
          description: Social topic created.
          schema:
            $ref: '#/definitions/SocialTopicResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            validation.error: Error validating the request.
            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
            duplicate.name: An active Topic with the same name already exists in orgId
            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.
            limit.exceed.error: Limit exceeded for Topic creation for this organization.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            parameter.error: Invalid path parameter(s) passed in the URL path.
            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'
            missing.division.permissions: User does not have the required permission for this division.
            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.
            topic.not.found: No Topic found with id
        '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:
        - social-media
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - socialmedia:topic:add
      x-purecloud-method-name: postSocialmediaTopics
definitions:
  OpenSocialReactionsNormalizedEventEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/OpenSocialMediaReactionsNormalizedEvent'
      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
  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'
  ConversationNormalizedMessage:
    type: object
    required:
    - type
    properties:
      id:
        type: string
        description: Unique ID of the message. Message receipts will have the same ID as the message they reference.
        readOnly: true
      channel:
        description: Channel-specific information that describes the message and the message channel/provider.
        readOnly: true
        $ref: '#/definitions/ConversationMessagingChannel'
      type:
        type: string
        description: Message type.
        enum:
        - Text
        - Structured
        - Receipt
        - Event
        - Message
        - Unknown
      text:
        type: string
        description: Message text.
      content:
        type: array
        description: List of content elements.
        items:
          $ref: '#/definitions/ConversationMessageContent'
      events:
        type: array
        description: List of event elements.
        items:
          $ref: '#/definitions/ConversationMessageEvent'
      status:
        type: string
        description: Message receipt status, only used with type Receipt.
        readOnly: true
        enum:
        - Sent
        - Delivered
        - Read
        - Failed
        - Published
        - Removed
      reasons:
        type: array
        description: List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.
        readOnly: true
        items:
          $ref: '#/definitions/ConversationReason'
      originatingEntity:
        type: string
        description: Specifies if this message was sent by a human agent or bot. The platform may use this to apply appropriate provider policies.
        enum:
        - Human
        - Bot
      isFinalReceipt:
        type: boolean
        description: Indicates if this is the last message receipt for this message, or if another message receipt can be expected.
        readOnly: true
      direction:
        type: string
        description: The direction of the message.
        readOnly: true
        enum:
        - Inbound
        - Outbound
      relatedMessages:
        type: array
        description: A list of messages related to this one.
        items:
          $ref: '#/definitions/ConversationNormalizedMessage'
      metadata:
        type: object
        description: Additional metadata about this message.
        additionalProperties:
          type: string
      enrichment:
        description: Metadata enrichments provided by the platform.
        $ref: '#/definitions/ConversationEnrichment'
      byoSmsIntegrationId:
        type: string
        description: The internal id representing the customer supplied sms integration message.
    description: General rich media message structure with normalized feature support across many messaging channels.
  ConversationContentRequiredContactField:
    type: object
    required:
    - contactField
    properties:
      contactField:
        type: string
        description: The name of the contact field
        enum:
        - Address
        - Name
        - Phone
        - Email
    description: Contact fields a merchant requires to complete a payment request.
  ConversationContentDatePickerAvailableTime:
    type: object
    properties:
      duration:
        type: integer
        format: int64
        description: The duration of the scheduling event in seconds.
      dateTime:
        type: string
        format: date-time
        description: 'The date and time of the event being scheduled. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
    description: A datetimepicker available time that a user can take.
  ConversationContentQuickReplyV2:
    type: object
    required:
    - actions
    - title
    properties:
      title:
        type: string
        description: Text to show as the title of the quick reply.
      actions:
        type: array
        description: An array of quick reply objects.
        items:
          $ref: '#/definitions/ConversationContentQuickReply'
    description: Quick reply object V2.
  OpenDataIngestionRuleVersionResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the open data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: The countries is available only on twitter data ingestion rule. ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        readOnly: true
        items:
          type: string
      externalSource:
        description: The external source associated with this open data ingestion rule, which is used when performing identity resolution
        $ref: '#/definitions/DomainEntityRef'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ConversationEnrichment:
    type: object
    properties:
      language:
        description: Detected language of this message.
        $ref: '#/definitions/ConversationEnrichmentLanguage'
      sentimentV2:
        description: Detected sentiment of this message.
        $ref: '#/definitions/ConversationEnrichmentSentimentV2'
    description: Metadata enrichments provided by the platform.
  ConversationEnrichmentSentimentV2:
    type: object
    required:
    - tag
    properties:
      tag:
        type: string
        description: Detected Sentiment tag
        enum:
        - Unknown
        - Positive
        - Negative
        - Neutral
    description: Sentiment analysis of this message.
  SocialMediaAggregateMetricData:
    type: object
    properties:
      metric:
        type: string
      qualifier:
        type: string
      stats:
        $ref: '#/definitions/SocialMediaStatisticalSummary'
  ConversationContentCardAction:
    type: object
    properties:
      type:
        type: string
        description: Describes the type of action.
        enum:
        - Link
        - Postback
        - Unknown
      text:
        type: string
        description: The response text from the button click.
      payload:
        type: string
        description: Text to be returned as the payload from a ButtonResponse when a button is clicked. The payload and text are a combination which will have to be unique across each card and carousel in order to determine which button was clicked in that card or carousel.
      url:
        type: string
        description: A URL of a web page to direct the user to.
    description: A card action that a user can take.
  InstagramDataIngestionRuleVersionResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the Instagram data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: The countries is available only on twitter data ingestion rule. ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        readOnly: true
        items:
          type: string
      integrationId:
        type: string
        description: The Integration Id from which public social posts are ingested. This entity is created using the /conversations/messaging/integrations/instagram resource
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ConversationContentCarousel:
    type: object
    required:
    - cards
    properties:
      cards:
        type: array
        description: An array of card objects.
        items:
          $ref: '#/definitions/ConversationContentCard'
    description: Carousel content object.
  ConversationContentButtonResponse:
    type: object
    required:
    - payload
    - text
    properties:
      originatingMessageId:
        type: string
        description: Reference to the ID of the original message (e.g., list picker) this button response is replying to.
      type:
        type: string
        description: Describes the button that resulted in the Button Response.
        enum:
        - Button
        - QuickReply
        - DatePicker
        - ListPicker
        - Form
      text:
        type: string
        description: The response text from the button click.
      payload:
        type: string
        description: The response payload associated with the clicked button.
    description: Button response object representing the click of a structured message button, such as a quick reply.
  ManualEscalationRequest:
    type: object
    required:
    - socialMediaNormalizedMessageId
    properties:
      socialMediaNormalizedMessageId:
        type: string
        description: The social media normalized message ID to be escalated.
      escalationTarget:
        description: The escalation target to which the specified social media normalized message should be routed.
        $ref: '#/definitions/EscalationTarget'
  OpenDataIngestionRuleResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the open data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: The countries is available only on twitter data ingestion rule. ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        readOnly: true
        items:
          type: string
      externalSource:
        description: The external source associated with this open data ingestion rule, which is used when performing identity resolution
        $ref: '#/definitions/DomainEntityRef'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ConversationContentStory:
    type: object
    properties:
      type:
        type: string
        description: Type of ephemeral story attachment.
        enum:
        - Mention
        - Reply
      url:
        type: string
        description: URL to the ephemeral story.
      replyToId:
        type: string
        description: ID of the ephemeral story being replied to.
    description: An ephemeral story.
  ConversationNotificationTemplateBody:
    type: object
    required:
    - parameters
    properties:
      text:
        type: string
        description: Body text. For WhatsApp, ignored.
      parameters:
        type: array
        description: Template parameters for placeholders in template.
        items:
          $ref: '#/definitions/ConversationNotificationTemplateParameter'
    description: Template body object.
  ConversationContentIntroduction:
    type: object
    required:
    - buttonText
    - title
    properties:
      title:
        type: string
        description: Text to show in the title.
      subtitle:
        type: string
        description: Text to show in the subtitle.
      imageUrl:
        type: string
        description: URL of an image.
      buttonText:
        type: string
        description: Text to show on the button.
    description: Introduction content object.
  TwitterDataIngestionRuleVersionResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        items:
          type: string
      searchTerms:
        type: string
        description: Search terms for X (formally Twitter).
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  SocialTopicWithDataIngestionRuleMetadataResponseEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/SocialTopicWithDataIngestionRuleMetadataResponse'
      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
  ConversationNotificationTemplateFooter:
    type: object
    properties:
      text:
        type: string
        description: Footer text. For WhatsApp, ignored.
    description: Template footer object.
  SocialMediaDetailDataContainer:
    type: object
    properties:
      interval:
        type: string
      messages:
        type: array
        items:
          $ref: '#/definitions/SocialMediaDetailMessageContainer'
  ConversationContentNotificationTemplate:
    type: object
    required:
    - body
    properties:
      id:
        type: string
        description: The identifier of the message template in 'your-namespace@your-template-id/name' format. For External vendor (e.g WhatsApp), 'your-namespace@your-template-name'. For GenesysCloud canned response message template use 'cannedresponse' as your-namespace and use response ID as your-template-id (e.g. response ID=1234 then 'cannedresponse@1234')
      language:
        type: string
        description: Template language.
      header:
        description: The template header.
        $ref: '#/definitions/ConversationNotificationTemplateHeader'
      body:
        description: The template body.
        $ref: '#/definitions/ConversationNotificationTemplateBody'
      buttons:
        type: array
        description: Template buttons
        items:
          $ref: '#/definitions/ConversationNotificationTemplateButton'
      footer:
        description: The template footer.
        $ref: '#/definitions/ConversationNotificationTemplateFooter'
    description: Template notification object.
  ConversationChannelMetadata:
    type: object
    properties:
      subType:
        type: string
        description: Channel subtype
        readOnly: true
        enum:
        - None
        - GoogleBusinessProfile
        - RoadsideAssistance
        - YouTube
    description: Information about the channel.
  TwitterDataIngestionRuleResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        items:
          type: string
      searchTerms:
        type: string
        description: Search terms for X (formally Twitter).
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ConversationContentPaymentRequest:
    type: object
    required:
    - countryCode
    - currencyCode
    - orderTotal
    - paymentPlatform
    properties:
      paymentPlatform:
        type: string
        description: The payment platform being used (e.g. Apple Pay)
        readOnly: true
        enum:
        - ApplePay
      countryCode:
        type: string
        description: The merchant's two-letter ISO 3166 country code.
      currencyCode:
        type: string
        description: The three-letter ISO 4217 currency code for the payment.
      orderTotal:
        type: number
        format: double
        description: The total price of the order.
      lineItems:
        type: array
        description: The items that make up the order.
        items:
          $ref: '#/definitions/ConversationContentLineItem'
      shippingOptions:
        type: array
        description: The available shipping options.
        items:
          $ref: '#/definitions/ConversationContentLineItem'
      requiredContactFields:
        type: array
        description: Contact fields required to complete the order.
        items:
          $ref: '#/definitions/ConversationContentRequiredContactField'
      receivedMessage:
        description: The message prompt to complete a payment transaction.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
      replyMessage:
        description: The reply message after the user has completed the payment transaction.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
    description: Payment Request object used to request payment from a customer.
  ConversationContentPaymentResponse:
    type: object
    required:
    - originatingMessageId
    - paymentStatus
    properties:
      originatingMessageId:
        type: string
        description: Reference to the ID of the original payment request message this response is for.
      paymentStatus:
        type: string
        description: The status of the payment transaction.
        enum:
        - Completed
        - Failed
      failureReason:
        type: string
        description: The reason the payment request failed.
    description: Payment response object representing the status of a payment transaction.
  EscalationTarget:
    type: object
    required:
    - destination
    - targetType
    properties:
      targetType:
        type: string
        description: Defines the target that the message will be escalated to.
        enum:
        - Conversation
      destination:
        type: string
        description: Defines the destination of the escalation.SourceIntegration means use the SocialMedia Source Integration as the destination.OverrideIntegration means the set integration will be used regardless of the source.
        enum:
        - SourceIntegration
        - OverrideIntegration
      override:
        description: Set the integration ID.Only valid when type is OverrideIntegration.
        $ref: '#/definitions/OverrideEscalationTarget'
  SocialMediaAsyncDetailQuery:
    type: object
    required:
    - interval
    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'
      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'
      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/SocialMediaQueryFilter'
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
      order:
        type: string
        description: 'Deprecated: use ''sort'' field instead. Sorting of results based on time'
        enum:
        - asc
        - desc
  ConversationNotificationTemplateButton:
    type: object
    required:
    - index
    - type
    properties:
      type:
        type: string
        description: Specifies the type of the button.
        enum:
        - QuickReply
        - PhoneNumber
        - Url
      text:
        type: string
        description: Button text message.
      index:
        type: integer
        format: int64
        description: index of the button in the list.
      phoneNumber:
        type: string
        description: Button phone number.
      url:
        type: string
        description: Button URL link.
      payload:
        type: string
        description: Content of the payload to be included in the quick reply response when the button is pressed.
      parameters:
        type: array
        description: Template parameters for placeholders in the button.
        items:
          $ref: '#/definitions/ConversationNotificationTemplateParameter'
    description: Template button object
  ManualEscalationResponse:
    type: object
    properties:
      socialMediaNormalizedMessageId:
        type: string
        description: The Id of the message that got escalated.
      conversationNormalizedMessageId:
        type: string
        description: The ID of the message in the conversation.
      escalationTarget:
        description: The target integration configuration used for an social media message.
        $ref: '#/definitions/EscalationTarget'
      escalationStatus:
        type: string
        description: Escalation Status of the message.
        enum:
        - Unknown
        - Manual
        - Throttled
        - PreviouslyEscalated
        - NotEscalated
        - Automatic
  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.
  ConversationFormResponseComponent:
    type: object
    required:
    - component
    - id
    properties:
      id:
        type: string
        description: The id of the component in the original message.
      component:
        description: The content object capturing component response from the original message.
        $ref: '#/definitions/ConversationFormResponseContent'
    description: A response component from a form
  SocialMediaDetailMessageContainer:
    type: object
    properties:
      id:
        type: string
      normalizedMessage:
        $ref: '#/definitions/ConversationNormalizedMessage'
      escalationInfo:
        $ref: '#/definitions/SocialMediaMessageEscalationInfo'
      contentModeration:
        $ref: '#/definitions/ContentModeration'
  ConversationContentInteractiveApplication:
    type: object
    properties:
      name:
        type: string
        description: The name of the message app.
      url:
        type: string
        description: Contains the data that is sent to the message app.
      receivedMessage:
        description: The message displayed in the received message bubble.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
      replyMessage:
        description: The message displayed in the reply message bubble.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
    description: InteractiveApplication content object.
  TwitterDataIngestionRuleRequest:
    type: object
    required:
    - name
    - searchTerms
    properties:
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      searchTerms:
        type: string
        description: Search terms for X (formally Twitter).
      countries:
        type: array
        description: ISO 3166-1 alpha-2 country codes. Ingestion of matching tweets will be restricted to tweets posted in the countries specified here. Defaults to worldwide.
        items:
          type: string
  ConversationFormPage:
    type: object
    required:
    - subtitle
    - title
    properties:
      title:
        type: string
        description: Text to show in the title.
      subtitle:
        type: string
        description: Text to show in the subtitle.
      pageComponents:
        type: array
        description: Page components in this form page.
        items:
          $ref: '#/definitions/ConversationFormPageComponent'
    description: Form page object.
  TweetUsage:
    type: object
    properties:
      ingestionLimit:
        type: integer
        format: int64
        description: Ingestion limit
      tweetCount:
        type: integer
        format: int64
        description: The number of tweets consumed
      dateStart:
        type: string
        format: date-time
        description: 'The start of the usage period for the currently consumed tweets. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  OpenSocialMediaReactionsChannel:
    type: object
    required:
    - messageId
    - time
    properties:
      id:
        type: string
        description: The topic ID.
        readOnly: true
      platform:
        type: string
        description: The provider type.
        readOnly: true
        enum:
        - Open
      type:
        type: string
        description: Specifies if this message is part of a private or public conversation.
        readOnly: true
        enum:
        - Public
      messageId:
        type: string
        description: Unique provider ID of the message such as a Open message ID.
      to:
        description: Information about the recipient the message is sent to.
        readOnly: true
        $ref: '#/definitions/OpenSocialMediaRecipient'
      time:
        type: string
        format: date-time
        description: 'Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
    description: Channel-specific information that describes the message and the message channel/provider.
  ConversationEnrichmentLanguage:
    type: object
    required:
    - language
    properties:
      language:
        type: string
        description: The IETF detected language code of this message.
    description: Detected language of this message.
  OpenDataIngestionRuleVersionResponseEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/OpenDataIngestionRuleVersionResponse'
      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
  ConversationContentDatePicker:
    type: object
    properties:
      id:
        type: string
        description: Optional unique identifier to help map component replies to form messages where multiple DatePickers can be present.
      title:
        type: string
        description: Text to show in the title.
      subtitle:
        type: string
        description: Text to show in the description.
      imageUrl:
        type: string
        description: URL of an image
      dateMinimum:
        type: string
        format: date-time
        description: 'The minimum Date Enabled in the datepicker calendar, format: ISO 8601.'
      dateMaximum:
        type: string
        format: date-time
        description: 'The maximum Date Enabled in the datepicker calendar, format: ISO 8601.'
      location:
        description: Location of the event.
        $ref: '#/definitions/ConversationContentLocation'
      availableTimes:
        type: array
        description: An array of available times objects.
        items:
          $ref: '#/definitions/ConversationContentDatePickerAvailableTime'
      dateDisplayFormat:
        type: string
        description: The format the date should be presented to the end user.
        enum:
        - dayMonthYear
        - monthDayYear
        - yearMonthDay
    description: DateTimePicker content object.
  SocialMediaStatisticalResponse:
    type: object
    properties:
      interval:
        type: string
      metrics:
        type: array
        items:
          $ref: '#/definitions/SocialMediaAggregateMetricData'
  SocialMediaAsyncDetailQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/SocialMediaDetailDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next or previous page
  OpenSocialMediaChannel:
    type: object
    required:
    - from
    - messageId
    - publicMetadata
    - time
    properties:
      id:
        type: string
        description: The topic ID.
        readOnly: true
      platform:
        type: string
        description: The provider type.
        readOnly: true
        enum:
        - Open
      type:
        type: string
        description: Specifies if this message is part of a private or public conversation.
        readOnly: true
        enum:
        - Public
      messageId:
        type: string
        description: Unique provider ID of the message such as a Facebook message ID.
      to:
        description: Information about the recipient the message is sent to.
        $ref: '#/definitions/OpenSocialMediaRecipient'
      from:
        description: Information about the recipient the message is received from.
        $ref: '#/definitions/OpenSocialMediaRecipient'
      time:
        type: string
        format: date-time
        description: 'Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      metadata:
        description: Information about the channel.
        $ref: '#/definitions/ConversationChannelMetadata'
      publicMetadata:
        description: Meta data of this public post. For example, used to define where in the thread the post exists.
        $ref: '#/definitions/OpenSocialMediaPublicMetadata'
    description: Channel-specific information that describes the message and the message channel/provider.
  ConversationContentText:
    type: object
    required:
    - body
    properties:
      type:
        type: string
        description: Type of text content (Deprecated).
        enum:
        - Text
      body:
        type: string
        description: Text to be shown for this content element.
    description: Message content element containing text only.
  ConversationContentWheelPicker:
    type: object
    required:
    - items
    properties:
      id:
        type: string
        description: Optional unique identifier to help map component replies to form messages where multiple Wheel Pickers can be present.
      items:
        type: array
        description: The main text displayed for the item.
        items:
          $ref: '#/definitions/ConversationContentWheelPickerItem'
    description: Wheel Picker object for representing single selection of selectable items.
  SocialMediaQueryFilter:
    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/SocialMediaQueryClause'
      predicates:
        type: array
        description: 'Like a three-word sentence: (attribute-name) (operator) (target-value).'
        items:
          $ref: '#/definitions/SocialMediaQueryPredicate'
  OpenSocialMediaMessageContent:
    type: object
    required:
    - contentType
    properties:
      contentType:
        type: string
        description: Type of this content element.
        enum:
        - Attachment
        - Reactions
        - Text
      attachment:
        description: Attachment content.
        $ref: '#/definitions/ConversationContentAttachment'
      text:
        description: A content type containing text.
        $ref: '#/definitions/ConversationContentText'
      reaction:
        description: A set of reactions to a message.
        $ref: '#/definitions/ConversationContentReaction'
    description: Message content element.
  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
  ConversationContentNotificationResponse:
    type: object
    required:
    - notificationStatus
    - originatingMessageId
    properties:
      originatingMessageId:
        type: string
        description: Reference to the ID of the original outbound notification message this response is for (e.g. the Apple requestIdentifier).
      referenceId:
        type: string
        description: The business context reference associated with the notification (e.g. order ID, case ID). May be empty if the provider does not return it.
      notificationStatus:
        type: string
        description: The status of the notification response.
        enum:
        - Accepted
        - Declined
      notificationText:
        type: string
        description: The localized display text of the user's response (e.g. "Yes").
    description: Inbound response to a notification, such as an Apple Invitations acceptance.
  ConversationEventVideo:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Describes the type of Video event.
        enum:
        - Offering
        - OfferingExpired
        - OfferingAccepted
        - OfferingRejected
      offeringId:
        type: string
        description: The Video offering ID.
      jwt:
        type: string
        description: The Video offering JWT token.
    description: A Video event.
  SocialTopicWithDataIngestionRuleMetadataResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the social topic.
      name:
        type: string
        description: The name of the social topic.
      description:
        type: string
        description: A description of the social topic.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the social topic was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateModified:
        type: string
        format: date-time
        description: 'Timestamp indicating when the social topic was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      divisionId:
        type: string
        description: The ID of the division to which the social topic belongs to.
      status:
        type: string
        description: The status of the social topic.
        enum:
        - Active
        - Pending
        - Deleted
      dataIngestionRulesMetadata:
        type: array
        description: The data ingestion rule metadata.
        items:
          $ref: '#/definitions/DataIngestionRulesMetadata'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  DomainEntityRef:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      selfUri:
        type: string
        format: uri
  ConversationMessagingToRecipient:
    type: object
    required:
    - id
    properties:
      nickname:
        type: string
        description: Nickname or display name of the recipient.
        readOnly: true
      id:
        type: string
        description: The recipient ID specific to the provider.
      idType:
        type: string
        description: The recipient ID type. This is used to indicate the format used for the ID.
        readOnly: true
        enum:
        - Email
        - Phone
        - Opaque
        - Topic
      image:
        type: string
        description: URL of an image that represents the recipient.
        readOnly: true
      firstName:
        type: string
        description: First name of the recipient.
        readOnly: true
      lastName:
        type: string
        description: Last name of the recipient.
        readOnly: true
      email:
        type: string
        description: E-mail address of the recipient.
        readOnly: true
      externalContactId:
        type: string
        description: The identifier of the external contact.
      additionalIds:
        type: array
        description: List of recipient additional identifiers
        readOnly: true
        items:
          $ref: '#/definitions/ConversationRecipientAdditionalIdentifier'
    description: Information about the recipient the message is sent to.
  InstagramDataIngestionRuleResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the Instagram data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: The countries is available only on twitter data ingestion rule. ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        readOnly: true
        items:
          type: string
      integrationId:
        type: string
        description: The Integration Id from which public social posts are ingested. This entity is created using the /conversations/messaging/integrations/instagram resource
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ConversationContentWheelPickerItem:
    type: object
    required:
    - id
    - title
    properties:
      id:
        type: string
        description: Unique identifier for the wheel picker item
      title:
        type: string
        description: The main text displayed for the item.
      value:
        type: string
        description: The value of the item.
    description: Represents a selectable item in a Wheel Picker
  SocialMediaMessageEscalationInfo:
    type: object
    properties:
      escalationStatus:
        type: string
        enum:
        - Unknown
        - Manual
        - Throttled
        - PreviouslyEscalated
        - NotEscalated
        - Automatic
  ConversationMessageEvent:
    type: object
    required:
    - eventType
    properties:
      eventType:
        type: string
        description: Type of this event element
        enum:
        - CoBrowse
        - Typing
        - Presence
        - Video
        - Unknown
      coBrowse:
        description: CoBrowse event.
        $ref: '#/definitions/ConversationEventCoBrowse'
      typing:
        description: Typing event.
        $ref: '#/definitions/ConversationEventTyping'
      presence:
        description: Presence event.
        $ref: '#/definitions/ConversationEventPresence'
      video:
        description: Video event.
        $ref: '#/definitions/ConversationEventVideo'
    description: 'Message event element.  Examples include: system messages, typing indicators, cobrowse offerings.'
  OpenSocialMediaReactionsNormalizedEvent:
    type: object
    required:
    - channel
    - events
    properties:
      id:
        type: string
        description: Unique ID of the message generated by Genesys Platform.
        readOnly: true
      channel:
        description: Channel-specific information that describes the message and the message channel/provider.
        $ref: '#/definitions/OpenSocialMediaReactionsChannel'
      events:
        type: array
        description: List of event elements.
        items:
          $ref: '#/definitions/OpenSocialMediaReactionsEvent'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Open Social Messaging rich media event structure
  SocialMediaQueryClause:
    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/SocialMediaQueryPredicate'
  ConversationEventTyping:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Describes the type of Typing event.
        enum:
        - 'On'
      duration:
        type: integer
        format: int64
        description: The duration of the Typing event in milliseconds.
    description: A Typing event.
  ConversationPushProviderIntegration:
    type: object
    required:
    - id
    - provider
    properties:
      id:
        type: string
        description: Genesys Cloud Integration ID
      provider:
        type: string
        description: Type of the integration
        enum:
        - FCM
        - APNS
    description: A Push provider integration.
  Detail:
    type: object
    properties:
      errorCode:
        type: string
      fieldName:
        type: string
      entityId:
        type: string
      entityName:
        type: string
  TwitterDataHistoricalTweetResponse:
    type: object
    properties:
      matchingTweets:
        type: integer
        format: int64
        description: The count of matching tweets using the searchTerms.
      previousNumberOfDays:
        type: integer
        format: int32
        description: The number of days used for the query
      usageStatistics:
        description: The tweet usage of the org
        $ref: '#/definitions/TweetUsage'
  FacebookDataIngestionRuleResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the Facebook data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: The countries is available only on twitter data ingestion rule. ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        readOnly: true
        items:
          type: string
      integrationId:
        type: string
        description: Id of the Integration when source is owned (Authenticated). This entity is created using the /conversations/messaging/integrations/facebook resource. Optional when configuring non-owned pages.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  SocialTopicRequest:
    type: object
    required:
    - divisionId
    - name
    properties:
      name:
        type: string
        description: Name of the social topic.
      description:
        type: string
        description: A description of the social topic.
      divisionId:
        type: string
        description: The ID of the division the social topic belongs to.
  ConversationContentLocation:
    type: object
    properties:
      url:
        type: string
        description: URL of the Location.
      address:
        type: string
        description: Location postal address.
      text:
        type: string
        description: Location name.
      latitude:
        type: number
        format: double
        description: Latitude of the location.
      longitude:
        type: number
        format: double
        description: Longitude of the location.
    description: Location object.
  ConversationContentInput:
    type: object
    required:
    - isMultipleLine
    - isRequired
    properties:
      id:
        type: string
        description: Unique identifier for the input
      title:
        type: string
        description: The main text displayed for the input field(s).
      subtitle:
        type: string
        description: Additional text providing more details about the input field(s).
      placeholderText:
        type: string
        description: Placeholder text for input field(s).
      isRequired:
        type: boolean
        description: Whether the input field(s) are required to be filled in.
      isMultipleLine:
        type: boolean
        description: Whether the input should allow multiple lines of text.
      keyboardType:
        type: string
        description: Type of keyboard to be shown.
        enum:
        - Default
        - NumberPunctuation
        - Number
        - Phone
        - Email
        - Decimal
        - Websearch
        - URL
      autoCompleteType:
        type: string
        description: A string value representing the keyboard and system information about the expected semantic meaning for the content that users enter.
        enum:
        - Prefix
        - Name
        - GivenName
        - MiddleName
        - FamilyName
        - Suffix
        - Nickname
        - Title
        - Organization
        - Location
        - StreetAddress
        - Addressline1
        - Addressline2
        - City
        - State
        - Country
        - PostalCode
        - Username
        - OneTimeCode
        - Email
        - Phone
        - PaymentCardNumber
        - PaymentCardExpiration
        - PaymentCardExpirationMonth
        - PaymentCardExpirationYear
        - PaymentCardSecurityCode
        - PaymentCardType
        - PaymentCardName
        - PaymentCardGivenName
        - PaymentCardMiddleName
        - PaymentCardFamilyName
        - Birthdate
        - BirthdateDay
        - BirthdateMonth
        - BirthdateYear
        - DateTime
        - FlightNumber
        - Url
    description: Single or multiline text input component.
  ConversationEventPresence:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Describes the type of Presence event.
        enum:
        - Join
        - Disconnect
        - Clear
        - SignIn
        - SessionExpired
        - Authenticate
        - AuthenticateFailure
        - AuthenticateCancel
      receivedMessage:
        description: A sign in prompt message for when the authenticate event is received.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
      replyMessage:
        description: A reply message on authentication success.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
    description: A Presence event.
  ConversationContentLineItem:
    type: object
    required:
    - name
    - price
    properties:
      name:
        type: string
        description: The display name for the item.
      price:
        type: number
        format: double
        description: The price of the item.
      description:
        type: string
        description: Additional details about the item (e.g. the length of time to deliver for shipping options).
      identifier:
        type: string
        description: A client defined value used to identify the item.
    description: Item included in an order.
  OpenSocialMediaReactionsRequest:
    type: object
    required:
    - events
    properties:
      events:
        type: array
        description: List of open social media reaction events
        items:
          $ref: '#/definitions/OpenSocialMediaReactionsNormalizedEvent'
  OpenSocialMediaNormalizedMessage:
    type: object
    required:
    - channel
    properties:
      id:
        type: string
        description: Unique ID of the message generated by Genesys Platform.
        readOnly: true
      channel:
        description: Channel-specific information that describes the message and the message channel/provider.
        $ref: '#/definitions/OpenSocialMediaChannel'
      text:
        type: string
        description: Message text.
      type:
        type: string
        description: Message type.
        readOnly: true
        enum:
        - Text
      content:
        type: array
        description: List of content elements.
        items:
          $ref: '#/definitions/OpenSocialMediaMessageContent'
      metadata:
        type: object
        description: Additional metadata about this message.
        additionalProperties:
          type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Open Social Messaging rich media message structure
  ConversationFormResponseContent:
    type: object
    properties:
      contentType:
        type: string
        description: Type of this content element.
        enum:
        - ButtonResponse
      buttonResponse:
        description: Button response content.
        $ref: '#/definitions/ConversationContentButtonResponse'
    description: Message content element for form responses
  OverrideEscalationTarget:
    type: object
    required:
    - integrationId
    properties:
      integrationId:
        type: string
        description: The ID of the integration.
  OpenSocialMediaPublicMetadata:
    type: object
    required:
    - rootId
    properties:
      rootId:
        type: string
        description: The id of the root public message.
      replyToId:
        type: string
        description: The id of the message this public message is replying to.
      source:
        type: string
        description: The source of the public message. Useful when there could be more than location. Channel specific, e.g., for Facebook it's a source page.
      url:
        type: string
        description: The URL of the social post on the native platform.
      mentionIds:
        type: array
        description: IDs of accounts referenced by name within the message text or caption (for example '@brandpage' in a post body or comment). A 'mention' here uses the same convention as Meta (Facebook, Instagram) and LinkedIn, where it denotes a textual reference to an account. Distinct from tagIds, which represent explicit associations with the message. Null or absent when no accounts are referenced in the text.
        items:
          type: string
        maxItems: 1
        minItems: 0
      tagIds:
        type: array
        description: IDs of accounts attached to the message itself, independent of the text (for example a person tagged in an Instagram photo so their profile is linked from the image). A 'tag' here uses the same convention as Meta (Facebook, Instagram) and LinkedIn, where it denotes an explicit association with content rather than a textual reference. Distinct from mentionIds, which represent in-text/caption references. Null or absent when no accounts are tagged on the message.
        items:
          type: string
        maxItems: 1
        minItems: 0
    description: Information about a public message.
  OpenSocialMediaRecipientAdditionalIdentifier:
    type: object
    required:
    - type
    - value
    properties:
      type:
        type: string
        description: Type of the Identifier
        readOnly: true
        enum:
        - Topic
        - IngestionRule
        - IngestionRuleVersion
        - PhoneNumber
      value:
        type: string
        description: The Identifier value.
        readOnly: true
  ContentModeration:
    type: object
    required:
    - flag
    properties:
      flag:
        type: string
        description: The Content Moderation Flag of the message.
        enum:
        - NotSafeForWork
        - SafeForWork
        - Unknown
      categories:
        type: array
        description: The Content Moderation Categories of the message.
        items:
          type: string
  ConversationContentListPicker:
    type: object
    properties:
      id:
        type: string
        description: Optional unique identifier to help map component replies to form messages where multiple ListPickers can be present.
      sections:
        type: array
        description: An array of sections in the List Picker.
        items:
          $ref: '#/definitions/ConversationContentListPickerSection'
      replyMessage:
        description: The reply message after the user has selected the options from the List Picker.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
      receivedMessage:
        description: The message prompt to select options in the List Picker sections.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
    description: List Picker object for presenting multiple sections of selectable items.
  SocialMediaAsyncAggregateQueryResponse:
    type: object
    properties:
      results:
        type: array
        items:
          $ref: '#/definitions/SocialMediaAggregateDataContainer'
      cursor:
        type: string
        description: Cursor token to retrieve next page
  ConversationContentReceivedReplyMessage:
    type: object
    properties:
      header:
        type: string
        description: Text to show in the header.
      title:
        type: string
        description: Text to show in the title.
      subtitle:
        type: string
        description: Text to show in the subtitle.
      buttonLabel:
        type: string
        description: Text to show on the button label.
      imageUrl:
        type: string
        description: URL of an image.
    description: ReceivedReplyMessage content object.
  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
  DataIngestionRulesMetadata:
    type: object
    properties:
      countByStatus:
        type: object
        description: Count of data ingestion rules by status
        additionalProperties:
          type: integer
          format: int32
      platform:
        type: string
        description: The platform for which the data ingestion rules are available
      totalCount:
        type: integer
        format: int32
        description: The total count of data ingestion rule
  ContentReaction:
    type: object
    required:
    - count
    - reactionType
    properties:
      reactionType:
        type: string
        description: Type of reaction.
        enum:
        - Like
        - Love
        - Wow
        - Haha
        - Sad
        - Angry
        - Thankful
        - Pride
        - Care
        - Share
        - Comment
        - View
        - Rating
      count:
        type: integer
        format: int32
        description: Number of users that reacted this way to the message.
    description: User reaction to public message.
  MessageInfo:
    type: object
    properties:
      localizableMessageCode:
        type: string
        description: Key that can be used to localize the message.
      message:
        type: string
        description: Description of the message.
      messageWithParams:
        type: string
        description: Message with template fields for variable replacement.
      messageParams:
        type: object
        description: Map with fields for variable replacement.
        additionalProperties:
          type: string
  ConversationContentQuickReply:
    type: object
    required:
    - payload
    - text
    properties:
      text:
        type: string
        description: Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply.
      payload:
        type: string
        description: Content of the payload included in the quick reply response. Could be an ID identifying the quick reply response.
      image:
        type: string
        description: URL of an image associated with the quick reply.
      action:
        type: string
        description: Specifies the type of action that is triggered upon clicking the quick reply.
        enum:
        - Message
      summaryText:
        type: string
        description: Summary of what the quick reply relates to.
    description: Quick reply object.
  ConversationPublicMetadata:
    type: object
    properties:
      rootId:
        type: string
        description: The id of the root public message.
      replyToId:
        type: string
        description: The id of the message this public message is replying to.
      url:
        type: string
        description: The URL of the social post on the native platform.
    description: Information about a public message.
  ConversationMessagingChannel:
    type: object
    properties:
      id:
        type: string
        description: The integration ID.
        readOnly: true
      platform:
        type: string
        description: The provider type.
        readOnly: true
        enum:
        - Twitter
        - Facebook
        - Instagram
        - Line
        - Whatsapp
        - WebMessaging
        - Open
        - Apple
        - Sms
      type:
        type: string
        description: Specifies if this message is part of a private or public conversation.
        enum:
        - Public
        - Private
      messageId:
        type: string
        description: Unique provider ID of the message such as a Facebook message ID.
        readOnly: true
      to:
        description: Information about the recipient the message is sent to.
        readOnly: true
        $ref: '#/definitions/ConversationMessagingToRecipient'
      from:
        description: Information about the recipient the message is received from.
        readOnly: true
        $ref: '#/definitions/ConversationMessagingFromRecipient'
      time:
        type: string
        format: date-time
        description: 'Original time of the event. 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: 'Time the message was edited. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateDeleted:
        type: string
        format: date-time
        description: 'Time the message was deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      publicMetadata:
        description: Information about a public message.
        $ref: '#/definitions/ConversationPublicMetadata'
    description: Channel-specific information that describes the message and the message channel/provider.
  FacebookDataIngestionRuleVersionResponseEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/FacebookDataIngestionRuleVersionResponse'
      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
  DataIngestionRuleResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: The countries is available only on twitter data ingestion rule. ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        readOnly: true
        items:
          type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ConversationContentAttachment:
    type: object
    required:
    - mediaType
    properties:
      id:
        type: string
        description: Provider specific ID for attachment.
      mediaType:
        type: string
        description: The type of attachment this instance represents.
        enum:
        - Image
        - Video
        - Audio
        - File
        - Link
      url:
        type: string
        description: URL of the attachment.
      mime:
        type: string
        description: Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml).
      text:
        type: string
        description: Text associated with attachment such as an image caption.
      sha256:
        type: string
        description: Secure hash of the attachment content.
      filename:
        type: string
        description: Suggested file name for attachment.
      contentSizeBytes:
        type: integer
        format: int64
        description: Size in bytes of the attachment content.
    description: Attachment object.
  SocialMediaQueryPredicate:
    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:
        - country
        - language
        - platform
        - topic
        - escalationStatus
        - messageContentType
        - sentiment
        - dataIngestionRule
        - text
        - moderationFlag
        - sourceType
        - verifiedUser
        - followerCount
        - likes
        - shares
        - comments
        - views
        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'
  EscalationRuleRequest:
    type: object
    required:
    - divisionId
    - matchCriteria
    - name
    - priority
    properties:
      name:
        type: string
        description: The name of the escalation rule.
      matchCriteria:
        type: string
        description: The criteria that defines when a social media message should be escalated.
      priority:
        type: integer
        format: int32
        description: The priority of the escalation rule. The lower the number the higer the priority. Once a rule is matched others are skipped.
        minimum: 1
      divisionId:
        type: string
        description: The ID of the division the social escalation rule belongs to.
      description:
        type: string
        description: A description of the social escalation rule.
      status:
        type: string
        description: The status of the escalation rule.
        enum:
        - Active
        - Paused
      openEscalation:
        description: The target integration configuration used for an open message escalation.
        $ref: '#/definitions/EscalationTarget'
      facebookEscalation:
        description: The target integration configuration used for a Facebook message escalation.
        $ref: '#/definitions/EscalationTarget'
      instagramEscalation:
        description: The target integration configuration used for an Instagram message escalation.
        $ref: '#/definitions/EscalationTarget'
      twitterEscalation:
        description: The target integration configuration used for a X (formerly Twitter) message escalation.
        $ref: '#/definitions/EscalationTarget'
      googleBusinessProfileEscalation:
        description: The target integration configuration used for a Google Business Profile message escalation.
        $ref: '#/definitions/EscalationTarget'
  ConversationRecipientAdditionalIdentifier:
    type: object
    required:
    - type
    - value
    properties:
      type:
        type: string
        description: Type of the Identifier
        readOnly: true
        enum:
        - Deployment
        - Subject
        - Unknown
        - Topic
        - IngestionRule
        - IngestionRuleVersion
        - PhoneNumber
        - Bsuid
        - ParentBsuid
        - Username
      value:
        type: string
        description: The Identifier value.
        readOnly: true
    description: Additional identifiers for describing messaging recipient.
  ConversationNotificationTemplateParameter:
    type: object
    required:
    - text
    properties:
      name:
        type: string
        description: Parameter name.
      text:
        type: string
        description: Parameter text value.
    description: Template parameters for placeholders in template.
  ConversationEventCoBrowse:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Describes the type of CoBrowse event.
        enum:
        - Offering
        - OfferingExpired
        - OfferingAccepted
        - OfferingRejected
      sessionId:
        type: string
        description: The CoBrowse session ID.
      sessionJoinToken:
        type: string
        description: The CoBrowse session join token.
    description: A CoBrowse event.
  ConversationPushFailedMessageReferences:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: Unique ID of the message.
    description: References of failed messages requiring a push.
  OpenSocialMediaReactionsEvent:
    type: object
    required:
    - reactions
    properties:
      reactions:
        type: array
        description: List of reactions for this event.
        items:
          $ref: '#/definitions/ContentReaction'
    description: Social Message event element.
  ConversationContentListPickerSection:
    type: object
    properties:
      title:
        type: string
        description: Required title for the section.
      multipleSelection:
        type: boolean
        description: Whether multiple items can be selected in this section.
      items:
        type: array
        description: List of items to choice from in the section
        items:
          $ref: '#/definitions/ConversationContentListPickerItem'
    description: List Picker object for presenting a section of selectable items.
  ConversationPushNotificationMessageLabel:
    type: object
    required:
    - body
    - title
    properties:
      title:
        type: string
        description: Title to use in the push for each language configured in the deploymentId
      body:
        type: string
        description: Body to use in the push for each language configured in the deploymentId
    description: A Push notification message label.
  ConversationContentCard:
    type: object
    required:
    - actions
    - title
    properties:
      title:
        type: string
        description: Text to show in the title.
      description:
        type: string
        description: Text to show in the description.
      image:
        type: string
        description: URL of an image.
      video:
        type: string
        description: URL of a video.
      defaultAction:
        description: The default button action.
        $ref: '#/definitions/ConversationContentCardAction'
      actions:
        type: array
        description: An array of action objects.
        items:
          $ref: '#/definitions/ConversationContentCardAction'
    description: Card content object.
  OpenSocialMediaRecipient:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        description: The recipient ID specific to the provider.
      idType:
        type: string
        description: The recipient ID type. This is used to indicate the format used for the ID.
        enum:
        - Email
        - Phone
        - Opaque
        - Topic
      firstName:
        type: string
        description: First name of the recipient.
      lastName:
        type: string
        description: Last name of the recipient.
      nickname:
        type: string
        description: Nickname or display name of the recipient.
      image:
        type: string
        description: URL of an image that represents the recipient.
      additionalIds:
        type: array
        description: List of recipient additional identifiers
        items:
          $ref: '#/definitions/OpenSocialMediaRecipientAdditionalIdentifier'
    description: Information about the recipient the message is sent to or received from.
  ConversationContentReaction:
    type: object
    required:
    - count
    properties:
      reactionType:
        type: string
        description: Type of reaction.
        enum:
        - None
        - Like
        - Love
        - Wow
        - Haha
        - Sad
        - Angry
        - Thankful
        - Pride
        - Care
        - Share
        - Comment
        - View
        - Rating
      count:
        type: integer
        format: int32
        description: Number of users that reacted this way to the message.
    description: User reaction to public message.
  ConversationNotificationTemplateHeader:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        description: Template header type.
        enum:
        - Text
        - Media
      text:
        type: string
        description: Header text. For WhatsApp, ignored.
      media:
        description: Media template header image.
        $ref: '#/definitions/ConversationContentAttachment'
      parameters:
        type: array
        description: Template parameters for placeholders in template.
        items:
          $ref: '#/definitions/ConversationNotificationTemplateParameter'
    description: Template header object.
  ConversationReason:
    type: object
    required:
    - message
    properties:
      code:
        type: string
        description: The reason code for the failed message receipt.
        enum:
        - MessageExpired
        - RateLimited
        - MessageNotAllowed
        - GeneralError
        - UnsupportedMessage
        - UnknownMessage
        - InvalidMessageStructure
        - InvalidDestination
        - ServerError
        - MediaTypeNotAllowed
        - InvalidMediaContentLength
        - RecipientOptedOut
        - DataFiltered
      message:
        type: string
        description: Description of the reason for the failed message receipt.
    description: Reasons for a failed message receipt.
  ConversationContentListPickerItem:
    type: object
    properties:
      id:
        type: string
        description: Unique identifier for the list picker item
      title:
        type: string
        description: The main text displayed for the item.
      subtitle:
        type: string
        description: Additional text providing more details about the item.
      imageUrl:
        type: string
        description: URL of an image to be displayed alongside the item.
    description: Represents a selectable item in a list picker.
  ConversationContentForm:
    type: object
    required:
    - cannedResponseId
    properties:
      introduction:
        description: The intro component, used to give an intro into what the form entails
        $ref: '#/definitions/ConversationContentIntroduction'
      formPages:
        type: array
        description: Form pages
        items:
          $ref: '#/definitions/ConversationFormPage'
      receivedMessage:
        description: The message prompt to fill out the form received.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
      replyMessage:
        description: The reply message after the user has filled out the form received.
        $ref: '#/definitions/ConversationContentReceivedReplyMessage'
      showSummary:
        type: boolean
        description: Show summary at end of form submission.
      response:
        type: array
        description: Content of the payload included in the Form response.
        items:
          $ref: '#/definitions/ConversationFormResponseComponent'
      originatingMessageId:
        type: string
        description: Reference to the ID of the original message.
      cannedResponseId:
        type: string
        description: The id of the canned response which was used to create the form.
    description: Form content object.
  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'
  EscalationRuleResponse:
    type: object
    required:
    - divisionId
    - matchCriteria
    properties:
      id:
        type: string
        description: ID of the escalation rule.
      name:
        type: string
        description: The name of the escalation rule.
      matchCriteria:
        type: string
        description: The criteria that defines when a social media message should be escalated.
      priority:
        type: integer
        format: int32
        description: The priority of the escalation rule.
      divisionId:
        type: string
        description: The ID of the division the social escalation rule belongs to.
      description:
        type: string
        description: A description of the social escalation rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the escalation rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateModified:
        type: string
        format: date-time
        description: 'Timestamp indicating when the escalation rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      status:
        type: string
        description: The status of the escalation rule.
        enum:
        - Active
        - Paused
      openEscalation:
        description: The target integration configuration used for an open message escalation.
        $ref: '#/definitions/EscalationTarget'
      facebookEscalation:
        description: The target integration configuration used for a Facebook message escalation.
        $ref: '#/definitions/EscalationTarget'
      instagramEscalation:
        description: The target integration configuration used for an Instagram message escalation.
        $ref: '#/definitions/EscalationTarget'
      twitterEscalation:
        description: The target integration configuration used for a X (formerly Twitter) message escalation.
        $ref: '#/definitions/EscalationTarget'
      googleBusinessProfileEscalation:
        description: The target integration configuration used for a Google Business Profile message escalation.
        $ref: '#/definitions/EscalationTarget'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  ConversationContentPush:
    type: object
    required:
    - deviceToken
    - deviceTokenId
    - deviceType
    - expiration
    - failedMessages
    - notificationMessage
    - pushProviderIntegration
    properties:
      deviceType:
        type: string
        description: The device type used to send the push notification
        enum:
        - Android
        - IOS
      deviceTokenId:
        type: string
        description: Unique Id of the device token
      deviceToken:
        type: string
        description: device token from the notification provider
      failedMessages:
        type: array
        description: MessageIds failed to be sent which trigger the push event
        items:
          $ref: '#/definitions/ConversationPushFailedMessageReferences'
      notificationMessage:
        description: Title and body localized according to deployment
        $ref: '#/definitions/ConversationPushNotificationMessageLabel'
      pushProviderIntegration:
        description: Push provider integrations details configured on the deployment
        $ref: '#/definitions/ConversationPushProviderIntegration'
      expiration:
        type: integer
        format: int64
        description: The time to live of the pushed message
    description: A Push object
  SocialMediaAggregateDataContainer:
    type: object
    properties:
      group:
        type: object
        description: A mapping from dimension to value
        additionalProperties:
          type: string
      data:
        type: array
        items:
          $ref: '#/definitions/SocialMediaStatisticalResponse'
  TwitterDataHistoricalTweetRequest:
    type: object
    required:
    - searchTerms
    properties:
      searchTerms:
        type: string
        description: Search terms to use in the query
      countries:
        type: array
        description: ISO 3166-1 alpha-2 country codes to use for the search. Defaults to worldwide.
        items:
          type: string
  SocialMediaAsyncAggregationQuery:
    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 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 computations into distinct named subgroups rather than across the entire result set as if it were one group.
        items:
          type: string
          enum:
          - country
          - language
          - platform
          - topic
          - escalationStatus
          - messageContentType
          - sentiment
          - dataIngestionRule
          - text
          - moderationFlag
          - sourceType
          - verifiedUser
          - followerCount
          - likes
          - shares
          - comments
          - views
      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/SocialMediaQueryFilter'
      metrics:
        type: array
        description: Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
        items:
          type: string
          enum:
          - nSocialPosts
          - oSocialAuthors
          - oSocialSentiment
          - oSocialEngagement
          - nSocialReviewRating
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
  SocialMediaStatisticalSummary:
    type: object
    properties:
      max:
        type: number
      min:
        type: number
      count:
        type: integer
        format: int64
      countNegative:
        type: integer
        format: int64
      countPositive:
        type: integer
        format: int64
      countNeutral:
        type: integer
        format: int64
      countUnknown:
        type: integer
        format: int64
      sum:
        type: number
      average:
        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
  DataIngestionRuleStatusPatchRequest:
    type: object
    required:
    - status
    properties:
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Paused
  SocialEscalationResponseEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/EscalationRuleResponse'
      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
  ConversationMessageContent:
    type: object
    required:
    - contentType
    properties:
      contentType:
        type: string
        description: Type of this content element.
        enum:
        - Reactions
        - Attachment
        - Location
        - QuickReply
        - Notification
        - ButtonResponse
        - Story
        - Mention
        - Card
        - Carousel
        - Text
        - QuickReplyV2
        - DatePicker
        - InteractiveApplication
        - ListPicker
        - PaymentRequest
        - PaymentResponse
        - Push
        - Form
        - RoadsideAssistance
        - RichLink
        - NotificationResponse
        - Unknown
      location:
        description: Location content.
        $ref: '#/definitions/ConversationContentLocation'
      attachment:
        description: Attachment content.
        $ref: '#/definitions/ConversationContentAttachment'
      quickReply:
        description: Quick reply content.
        $ref: '#/definitions/ConversationContentQuickReply'
      buttonResponse:
        description: Button response content.
        $ref: '#/definitions/ConversationContentButtonResponse'
      template:
        description: Template notification content.
        $ref: '#/definitions/ConversationContentNotificationTemplate'
      story:
        description: Ephemeral story content.
        $ref: '#/definitions/ConversationContentStory'
      card:
        description: Card content
        $ref: '#/definitions/ConversationContentCard'
      carousel:
        description: Carousel content
        $ref: '#/definitions/ConversationContentCarousel'
      text:
        description: Text content.
        $ref: '#/definitions/ConversationContentText'
      quickReplyV2:
        description: Quick reply V2 content.
        $ref: '#/definitions/ConversationContentQuickReplyV2'
      reactions:
        type: array
        description: A set of reactions to a message.
        items:
          $ref: '#/definitions/ConversationContentReaction'
      datePicker:
        description: Date picker content.
        $ref: '#/definitions/ConversationContentDatePicker'
      interactiveApplication:
        description: InteractiveApplication content.
        $ref: '#/definitions/ConversationContentInteractiveApplication'
      listPicker:
        description: List picker content.
        $ref: '#/definitions/ConversationContentListPicker'
      paymentRequest:
        description: Payment request content.
        $ref: '#/definitions/ConversationContentPaymentRequest'
      paymentResponse:
        description: Payment response content.
        $ref: '#/definitions/ConversationContentPaymentResponse'
      push:
        description: Push content.
        $ref: '#/definitions/ConversationContentPush'
      form:
        description: Form content.
        $ref: '#/definitions/ConversationContentForm'
      notificationResponse:
        description: Notification response content, e.g. an Apple Invitation acceptance.
        $ref: '#/definitions/ConversationContentNotificationResponse'
    description: Message content element. If contentType = "Attachment" only one item is allowed.
  TwitterDataIngestionRuleVersionResponseEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/TwitterDataIngestionRuleVersionResponse'
      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
  FacebookDataIngestionRuleRequest:
    type: object
    required:
    - name
    properties:
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      integrationId:
        type: string
        description: Id of the Integration when source is owned (Authenticated). This entity is created using the /conversations/messaging/integrations/facebook resource. Optional when configuring non-owned pages.
  ConversationFormPageComponent:
    type: object
    properties:
      formComponentType:
        type: string
        description: Type of this form component element
        enum:
        - ListPicker
        - DatePicker
        - WheelPicker
        - Input
      datePicker:
        description: Date Picker content.
        $ref: '#/definitions/ConversationContentDatePicker'
      wheelPicker:
        description: Wheel Picker content.
        $ref: '#/definitions/ConversationContentWheelPicker'
      listPicker:
        description: List Picker content.
        $ref: '#/definitions/ConversationContentListPicker'
      input:
        description: Input content.
        $ref: '#/definitions/ConversationContentInput'
    description: 'Form component element. Examples include: List Picker, Date Picker, Wheel Picker and Input text.'
  OpenDataIngestionRuleRequest:
    type: object
    required:
    - externalSource
    - name
    properties:
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      externalSource:
        description: The external source associated with this open data ingestion rule, which will be used when performing identity resolution
        $ref: '#/definitions/DomainEntityRef'
  SocialTopicPatchRequest:
    type: object
    properties:
      name:
        type: string
        description: Name of the social topic.
      description:
        type: string
        description: A description of the social topic.
      divisionId:
        type: string
        description: The ID of the division the social topic currently belongs to OR which it should be moved to.
  FacebookDataIngestionRuleVersionResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the Facebook data ingestion rule.
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      status:
        type: string
        description: The status of the data ingestion rule.
        enum:
        - Active
        - Deleted
        - Error
        - Paused
        - Pending
        - SystemPaused
      version:
        type: integer
        format: int32
        description: The version number of the data ingestion rule.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the data ingestion rule 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: 'Timestamp indicating when the data ingestion rule was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      platform:
        type: string
        description: The platform of the data ingestion rule.
        readOnly: true
      ingestionRuleInfo:
        description: The Info about ingestion rule.
        $ref: '#/definitions/MessageInfo'
      countries:
        type: array
        description: The countries is available only on twitter data ingestion rule. ISO 3166-1 alpha-2 country codes where Data Ingestion Rules should apply. Defaults to worldwide.
        readOnly: true
        items:
          type: string
      integrationId:
        type: string
        description: Id of the Integration when source is owned (Authenticated). This entity is created using the /conversations/messaging/integrations/facebook resource. Optional when configuring non-owned pages.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  DataIngestionRuleResponseEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/DataIngestionRuleResponse'
      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
  SocialTopicResponse:
    type: object
    properties:
      id:
        type: string
        description: ID of the social topic.
      name:
        type: string
        description: The name of the social topic.
      description:
        type: string
        description: A description of the social topic.
      dateCreated:
        type: string
        format: date-time
        description: 'Timestamp indicating when the social topic was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateModified:
        type: string
        format: date-time
        description: 'Timestamp indicating when the social topic was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      divisionId:
        type: string
        description: The ID of the division to which the social topic belongs to.
      status:
        type: string
        description: The status of the social topic.
        enum:
        - Active
        - Pending
        - Deleted
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  InstagramDataIngestionRuleRequest:
    type: object
    required:
    - integrationId
    - name
    properties:
      name:
        type: string
        description: The name of the data ingestion rule.
      description:
        type: string
        description: A description of the data ingestion rule.
      integrationId:
        type: string
        description: The Integration Id from which public social posts are ingested. This entity is created using the /conversations/messaging/integrations/instagram resource
  OpenSocialNormalizedMessageEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/OpenSocialMediaNormalizedMessage'
      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
  InstagramDataIngestionRuleVersionResponseEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/InstagramDataIngestionRuleVersionResponse'
      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
  ConversationMessagingFromRecipient:
    type: object
    required:
    - id
    properties:
      nickname:
        type: string
        description: Nickname or display name of the recipient.
        readOnly: true
      id:
        type: string
        description: The recipient ID specific to the provider.
      idType:
        type: string
        description: The recipient ID type. This is used to indicate the format used for the ID.
        readOnly: true
        enum:
        - Email
        - Phone
        - Opaque
      image:
        type: string
        description: URL of an image that represents the recipient.
      firstName:
        type: string
        description: First name of the recipient.
      lastName:
        type: string
        description: Last name of the recipient.
      email:
        type: string
        description: E-mail address of the recipient.
        readOnly: true
      externalContactId:
        type: string
        description: The identifier of the external contact.
      additionalIds:
        type: array
        description: List of recipient additional identifiers
        readOnly: true
        items:
          $ref: '#/definitions/ConversationRecipientAdditionalIdentifier'
    description: Information about the recipient the message is received from.
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/