openapi: 3.0.0
info:
  title: Unified.to METADATA API
  version: "1.0"
  description: One API to Rule Them All
  contact:
    email: hello@unified.to
    url: https://unified.to/contact
  termsOfService: https://unified.to/tos
externalDocs:
  description: API Documentation
  url: https://docs.unified.to
tags:
  - name: unifiedapi
    description: Unified.to API
  - name: metadata
security:
  - jwt: []
servers:
  - url: https://api.unified.to
    description: North American data region
  - url: https://api-eu.unified.to
    description: European data region
  - url: https://api-au.unified.to
    description: Australian data region
components:
  securitySchemes:
    jwt:
      type: apiKey
      name: authorization
      in: header
  requestBodies:
    MetadataMetadata:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/MetadataMetadata"
  schemas:
    property_MetadataMetadata_options:
      type: array
      items:
        type: string
    property_MetadataMetadata_objects:
      type: object
      additionalProperties: true
    MetadataMetadata:
      type: object
      properties:
        id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        name:
          type: string
        slug:
          type: string
        format:
          type: string
          enum:
            - TEXT
            - NUMBER
            - DATE
            - BOOLEAN
            - FILE
            - TEXTAREA
            - SINGLE_SELECT
            - MULTIPLE_SELECT
            - MEASUREMENT
            - PRICE
            - YES_NO
            - CURRENCY
            - URL
          x-speakeasy-unknown-values: allow
        original_format:
          type: string
        options:
          $ref: "#/components/schemas/property_MetadataMetadata_options"
        object_type:
          type: string
        objects:
          $ref: "#/components/schemas/property_MetadataMetadata_objects"
        is_required:
          type: boolean
        raw:
          type: object
          additionalProperties: true
      required:
        - name
        - object_type
    MetadataMetadatas:
      type: array
      items:
        $ref: "#/components/schemas/MetadataMetadata"
paths:
  /metadata/{connection_id}/metadata:
    post:
      summary: Create a metadata
      parameters:
        - schema:
            type: array
            items:
              type: string
              enum:
                - id
                - created_at
                - updated_at
                - name
                - slug
                - format
                - original_format
                - options
                - object_type
                - objects
                - is_required
                - raw
          name: fields
          in: query
          required: false
          description: Fields to return
        - schema:
            type: string
          name: raw
          in: query
          required: false
          description: "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar"
        - schema:
            type: string
          description: ID of the connection
          name: connection_id
          in: path
          required: true
      tags:
        - metadata
        - metadata
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MetadataMetadata"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MetadataMetadata"
          description: Successful
      security:
        - jwt: []
      operationId: createMetadataMetadata
    get:
      summary: List all metadatas
      parameters:
        - schema:
            type: number
          name: limit
          in: query
          required: false
        - schema:
            type: number
          name: offset
          in: query
          required: false
        - schema:
            type: string
          name: updated_gte
          in: query
          required: false
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        - schema:
            type: string
          name: sort
          in: query
          required: false
        - schema:
            type: string
          name: order
          in: query
          required: false
        - schema:
            type: string
          name: query
          in: query
          required: false
          description: Query string to search. eg. email address or name
        - schema:
            type: string
          name: type
          in: query
          required: false
          description: The type to filter by
        - schema:
            type: array
            items:
              type: string
              enum:
                - id
                - created_at
                - updated_at
                - name
                - slug
                - format
                - original_format
                - options
                - object_type
                - objects
                - is_required
                - raw
          name: fields
          in: query
          required: false
          description: Fields to return
        - schema:
            type: string
          name: raw
          in: query
          required: false
          description: "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar"
        - schema:
            type: string
          description: ID of the connection
          name: connection_id
          in: path
          required: true
      tags:
        - metadata
        - metadata
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MetadataMetadatas"
          description: Successful
      security:
        - jwt: []
      operationId: listMetadataMetadatas
  /metadata/{connection_id}/metadata/{id}:
    get:
      summary: Retrieve a metadata
      parameters:
        - schema:
            type: array
            items:
              type: string
              enum:
                - id
                - created_at
                - updated_at
                - name
                - slug
                - format
                - original_format
                - options
                - object_type
                - objects
                - is_required
                - raw
          name: fields
          in: query
          required: false
          description: Fields to return
        - schema:
            type: string
          name: raw
          in: query
          required: false
          description: "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar"
        - schema:
            type: string
          description: ID of the connection
          name: connection_id
          in: path
          required: true
        - schema:
            type: string
          description: ID of the Metadata
          name: id
          in: path
          required: true
      tags:
        - metadata
        - metadata
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MetadataMetadata"
          description: Successful
      security:
        - jwt: []
      operationId: getMetadataMetadata
    put:
      summary: Update a metadata
      parameters:
        - schema:
            type: array
            items:
              type: string
              enum:
                - id
                - created_at
                - updated_at
                - name
                - slug
                - format
                - original_format
                - options
                - object_type
                - objects
                - is_required
                - raw
          name: fields
          in: query
          required: false
          description: Fields to return
        - schema:
            type: string
          name: raw
          in: query
          required: false
          description: "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar"
        - schema:
            type: string
          description: ID of the connection
          name: connection_id
          in: path
          required: true
        - schema:
            type: string
          description: ID of the Metadata
          name: id
          in: path
          required: true
      tags:
        - metadata
        - metadata
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MetadataMetadata"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MetadataMetadata"
          description: Successful
      security:
        - jwt: []
      operationId: updateMetadataMetadata
    patch:
      summary: Update a metadata
      parameters:
        - schema:
            type: array
            items:
              type: string
              enum:
                - id
                - created_at
                - updated_at
                - name
                - slug
                - format
                - original_format
                - options
                - object_type
                - objects
                - is_required
                - raw
          name: fields
          in: query
          required: false
          description: Fields to return
        - schema:
            type: string
          name: raw
          in: query
          required: false
          description: "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar"
        - schema:
            type: string
          description: ID of the connection
          name: connection_id
          in: path
          required: true
        - schema:
            type: string
          description: ID of the Metadata
          name: id
          in: path
          required: true
      tags:
        - metadata
        - metadata
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MetadataMetadata"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MetadataMetadata"
          description: Successful
      security:
        - jwt: []
      operationId: patchMetadataMetadata
    delete:
      summary: Remove a metadata
      parameters:
        - schema:
            type: string
          description: ID of the connection
          name: connection_id
          in: path
          required: true
        - schema:
            type: string
          description: ID of the Metadata
          name: id
          in: path
          required: true
      tags:
        - metadata
        - metadata
      responses:
        "200":
          description: Successful
        default:
          headers:
            Content-Type:
              required: false
              schema:
                type: string
          content: {}
          description: Successful
      security:
        - jwt: []
      operationId: removeMetadataMetadata