Class Editors

Constructors

  • Parameters

    Returns Editors

Properties

api: Api

Methods

  • Parameters

    • sourceOrganization: string
    • destinationOrganization: string
    • Optionaloptions: { stage?: Stage }

    Returns Promise<ApiResponse<{ schemas: string[]; templates: string[] }, void>>

  • Get list of schema history entries (summary only)

    Parameters

    • scope: string

      Schema scope (e.g., "shared", organization ID)

    • id: string

      Schema ID

    • Optionaloptions: { stage?: Stage }

      Optional parameters including stage

    Returns Promise<ApiResponse<SchemaHistorySummary[], void>>

    Array of history summaries

  • Get specific schema history entry with full content

    Parameters

    • scope: string

      Schema scope

    • id: string

      Schema ID

    • historyId: string

      MongoDB ObjectId of the history entry

    • Optionaloptions: { stage?: Stage }

      Optional parameters including stage

    Returns Promise<ApiResponse<SchemaHistoryEntry, void>>

    Full history entry

  • Parameters

    • Optionaloptions: { stage?: Stage }

    Returns Promise<
        ApiResponse<
            Record<
                string,
                { organizationId?: string[]; schema: string; templates?: string[] }[],
            >,
            void,
        >,
    >

  • Parameters

    • Optionaloptions: { stage?: Stage }

    Returns Promise<ApiResponse<Record<string, Record<string, ElementSchema>>, void>>

  • Parameters

    • Optionaloptions: { stage?: Stage }

    Returns Promise<ApiResponse<{ id: string; name: string }[], void>>

  • Parameters

    • schemaId: `${string}/${Type}`
    • templateId: string = DEFAULT_TEMPLATE_ID
    • Optionaloptions: { cache?: false; stage?: Stage; strict?: boolean }

    Returns Promise<ApiResponse<Template, void>>

  • Get list of template history entries (summary only)

    Parameters

    • scope: string

      Template scope (e.g., "shared", organization ID)

    • elementId: string

      Element/schema ID

    • templateId: string

      Template ID

    • Optionaloptions: { stage?: Stage }

      Optional parameters including stage

    Returns Promise<ApiResponse<TemplateHistorySummary[], void>>

    Array of history summaries

  • Get specific template history entry with full content

    Parameters

    • scope: string

      Template scope

    • elementId: string

      Element/schema ID

    • templateId: string

      Template ID

    • historyId: string

      MongoDB ObjectId of the history entry

    • Optionaloptions: { stage?: Stage }

      Optional parameters including stage

    Returns Promise<ApiResponse<TemplateHistoryEntry, void>>

    Full history entry

  • Parameters

    • schemaId: `${string}/${Type}`
    • Optionaloptions: { cache?: false; stage?: Stage }

    Returns Promise<ApiResponse<ElementSchema, void>>

  • Parameters

    • schemaId: `${string}/${Type}`
    • OptionaltemplateId: string
    • Optionaldata: Partial<Template>
    • Optionaloptions: { stage?: Stage }

    Returns Promise<ApiResponse<Template, void>>