Class Editors

constructor

• new Editors(api): Editors

• Parameters

  • api: Api

  Returns Editors

api

addSchema

• addSchema(data): Promise<ApiResponse<ElementSchema, void>>

• Parameters

  • data: Partial<ElementSchema>

  Returns Promise<ApiResponse<ElementSchema, void>>

cloneEditorsData

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

• Parameters

  • sourceOrganization: string

  • destinationOrganization: string

  • Optional stage: string

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

getAttributeSummary

• getAttributeSummary(scope?): Promise<ApiResponse<{
      key: string;
      used: {
          id: string;
          value: Attribute;
      }[];
  }[], void>>

• Parameters

  • Optional scope: string

  Returns Promise<ApiResponse<{
      key: string;
      used: {
          id: string;
          value: Attribute;
      }[];
  }[], void>>

getLegacyTypeDefinition

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

• Parameters

  • type: string

  Returns Promise<ApiResponse<ElementTypeDefinition, ElementTypeDefinition>>

getOrganizationSettings

• getOrganizationSettings(organization, stage?): Promise<ApiResponse<OrganizationSettings, void>>

• Parameters

  • organization: string

  • Optional stage: string

  Returns Promise<ApiResponse<OrganizationSettings, void>>

getSchemasSummary

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

• Parameters

  • Optional stage: string

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

getSchemasSummaryFull

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

• Parameters

  • Optional stage: string

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

getScope

• getScope(scope?): Promise<ApiResponse<ScopeResponse, void>>

• Parameters

  • Optional scope: string

  Returns Promise<ApiResponse<ScopeResponse, void>>

getScopeList

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

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

getTemplate

• getTemplate($id, templateId?, stage?): Promise<ApiResponse<Template, void>>

• Parameters

  • $id: string

  • templateId: string = DEFAULT_TEMPLATE_ID

  • Optional stage: string

  Returns Promise<ApiResponse<Template, void>>

getTypeSchema

• getTypeSchema($id, stage?): Promise<ApiResponse<ElementSchema, void>>

• Parameters

  • $id: string

  • Optional stage: string

  Returns Promise<ApiResponse<ElementSchema, void>>

saveTemplate

• saveTemplate(scope, elementId, templateId?, data?, stage?): Promise<ApiResponse<Template, void>>

• Parameters

  • scope: string

  • elementId: string

  • Optional templateId: string

  • Optional data: Partial<Template>

  • Optional stage: string

  Returns Promise<ApiResponse<Template, void>>

saveTypeSchema

• saveTypeSchema($id, data, stage?): Promise<ApiResponse<ElementSchema, void>>

• Parameters

  • $id: string

  • data: Partial<ElementSchema>

  • Optional stage: string

  Returns Promise<ApiResponse<ElementSchema, void>>

upsertOrganizationSettings

• upsertOrganizationSettings(data, stage?): Promise<ApiResponse<OrganizationSettings, void>>

• Parameters

  • data: OrganizationSettings

  • Optional stage: string

  Returns Promise<ApiResponse<OrganizationSettings, void>>