{
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "schemes": [
    "https",
    "http"
  ],
  "swagger": "2.0",
  "info": {
    "description": "Backend REST server for Parla. Source of truth for go-swagger server generation.",
    "title": "Parla API V4",
    "version": "4.0.0"
  },
  "host": "api.getparla.com",
  "basePath": "/v4",
  "paths": {
    "/app/install": {
      "post": {
        "tags": [
          "App"
        ],
        "summary": "Installation Tracking",
        "operationId": "appInstall",
        "parameters": [
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/XPlatform"
          },
          {
            "$ref": "#/parameters/XBuild"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/InstallRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/app/session": {
      "post": {
        "tags": [
          "App"
        ],
        "summary": "Session Tracking",
        "operationId": "appSession",
        "parameters": [
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/XPlatform"
          },
          {
            "$ref": "#/parameters/XBuild"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/auth/checkup": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Check Up Email",
        "operationId": "authCheckup",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/CheckUpRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/auth/confirm": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Confirm Email by code",
        "operationId": "authConfirm",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/ConfirmRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/auth/guest": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Guest Login",
        "operationId": "guestLogin",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/auth/login": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Login",
        "operationId": "authLogin",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/LoginRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/auth/logout": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Logout",
        "operationId": "authLogout",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/auth/recover/finish": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Recovery Finish",
        "operationId": "authRestoreFinish",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/RestoreFinishRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/auth/recover/request": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Recovery Request",
        "operationId": "authRestore",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/RestoreRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/auth/resend": {
      "post": {
        "tags": [
          "Auth"
        ],
        "summary": "Resend confirmation Email",
        "operationId": "authResend",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/course/topic": {
      "get": {
        "tags": [
          "Course"
        ],
        "summary": "Course topics",
        "operationId": "topicList",
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/iap/ios_receipt": {
      "post": {
        "tags": [
          "Receipt"
        ],
        "summary": "Receipt validation",
        "operationId": "receipt",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/ReceiptRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/oauth/apple": {
      "post": {
        "tags": [
          "oAuth"
        ],
        "summary": "Apple Login",
        "operationId": "appleLogin",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/JWTTokenRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/oauth/facebook": {
      "post": {
        "tags": [
          "oAuth"
        ],
        "summary": "Facebook Login",
        "operationId": "facebookLogin",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/AccessTokenRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/sync": {
      "post": {
        "tags": [
          "Synchronization"
        ],
        "summary": "Offline-ready Events",
        "operationId": "sync",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/ActionsRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/sync/apple": {
      "post": {
        "tags": [
          "Synchronization"
        ],
        "summary": "Apple Linking",
        "operationId": "syncApple",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/JWTTokenRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/sync/facebook": {
      "post": {
        "tags": [
          "Synchronization"
        ],
        "summary": "Facebook Linking",
        "operationId": "syncFacebook",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/AccessTokenRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    },
    "/sync/user": {
      "post": {
        "tags": [
          "Synchronization"
        ],
        "summary": "Online User-related Events",
        "operationId": "syncUser",
        "parameters": [
          {
            "$ref": "#/parameters/XToken"
          },
          {
            "$ref": "#/parameters/XVendorId"
          },
          {
            "$ref": "#/parameters/UserAgent"
          },
          {
            "$ref": "#/parameters/XForwardedFor"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/UserUpdateRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/Ok"
          },
          "default": {
            "$ref": "#/responses/Error"
          }
        }
      }
    }
  },
  "definitions": {
    "APIError": {
      "description": "Wrapper for all API errors",
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int64"
        },
        "data": {
          "type": "object",
          "x-nullable": true
        },
        "message": {
          "type": "string"
        }
      }
    },
    "AccessTokenRequest": {
      "type": "object",
      "properties": {
        "access_token": {
          "type": "string"
        }
      }
    },
    "Action": {
      "type": "object",
      "properties": {
        "action": {
          "type": "string",
          "example": "training_passed"
        },
        "local_id": {
          "type": "string"
        },
        "payload": {
          "type": "string"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time"
        },
        "trigger": {
          "type": "string"
        },
        "xp": {
          "type": "integer",
          "format": "int64"
        }
      }
    },
    "ActionsRequest": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Action"
          }
        },
        "device": {
          "$ref": "#/definitions/Device"
        },
        "last_sync": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "CheckUpRequest": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        }
      }
    },
    "ConfirmRequest": {
      "type": "object",
      "properties": {
        "code": {
          "description": "Code hash",
          "type": "string"
        }
      }
    },
    "Device": {
      "type": "object",
      "properties": {
        "idfa": {
          "type": "string"
        },
        "model": {
          "type": "string"
        },
        "os_version": {
          "type": "string"
        },
        "push_token": {
          "type": "string"
        },
        "resolution": {
          "type": "string"
        },
        "uuid": {
          "type": "string"
        }
      }
    },
    "ErrorResponse": {
      "description": "Wrapper for all API error responses",
      "type": "object",
      "properties": {
        "error": {
          "$ref": "#/definitions/APIError"
        },
        "result": {
          "type": "object",
          "x-nullable": true
        },
        "version": {
          "type": "integer",
          "format": "int64",
          "example": 1
        }
      }
    },
    "GenericResponse": {
      "description": "Wrapper for all API success responses",
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "x-nullable": true
        },
        "result": {
          "description": "Endpoint-specific payload",
          "type": "object"
        },
        "version": {
          "type": "integer",
          "format": "int64",
          "example": 1
        }
      }
    },
    "InstallRequest": {
      "type": "object",
      "properties": {
        "tracking": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "JWTTokenRequest": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string"
        }
      }
    },
    "LoginRequest": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    },
    "ReceiptRequest": {
      "type": "object",
      "properties": {
        "receipt": {
          "type": "string"
        },
        "restore": {
          "type": "boolean"
        }
      }
    },
    "RestoreFinishRequest": {
      "type": "object",
      "properties": {
        "password_hash": {
          "type": "string"
        },
        "token": {
          "type": "string"
        }
      }
    },
    "RestoreRequest": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        }
      }
    },
    "UserUpdateRequest": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "password_hash": {
          "type": "string"
        }
      }
    }
  },
  "parameters": {
    "UserAgent": {
      "type": "string",
      "name": "User-Agent",
      "in": "header"
    },
    "XBuild": {
      "type": "string",
      "description": "Client app build number",
      "name": "X-Build",
      "in": "header"
    },
    "XForwardedFor": {
      "type": "string",
      "description": "Client IP forwarded by the reverse proxy",
      "name": "X-Forwarded-For",
      "in": "header"
    },
    "XPlatform": {
      "type": "string",
      "description": "Client platform (iOS | Android)",
      "name": "X-Platform",
      "in": "header"
    },
    "XToken": {
      "type": "string",
      "description": "Session token",
      "name": "X-Token",
      "in": "header"
    },
    "XVendorId": {
      "type": "string",
      "description": "Device vendor id",
      "name": "X-Vendor-Id",
      "in": "header"
    }
  },
  "responses": {
    "Error": {
      "description": "Error envelope.",
      "schema": {
        "$ref": "#/definitions/ErrorResponse"
      }
    },
    "Ok": {
      "description": "Success envelope. `result` shape depends on the endpoint.",
      "schema": {
        "$ref": "#/definitions/GenericResponse"
      }
    }
  }
}