openapi: 3.2.0
info:
  title: Databento OpenAPI specification Registration API
  version: 0.167.1
tags:
- name: registration
paths:
  /v0/registration/teams/invitation/peek:
    get:
      tags:
      - registration
      summary: Peek Team Invitation
      operationId: peek_team_invitation_v0_registration_teams_invitation_peek_get
      parameters:
      - name: invitation_code
        in: query
        required: true
        schema:
          type: string
          title: Invitation Code
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamInvitationIntentView'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/registration/teams/close_trial:
    post:
      tags:
      - registration
      summary: Close Trial
      operationId: close_trial_v0_registration_teams_close_trial_post
      security:
      - OAuth2PasswordBearerWithCookie: []
      parameters:
      - name: payment_method
        in: query
        required: true
        schema:
          type: string
          title: Payment Method
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/registration/teams/claim_trial:
    post:
      tags:
      - registration
      summary: Claim Trial Invitation
      operationId: claim_trial_invitation_v0_registration_teams_claim_trial_post
      parameters:
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      - name: db_session_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Session Id
      - name: marketing_tracing
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Marketing Tracing
      - name: db_device_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Device Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TeamClaimTrial'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/registration/teams/{invitation_code}/complete:
    post:
      tags:
      - registration
      summary: Complete Team Invitation Registration
      operationId: complete_team_invitation_registration_v0_registration_teams__invitation_code__complete_post
      parameters:
      - name: invitation_code
        in: path
        required: true
        schema:
          type: string
          title: Invitation Code
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      - name: db_session_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Session Id
      - name: marketing_tracing
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Marketing Tracing
      - name: db_device_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Device Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TeamUserCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/registration/register:
    post:
      tags:
      - registration
      summary: Register Account
      operationId: register_account_v0_registration_register_post
      parameters:
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      - name: db_session_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Session Id
      - name: marketing_tracing
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Marketing Tracing
      - name: db_device_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Device Id
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_register_account_v0_registration_register_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/registration/register/contact:
    post:
      tags:
      - registration
      summary: Add Contact For User Signup
      operationId: add_contact_for_user_signup_v0_registration_register_contact_post
      security:
      - OAuth2PasswordBearerWithCookie: []
      parameters:
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      - name: db_session_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Session Id
      - name: marketing_tracing
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Marketing Tracing
      - name: db_device_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Device Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignupWizardContact'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - registration
      summary: Get Contact For User Signup
      operationId: get_contact_for_user_signup_v0_registration_register_contact_get
      security:
      - OAuth2PasswordBearerWithCookie: []
      parameters:
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/registration/register/billing:
    post:
      tags:
      - registration
      summary: Add Billing To Signup Wizard
      operationId: add_billing_to_signup_wizard_v0_registration_register_billing_post
      security:
      - OAuth2PasswordBearerWithCookie: []
      parameters:
      - name: same
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          default: 1
          title: Same
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/WizardBillingEdit'
              - type: 'null'
              title: Contact In
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeSetupIntent'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/registration/register/complete:
    post:
      tags:
      - registration
      summary: Complete Signup Wizard
      operationId: complete_signup_wizard_v0_registration_register_complete_post
      security:
      - OAuth2PasswordBearerWithCookie: []
      parameters:
      - name: payment_method
        in: query
        required: true
        schema:
          type: string
          title: Payment Method
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      - name: db_session_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Session Id
      - name: marketing_tracing
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Marketing Tracing
      - name: db_device_id
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Device Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Complete Signup Wizard V0 Registration Register Complete Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v0/registration/register/test:
    get:
      tags:
      - registration
      summary: Test Registration
      operationId: test_registration_v0_registration_register_test_get
      parameters:
      - name: retry
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Retry
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Body_register_account_v0_registration_register_post:
      properties:
        grant_type:
          anyOf:
          - type: string
            pattern: password
          - type: 'null'
          title: Grant Type
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        scope:
          type: string
          title: Scope
          default: ''
        client_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Id
        client_secret:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Secret
      type: object
      required:
      - username
      - password
      title: Body_register_account_v0_registration_register_post
    WizardBillingEdit:
      properties:
        address_line1:
          type: string
          title: Address Line1
        city:
          type: string
          title: City
        state_province_region:
          type: string
          title: State Province Region
        country_region:
          type: string
          title: Country Region
        postal_code:
          type: string
          title: Postal Code
        address_line2:
          anyOf:
          - type: string
          - type: 'null'
          title: Address Line2
      type: object
      required:
      - address_line1
      - city
      - state_province_region
      - country_region
      - postal_code
      title: WizardBillingEdit
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TeamClaimTrial:
      properties:
        invitation_code:
          type: string
          title: Invitation Code
        email:
          type: string
          title: Email
        password:
          type: string
          title: Password
        full_name:
          type: string
          title: Full Name
        address:
          $ref: '#/components/schemas/TeamContactUpdate'
      type: object
      required:
      - invitation_code
      - email
      - password
      - full_name
      - address
      title: TeamClaimTrial
    StripeSetupIntent:
      properties:
        setup_intent:
          additionalProperties: true
          type: object
          title: Setup Intent
        client_secret:
          type: string
          title: Client Secret
      type: object
      required:
      - setup_intent
      - client_secret
      title: StripeSetupIntent
    Token:
      properties:
        token_type:
          type: string
          title: Token Type
          default: Bearer
        access_token:
          type: string
          title: Access Token
        expires_in:
          type: integer
          title: Expires In
        expires_on:
          type: integer
          title: Expires On
        refresh_token:
          type: string
          title: Refresh Token
      type: object
      required:
      - access_token
      - expires_in
      - expires_on
      - refresh_token
      title: Token
    TeamInvitationIntentView:
      properties:
        team_name:
          type: string
          title: Team Name
        inviter_name:
          type: string
          title: Inviter Name
        inviter_email:
          type: string
          title: Inviter Email
        email:
          type: string
          title: Email
        email_available:
          type: boolean
          title: Email Available
        trial_info:
          anyOf:
          - $ref: '#/components/schemas/TeamTrialDetails'
          - type: 'null'
      type: object
      required:
      - team_name
      - inviter_name
      - inviter_email
      - email
      - email_available
      title: TeamInvitationIntentView
    TeamTrialDetails:
      properties:
        is_active:
          type: boolean
          title: Is Active
        note:
          type: string
          title: Note
        start_date:
          type: string
          title: Start Date
        end_date:
          type: string
          title: End Date
        datasets:
          items:
            type: string
          type: array
          title: Datasets
      type: object
      required:
      - is_active
      - note
      - start_date
      - end_date
      - datasets
      title: TeamTrialDetails
    TeamUserCreate:
      properties:
        email:
          type: string
          title: Email
        password:
          type: string
          title: Password
        full_name:
          type: string
          title: Full Name
      type: object
      required:
      - email
      - password
      - full_name
      title: TeamUserCreate
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    TeamContactUpdate:
      properties:
        address_line1:
          type: string
          title: Address Line1
        city:
          type: string
          title: City
        state_province_region:
          type: string
          title: State Province Region
        country_region:
          type: string
          title: Country Region
        postal_code:
          type: string
          title: Postal Code
        phone_cc:
          type: string
          title: Phone Cc
        phone_num:
          type: string
          title: Phone Num
        address_type:
          type: string
          title: Address Type
        company_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Company Name
        address_line2:
          anyOf:
          - type: string
          - type: 'null'
          title: Address Line2
      type: object
      required:
      - address_line1
      - city
      - state_province_region
      - country_region
      - postal_code
      - phone_cc
      - phone_num
      - address_type
      title: TeamContactUpdate
    SignupWizardContact:
      properties:
        full_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Full Name
        team_name:
          type: string
          title: Team Name
        address_line1:
          type: string
          title: Address Line1
        city:
          type: string
          title: City
        state_province_region:
          type: string
          title: State Province Region
        country_region:
          type: string
          title: Country Region
        postal_code:
          type: string
          title: Postal Code
        phone_cc:
          type: string
          title: Phone Cc
        phone_num:
          type: string
          title: Phone Num
        address_type:
          type: string
          title: Address Type
        company_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Company Name
          default: ''
        address_line2:
          anyOf:
          - type: string
          - type: 'null'
          title: Address Line2
      type: object
      required:
      - team_name
      - address_line1
      - city
      - state_province_region
      - country_region
      - postal_code
      - phone_cc
      - phone_num
      - address_type
      title: SignupWizardContact
  securitySchemes:
    OAuth2PasswordBearerWithCookie:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v0/auth/login
    HTTPBasic:
      type: http
      scheme: basic