Lightdash Mobile push notifications API

openapi: 3.2.0
info:
  title: Lightdash Mobile push notifications API
  version: 2.616.2
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens'
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:
- name: Mobile push notifications
paths:
  /api/v1/mobile/push-notifications/status:
    get:
      operationId: getMobilePushNotificationStatus
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiMobilePushNotificationStatusResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      tags:
      - Mobile push notifications
      security: []
      parameters: []
      summary: Get mobile push notification status
      x-summary-source: derived
  /api/v1/mobile/push-notifications/installations/{installationUuid}:
    put:
      operationId: registerMobilePushInstallation
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiMobilePushInstallationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      tags:
      - Mobile push notifications
      security: []
      parameters:
      - in: path
        name: installationUuid
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiMobilePushInstallationRequest'
      summary: Register mobile push installation
      x-summary-source: derived
    delete:
      operationId: revokeMobilePushInstallation
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiMobilePushInstallationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      tags:
      - Mobile push notifications
      security: []
      parameters:
      - in: path
        name: installationUuid
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      summary: Revoke mobile push installation
      x-summary-source: derived
  /api/v1/mobile/push-notifications/installations/{installationUuid}/live-activity-push-to-start-token:
    put:
      operationId: registerMobilePushLiveActivityPushToStartToken
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiMobilePushLiveActivityPushToStartTokenResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      tags:
      - Mobile push notifications
      security: []
      parameters:
      - in: path
        name: installationUuid
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiMobilePushLiveActivityPushToStartTokenRequest'
      summary: Register mobile push live activity push to start token
      x-summary-source: derived
components:
  schemas:
    MobilePushPlatform:
      type: string
      enum:
      - ios
      - android
    ApiMobilePushLiveActivityPushToStartTokenResponse:
      $ref: '#/components/schemas/ApiSuccessEmpty'
    ApiMobilePushLiveActivityPushToStartTokenRequest:
      properties:
        pushToken:
          type: string
      required:
      - pushToken
      type: object
    AnyType:
      description: 'This AnyType is an alias for any

        The goal is to make it easier to identify any type in the codebase

        without having to eslint-disable all the time

        These are only used on legacy `any` types, don''t use it for new types.

        This is added on a separate file to avoid circular dependencies.'
    UUID:
      type: string
      format: uuid
      description: 'Stringified UUIDv4.

        See [RFC 4112](https://tools.ietf.org/html/rfc4122)'
      pattern: '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}'
    ApiMobilePushInstallationRequest:
      properties:
        platform:
          $ref: '#/components/schemas/MobilePushPlatform'
        deviceToken:
          type: string
        environment:
          $ref: '#/components/schemas/MobilePushEnvironment'
      required:
      - deviceToken
      - environment
      type: object
    MobilePushEnvironment:
      type: string
      enum:
      - sandbox
      - production
    ApiSuccessEmpty:
      properties:
        results: {}
        status:
          type: string
          enum:
          - ok
      required:
      - status
      type: object
    ApiSuccess__enabled-boolean--environments-MobilePushEnvironment-Array--platforms-MobilePushPlatform-Array__:
      properties:
        results:
          properties:
            platforms:
              items:
                $ref: '#/components/schemas/MobilePushPlatform'
              type: array
            environments:
              items:
                $ref: '#/components/schemas/MobilePushEnvironment'
              type: array
            enabled:
              type: boolean
          required:
          - platforms
          - environments
          - enabled
          type: object
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    ApiMobilePushNotificationStatusResponse:
      $ref: '#/components/schemas/ApiSuccess__enabled-boolean--environments-MobilePushEnvironment-Array--platforms-MobilePushPlatform-Array__'
    ApiMobilePushInstallationResponse:
      $ref: '#/components/schemas/ApiSuccessEmpty'
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
          - name
          - statusCode
          type: object
        status:
          type: string
          enum:
          - error
      required:
      - error
      - status
      type: object
      description: 'The Error object is returned from the api any time there is an error.

        The message contains'
  securitySchemes:
    session_cookie:
      type: apiKey
      in: cookie
      name: connect.sid
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: Value should be 'ApiKey <your key>'
x-provenance:
  method: harvested
  publisher: Lightdash
  source: https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)