damdafa-com Authentication API

openapi: 3.2.0
info:
  title: Damdafa Com Authentication API
  version: 1.0.0
  description: 'Operations tagged Authentication across 4 of this provider''s published API definitions: foto-damdafa-com-openapi.json, mockupper-damdafa-com-openapi.json, foto-damdafa-com-openapi.json, mockupper-damdafa-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /dreamhome
- url: /mockupper
tags:
- name: Authentication
paths:
  /api/v1/auth:
    post:
      tags:
      - Authentication
      summary: Create User
      description: 'Create a new user with username.


        This is an authentication endpoint - it handles the initial sign-up.

        The token is verified as part of the authentication process, not via dependency.

        Provider is determined from X-Provider-Id header (firebase, google, apple).

        Automatically determines the Firebase service (yzfoto/avukatim) from the token.'
      operationId: create_user_api_v1_auth_post
      security:
      - HTTPBearer: []
      parameters:
      - name: X-Provider-Id
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/AUTH_PROVIDER'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Authentication
      summary: Signin User
      description: 'Sign in user and get user information.


        This is an authentication endpoint. Returns user profile from Firestore.

        Provider is determined from X-Provider-Id header (firebase, google, apple).

        Automatically determines the Firebase service (yzfoto/avukatim) from the token.'
      operationId: signin_user_api_v1_auth_get
      security:
      - HTTPBearer: []
      parameters:
      - name: serverAuthCode
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Serverauthcode
      - name: firebaseUserId
        in: query
        required: true
        schema:
          type: string
          title: Firebaseuserid
      - name: name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
      - name: familyName
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Familyname
      - name: email
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
      - name: X-Provider-Id
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/AUTH_PROVIDER'
      - name: X-Device-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Device-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HomeDecorUserWrapperResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Authentication
      summary: Delete User
      description: 'Delete user account.


        This is an authentication endpoint. Deletes user from Firestore.

        Provider is determined from X-Provider-Id header (firebase, google, apple).

        Automatically determines the Firebase service (yzfoto/avukatim) from the token.


        For Apple: Also attempts to revoke Apple refresh token.

        For Firebase: Deletes from both Firebase Auth and Firestore.

        For Google: Deletes from Firestore only (does not revoke Google OAuth tokens).'
      operationId: delete_user_api_v1_auth_delete
      security:
      - HTTPBearer: []
      parameters:
      - name: X-Provider-Id
        in: header
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AUTH_PROVIDER'
          - type: 'null'
          title: X-Provider-Id
      - name: ProviderId
        in: header
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AUTH_PROVIDER'
          - type: 'null'
          title: Providerid
      - name: X-Device-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Device-Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Authentication
      summary: Update User Profile
      description: 'Update current user''s profile information.


        Supports updating profile fields like `isFirstVisit`.

        Automatically determines the Firebase service (yzfoto/avukatim) from the token.

        Works with all authentication providers (Firebase, Google, Apple).


        **Authorization:** User can only update their own profile.'
      operationId: update_user_profile_api_v1_auth_patch
      security:
      - HTTPBearer: []
      parameters:
      - name: ProviderId
        in: header
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AUTH_PROVIDER'
          - type: 'null'
          title: Providerid
      - name: X-Provider-Id
        in: header
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AUTH_PROVIDER'
          - type: 'null'
          title: X-Provider-Id
      - name: X-Device-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Device-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserUpdateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: /dreamhome
components:
  schemas:
    UserSubscriptionSchema:
      properties:
        isActive:
          type: boolean
          title: Isactive
        expiresAt:
          anyOf:
          - type: integer
          - type: number
          - type: string
          - type: string
            format: date-time
          - type: 'null'
          title: Expiresat
        productId:
          type: string
          title: Productid
        transactionId:
          anyOf:
          - type: string
          - type: 'null'
          title: Transactionid
        createdAt:
          anyOf:
          - type: integer
          - type: number
          - type: string
          - type: string
            format: date-time
          - type: 'null'
          title: Createdat
        updatedAt:
          anyOf:
          - type: integer
          - type: number
          - type: string
          - type: string
            format: date-time
          - type: 'null'
          title: Updatedat
      type: object
      required:
      - isActive
      - productId
      title: UserSubscriptionSchema
      description: Schema for current and legacy user subscription objects in Firestore.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AuthCreateRequest:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
          description: User's first name
        familyName:
          type: string
          maxLength: 100
          minLength: 1
          title: Familyname
          description: User's last name
        gender:
          anyOf:
          - type: string
          - type: 'null'
          title: Gender
          description: User's gender
      type: object
      required:
      - name
      - familyName
      title: AuthCreateRequest
      description: Request schema for creating user with Firebase/Apple auth.
      example:
        displayName: John Doe
        email: john@example.com
        serverAuthCode: optional_auth_code
    UserUpdateResponse:
      properties:
        message:
          type: string
          title: Message
          description: Status message
      type: object
      required:
      - message
      title: UserUpdateResponse
      description: Response schema for user update operation.
      example:
        message: User profile updated successfully
    HomeDecorUserResponse:
      properties:
        providerId:
          $ref: '#/components/schemas/AUTH_PROVIDER'
          description: Auth provider (firebase, google, apple)
        uid:
          type: string
          title: Uid
          description: Firebase user ID
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
          description: User email address
        emailVerified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Emailverified
          description: Indicates if the user's email is verified
        displayName:
          anyOf:
          - type: string
          - type: 'null'
          title: Displayname
          description: User display name
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: User's name
        familyName:
          anyOf:
          - type: string
          - type: 'null'
          title: Familyname
          description: User's last name
        profilePhoto:
          anyOf:
          - type: string
          - type: 'null'
          title: Profilephoto
          description: Profile photo URL
        avatar:
          anyOf:
          - type: string
          - type: 'null'
          title: Avatar
          description: Avatar seed or string identifier
        fcmToken:
          anyOf:
          - type: string
          - type: 'null'
          title: Fcmtoken
          description: FCM token for push notifications
        phoneNumber:
          anyOf:
          - type: string
          - type: 'null'
          title: Phonenumber
          description: User's phone number
        credits:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: integer
              - type: number
            propertyNames:
              $ref: '#/components/schemas/CreditKey'
            type: object
          - type: 'null'
          title: Credits
          description: User credits balance keyed by HomeDecor credit keys
        settings:
          anyOf:
          - {}
          - type: 'null'
          title: Settings
        privacy:
          anyOf:
          - {}
          - type: 'null'
          title: Privacy
        notifications:
          anyOf:
          - {}
          - type: 'null'
          title: Notifications
        verification:
          anyOf:
          - {}
          - type: 'null'
          title: Verification
        gender:
          anyOf:
          - $ref: '#/components/schemas/Gender'
          - type: 'null'
        subscriptions:
          items:
            $ref: '#/components/schemas/UserSubscriptionSchema'
          type: array
          title: Subscriptions
          description: User's subscriptions
        activeSubscriptions:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Activesubscriptions
          description: List of active subscription product IDs (computed field, not stored in DB)
        isPremium:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Ispremium
          description: Indicates if the user has any active subscriptions (computed field, not stored in DB)
        hasTriggeredSalesNotification:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Hastriggeredsalesnotification
          description: Whether the user has triggered a sales notification on first launch
          default: false
        createdAt:
          anyOf:
          - type: string
          - type: 'null'
          title: Createdat
          description: Timestamp when the user was created
        updatedAt:
          anyOf:
          - type: string
          - type: 'null'
          title: Updatedat
          description: Timestamp when the user was last updated
      type: object
      required:
      - providerId
      - uid
      title: HomeDecorUserResponse
      description: HomeDecor-specific user response schema.
    AUTH_PROVIDER:
      type: string
      enum:
      - firebase
      - google
      - apple
      title: AUTH_PROVIDER
    CreditKey:
      type: string
      enum:
      - image
      title: CreditKey
    Gender:
      type: string
      enum:
      - male
      - female
      title: Gender
      description: Gender values.
    HomeDecorUserWrapperResponse:
      properties:
        user:
          $ref: '#/components/schemas/HomeDecorUserResponse'
      type: object
      required:
      - user
      title: HomeDecorUserWrapperResponse
      description: Wrapper response containing HomeDecor user data.
    UserUpdateRequest:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Name
          description: User's first name
        familyName:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Familyname
          description: User's last name
        profilePhoto:
          anyOf:
          - type: string
            maxLength: 2083
            minLength: 1
            format: uri
          - type: 'null'
          title: Profilephoto
          description: URL of the user's profile photo
        avatar:
          anyOf:
          - type: string
          - type: 'null'
          title: Avatar
          description: Avatar seed or string identifier
        fcmToken:
          anyOf:
          - type: string
          - type: 'null'
          title: Fcmtoken
          description: FCM token for push notifications
        gender:
          anyOf:
          - $ref: '#/components/schemas/Gender'
          - type: 'null'
          description: User's gender
      type: object
      title: UserUpdateRequest
      description: Request schema for updating user profile information.
    UserResponse:
      properties:
        providerId:
          $ref: '#/components/schemas/AUTH_PROVIDER'
          description: Auth provider (firebase, google, apple)
        uid:
          type: string
          title: Uid
          description: Firebase user ID
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
          description: User email address
        emailVerified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Emailverified
          description: Indicates if the user's email is verified
        displayName:
          anyOf:
          - type: string
          - type: 'null'
          title: Displayname
          description: User display name
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: User's name
        familyName:
          anyOf:
          - type: string
          - type: 'null'
          title: Familyname
          description: User's last name
        profilePhoto:
          anyOf:
          - type: string
          - type: 'null'
          title: Profilephoto
          description: Profile photo URL
        avatar:
          anyOf:
          - type: string
          - type: 'null'
          title: Avatar
          description: Avatar seed or string identifier
        fcmToken:
          anyOf:
          - type: string
          - type: 'null'
          title: Fcmtoken
          description: FCM token for push notifications
        phoneNumber:
          anyOf:
          - type: string
          - type: 'null'
          title: Phonenumber
          description: User's phone number
        credits:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: integer
              - type: number
            type: object
          - type: 'null'
          title: Credits
          description: User credits balance
        settings:
          anyOf:
          - {}
          - type: 'null'
          title: Settings
        privacy:
          anyOf:
          - {}
          - type: 'null'
          title: Privacy
        notifications:
          anyOf:
          - {}
          - type: 'null'
          title: Notifications
        verification:
          anyOf:
          - {}
          - type: 'null'
          title: Verification
        gender:
          anyOf:
          - $ref: '#/components/schemas/Gender'
          - type: 'null'
        subscriptions:
          items:
            $ref: '#/components/schemas/UserSubscriptionSchema'
          type: array
          title: Subscriptions
          description: User's subscriptions
        activeSubscriptions:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Activesubscriptions
          description: List of active subscription product IDs (computed field, not stored in DB)
        isPremium:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Ispremium
          description: Indicates if the user has any active subscriptions (computed field, not stored in DB)
        hasTriggeredSalesNotification:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Hastriggeredsalesnotification
          description: Whether the user has triggered a sales notification on first launch
          default: false
        createdAt:
          anyOf:
          - type: string
          - type: 'null'
          title: Createdat
          description: Timestamp when the user was created
        updatedAt:
          anyOf:
          - type: string
          - type: 'null'
          title: Updatedat
          description: Timestamp when the user was last updated
      type: object
      required:
      - providerId
      - uid
      title: UserResponse
      description: User information response schema.
    UserWrapperResponse:
      properties:
        user:
          $ref: '#/components/schemas/UserResponse'
      type: object
      required:
      - user
      title: UserWrapperResponse
      description: 'Wrapper response containing user data.


        Maintains consistency with Flask API structure while leveraging

        FastAPI''s automatic validation and documentation.'
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- foto-damdafa-com-openapi.json
- mockupper-damdafa-com-openapi.json
- foto-damdafa-com-openapi.json
- mockupper-damdafa-com-openapi.json