Class Editors

constructor

• new Editors(api: Api): Editors

  Parameters

  • api: Api

  Returns Editors

api

addSchema

• addSchema(
      data: Required<Pick<ElementSchema, "properties" | "id" | "scope">>,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<ElementSchema, void>>

  Parameters

  • data: Required<Pick<ElementSchema, "properties" | "id" | "scope">>
  • Optionaloptions: { stage?: Stage }

  Returns Promise<ApiResponse<ElementSchema, void>>

cloneEditorsData

• cloneEditorsData(
      sourceOrganization: string,
      destinationOrganization: string,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<{ schemas: string[]; templates: string[] }, void>>

  Parameters

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

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

getAttributeSummary

• getAttributeSummary(
      scope?: string,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<GetAttributesResponse, void>>

  Parameters

  • Optionalscope: string
  • Optionaloptions: { stage?: Stage }

  Returns Promise<ApiResponse<GetAttributesResponse, void>>

getLegacyTypeDefinition

• getLegacyTypeDefinition(
      type: string,
  ): Promise<ApiResponse<ElementTypeDefinition, ElementTypeDefinition>>

  Parameters

  • type: string

  Returns Promise<ApiResponse<ElementTypeDefinition, ElementTypeDefinition>>

getOrganizationSettings

• getOrganizationSettings(
      organization: string,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<OrganizationSettings, void>>

  Parameters

  • organization: string
  • Optionaloptions: { stage?: Stage }

  Returns Promise<ApiResponse<OrganizationSettings, void>>

getSchemaHistory

• getSchemaHistory(
      scope: string,
      id: string,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<SchemaHistorySummary[], 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

getSchemaHistoryEntry

• getSchemaHistoryEntry(
      scope: string,
      id: string,
      historyId: string,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<SchemaHistoryEntry, void>>

  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

getSchemasSummary

• getSchemasSummary(
      options?: { stage?: Stage },
  ): Promise<
      ApiResponse<
          Record<
              string,
              { organizationId?: string[]; schema: string; templates?: string[] }[],
          >,
          void,
      >,
  >

  Parameters

  • Optionaloptions: { stage?: Stage }

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

getSchemasSummaryFull

• getSchemasSummaryFull(
      options?: { stage?: Stage },
  ): Promise<ApiResponse<Record<string, Record<string, ElementSchema>>, void>>

  Parameters

  • Optionaloptions: { stage?: Stage }

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

getScope

• getScope(
      scope?: string,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<ScopeResponse, void>>

  Parameters

  • Optionalscope: string
  • Optionaloptions: { stage?: Stage }

  Returns Promise<ApiResponse<ScopeResponse, void>>

getScopeList

• getScopeList(
      options?: { stage?: Stage },
  ): Promise<ApiResponse<{ id: string; name: string }[], void>>

  Parameters

  • Optionaloptions: { stage?: Stage }

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

getTemplate

• getTemplate(
      schemaId: `${string}/${Type}`,
      templateId?: string,
      options?: { cache?: false; stage?: Stage; strict?: boolean },
  ): Promise<ApiResponse<Template, void>>

  Parameters

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

  Returns Promise<ApiResponse<Template, void>>

getTemplateHistory

• getTemplateHistory(
      scope: string,
      elementId: string,
      templateId: string,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<TemplateHistorySummary[], 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

getTemplateHistoryEntry

• getTemplateHistoryEntry(
      scope: string,
      elementId: string,
      templateId: string,
      historyId: string,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<TemplateHistoryEntry, void>>

  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

getTypeSchema

• getTypeSchema(
      schemaId: `${string}/${Type}`,
      options?: { cache?: false; stage?: Stage },
  ): Promise<ApiResponse<ElementSchema, void>>

  Parameters

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

  Returns Promise<ApiResponse<ElementSchema, void>>

saveTemplate

• saveTemplate(
      schemaId: `${string}/${Type}`,
      templateId?: string,
      data?: Partial<Template>,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<Template, void>>

  Parameters

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

  Returns Promise<ApiResponse<Template, void>>

saveTypeSchema

• saveTypeSchema(
      schemaId: `${string}/${Type}`,
      data: Partial<ElementSchema>,
      options?: { stage?: Stage },
  ): Promise<
      ApiResponse<ElementSchema & { children?: ElementSchema[] }, void>,
  >

  Parameters

  • schemaId: `${string}/${Type}`
  • data: Partial<ElementSchema>
  • Optionaloptions: { stage?: Stage }

  Returns Promise<ApiResponse<ElementSchema & { children?: ElementSchema[] }, void>>

upsertOrganizationSettings

• upsertOrganizationSettings(
      data: OrganizationSettings,
      options?: { stage?: Stage },
  ): Promise<ApiResponse<OrganizationSettings, void>>

  Parameters

  • data: OrganizationSettings
  • Optionaloptions: { stage?: Stage }

  Returns Promise<ApiResponse<OrganizationSettings, void>>