Yuzu Health Sponsor API

The Sponsor API from Yuzu Health — 1 operation(s) for sponsor.

OpenAPI Specification

yuzu-health-sponsor-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Yuzu Accumulator (Experimental) Accumulator (Experimental) Sponsor API
  description: Yuzu's Public API
  version: '0.5'
  contact: {}
servers: []
tags:
- name: Sponsor
paths:
  /v2/sponsors/{sponsorNamespace}:
    get:
      description: Fetch details for a specific sponsor by its namespace.
      operationId: SponsorPublicController_getSponsor
      parameters:
      - name: sponsorNamespace
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Sponsor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SponsorDto'
      security:
      - public-api-auth: []
      summary: Retrieve a sponsor
      tags:
      - Sponsor
    patch:
      description: Update details of an existing sponsor by its namespace.
      operationId: SponsorPublicController_updateSponsor
      parameters:
      - name: sponsorNamespace
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        description: Sponsor Update Data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SponsorUpdateDto'
      responses:
        '200':
          description: Sponsor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SponsorDto'
      security:
      - public-api-auth: []
      summary: Update a sponsor
      tags:
      - Sponsor
components:
  schemas:
    SponsorDto:
      type: object
      properties:
        id:
          type: string
        namespace:
          type: string
        name:
          type: string
        address:
          type: object
          properties:
            address1:
              type: string
            address2:
              type: string
            city:
              type: string
            state:
              type: string
              enum:
              - AL
              - AK
              - AZ
              - AR
              - CA
              - CO
              - CT
              - DE
              - FL
              - GA
              - HI
              - ID
              - IL
              - IN
              - IA
              - KS
              - KY
              - LA
              - ME
              - MD
              - MA
              - MI
              - MN
              - MS
              - MO
              - MT
              - NE
              - NV
              - NH
              - NJ
              - NM
              - NY
              - NC
              - ND
              - OH
              - OK
              - OR
              - PA
              - RI
              - SC
              - SD
              - TN
              - TX
              - UT
              - VT
              - VA
              - WA
              - WV
              - WI
              - WY
              - DC
              - AS
              - GU
              - MP
              - PR
              - VI
            postalCode:
              type: string
              pattern: ^\d{5}(?:[ -]?\d{4})?$
          required:
          - address1
          - city
          - state
          - postalCode
        bankingVerified:
          type: boolean
        brokerVendor:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            ein:
              type: string
          required:
          - id
          - name
        ein:
          type: string
          pattern: ^(\d{2}-\d{7}|\d{9})$
          example: '123456789'
        businessType:
          type: string
          enum:
          - company
          - government_entity
          - non_profit
        contactEmails:
          type: array
          items:
            type: string
            format: email
            pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
        website:
          type: string
          format: uri
        phoneNumber:
          type: string
          example: '+12125551234'
        description:
          type: string
      required:
      - id
      - namespace
      - name
      - businessType
      - contactEmails
    SponsorUpdateDto:
      type: object
      properties:
        address:
          type: object
          properties:
            address1:
              type: string
            address2:
              type: string
            city:
              type: string
            state:
              type: string
              enum:
              - AL
              - AK
              - AZ
              - AR
              - CA
              - CO
              - CT
              - DE
              - FL
              - GA
              - HI
              - ID
              - IL
              - IN
              - IA
              - KS
              - KY
              - LA
              - ME
              - MD
              - MA
              - MI
              - MN
              - MS
              - MO
              - MT
              - NE
              - NV
              - NH
              - NJ
              - NM
              - NY
              - NC
              - ND
              - OH
              - OK
              - OR
              - PA
              - RI
              - SC
              - SD
              - TN
              - TX
              - UT
              - VT
              - VA
              - WA
              - WV
              - WI
              - WY
              - DC
              - AS
              - GU
              - MP
              - PR
              - VI
            postalCode:
              type: string
              pattern: ^\d{5}(?:[ -]?\d{4})?$
          required:
          - address1
          - city
          - state
          - postalCode
        ein:
          type: string
          pattern: ^(\d{2}-\d{7}|\d{9})$
          example: '123456789'
        contactEmails:
          type: array
          items:
            type: string
            format: email
            pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
        name:
          type: string
        website:
          type: string
          format: uri
        phoneNumber:
          type: string
          example: '+12125551234'
        description:
          type: string
  securitySchemes:
    public-api-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http