Pandium Connector Calls API

openapi: 3.2.0
info:
  title: Pandium Connector Calls API
  description: The Pandium API provides programmatic access to native Pandium resources including integrations,
    tenants, and runs. It uses standard REST conventions and HTTP methods, allowing B2B SaaS companies to manage
    their integration platform, trigger syncs, proxy connector calls, and manage tenant metadata.
  version: 2.0.0
  contact:
    name: Pandium
    url: https://www.pandium.com/
  license:
    name: Proprietary
    url: https://www.pandium.com/terms-and-conditions
  termsOfService: https://www.pandium.com/terms-and-conditions
servers:
- url: https://api.pandium.io
  description: Production
- url: https://api.sandbox.pandium.com
  description: Sandbox
security:
- apiKey: []
tags:
- name: Connector Calls
  description: Proxy calls to external APIs on behalf of a tenant.
paths:
  /v2/tenants/{tenant_id}/connectors/{connector_name}/call:
    post:
      operationId: proxyConnectorCall
      summary: Pandium Proxy a connector call
      description: Make a call to an external API (REST, SOAP, or XML) on behalf of a tenant. This endpoint proxies
        a synchronous connector call using the tenant's stored credentials.
      tags:
      - Connector Calls
      parameters:
      - $ref: '#/components/parameters/TenantId'
      - name: connector_name
        in: path
        description: The name of the connector to call through.
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorCallRequest'
      responses:
        '200':
          description: Successful connector call response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorCallResponse'
        '400':
          description: Bad request. Invalid parameters.
        '401':
          description: Unauthorized. Invalid or missing API key.
        '404':
          description: Tenant or connector not found.
  /v2/tenants/{tenant_id}/connectors/{connector_name}/soap:
    post:
      summary: Proxy Connector Call Soap
      description: Proxy a synchronous connector call to a SOAP endpoint.
      operationId: proxy_connector_call_soap_v2_tenants__tenant_id__connectors__connector_name__soap_post
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: integer
          description: Unique identifier for a tenant
          title: Tenant Id
        description: Unique identifier for a tenant
      - name: connector_name
        in: path
        required: true
        schema:
          type: string
          description: Name of the tenant's authenticated connector
          title: Connector Name
        description: Name of the tenant's authenticated connector
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyXmlRequestBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyInternalError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyExternalError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Connector Calls
  /v2/tenants/{tenant_id}/connectors/{connector_name}/xml:
    post:
      summary: Proxy Connector Call Xml
      description: Proxy a synchronous connector call to an XML endpoint.
      operationId: proxy_connector_call_xml_v2_tenants__tenant_id__connectors__connector_name__xml_post
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: integer
          description: Unique identifier for a tenant
          title: Tenant Id
        description: Unique identifier for a tenant
      - name: connector_name
        in: path
        required: true
        schema:
          type: string
          description: Name of the tenant's authenticated connector
          title: Connector Name
        description: Name of the tenant's authenticated connector
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyXmlRequestBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyInternalError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyExternalError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Connector Calls
components:
  parameters:
    TenantId:
      name: tenant_id
      in: path
      description: The unique identifier of the tenant.
      required: true
      schema:
        type: integer
  schemas:
    ConnectorCallResponse:
      type: object
      properties:
        status_code:
          type: integer
          description: The HTTP status code returned by the external API.
        headers:
          type: object
          description: Response headers from the external API.
          additionalProperties:
            type: string
        body:
          type: object
          description: The response body from the external API.
          additionalProperties: true
    ConnectorCallRequest:
      type: object
      required:
      - method
      - path
      properties:
        method:
          type: string
          description: The HTTP method to use for the external API call.
          enum:
          - GET
          - POST
          - PUT
          - PATCH
          - DELETE
        path:
          type: string
          description: The path to call on the external API.
        headers:
          type: object
          description: Additional headers to include in the request.
          additionalProperties:
            type: string
        body:
          type: object
          description: The request body to send to the external API.
          additionalProperties: true
        query_params:
          type: object
          description: Query parameters to include in the request.
          additionalProperties:
            type: string
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProxyExternalError:
      properties:
        detail:
          type: string
          title: Detail
          description: String-ified object containing the error response from the external service under the "data"
            key. Status code will reflect the status returned from the external service.
      type: object
      title: ProxyExternalError
    ProxyInternalError:
      properties:
        detail:
          type: string
          title: Detail
          description: Description of the internal (Pandium) error.
      type: object
      title: ProxyInternalError
    ProxyResponse:
      properties:
        data:
          additionalProperties: true
          type: object
          title: Data
      type: object
      required:
      - data
      title: ProxyResponse
    ProxyXmlRequestBody:
      properties:
        headers:
          anyOf:
          - additionalProperties: true
            type: object
          - items: {}
            type: array
          - type: 'null'
          title: Headers
          description: Headers needed for the proxied request
        method:
          type: string
          title: Method
          description: HTTP Method
        query_params:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Query Params
          description: Query params needed for the proxied request
        target_url:
          type: string
          title: Target Url
          description: Endpoint for the proxied request
        data:
          anyOf:
          - type: string
          - type: 'null'
          title: Data
          description: XML data for the proxied request. Authentication will be handled by Pandium and doesn't need
            to be included in the request.
      type: object
      title: ProxyXmlRequestBody
    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
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: 'API key generated from the Settings sidebar in the Pandium Integration Hub under the API Access
        tab. Attach it to requests in the X-API-KEY header. Source: https://docs.pandium.com/reference/pandium-api'