Class IndesignSdk

constructor

• new IndesignSdk(args?: { client?: Client; key?: string }): IndesignSdk

  Parameters

  • Optionalargs: { client?: Client; key?: string }

  Returns IndesignSdk

Static Readonly__registry

convertPdfToInDesign

• convertPdfToInDesign<ThrowOnError extends boolean = false>(
      options: Options<ConvertPdfToInDesignData, ThrowOnError>,
  ): RequestResult<
      ConvertPdfToInDesignResponses,
      ConvertPdfToInDesignErrors,
      ThrowOnError,
      "fields",
  >

  Convert PDF to InDesign document

  Converts PDF documents to editable InDesign (INDD or IDML) format. The output is a ZIP file (default name 'output.zip') containing subfolders (named after each input PDF) with the converted document and associated assets. If embedLinks is false, assets are provided in a separate folder within the ZIP. If embedLinks is true, all links are embedded in the InDesign file. Returns warnings for missing fonts and links.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ConvertPdfToInDesignData, ThrowOnError>

  Returns RequestResult<
      ConvertPdfToInDesignResponses,
      ConvertPdfToInDesignErrors,
      ThrowOnError,
      "fields",
  >

dataMerge

• dataMerge<ThrowOnError extends boolean = false>(
      options: Options<DataMergeData, ThrowOnError>,
  ): RequestResult<
      DataMergeResponses,
      DataMergeErrors,
      ThrowOnError,
      "fields",
  >

  Perform a data merge

  Creates InDesign documents or PDFs by merging CSV data with InDesign templates. Supports multiple output formats: JPEG (image/jpeg), PNG (image/png), PDF (application/pdf), and InDesign (application/x-indesign).

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<DataMergeData, ThrowOnError>

  Returns RequestResult<DataMergeResponses, DataMergeErrors, ThrowOnError, "fields">

dataMergeTags

• dataMergeTags<ThrowOnError extends boolean = false>(
      options: Options<DataMergeTagsData, ThrowOnError>,
  ): RequestResult<
      DataMergeTagsResponses,
      DataMergeTagsErrors,
      ThrowOnError,
      "fields",
  >

  Get data merge tags

  Retrieves the data merge tags from a document.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<DataMergeTagsData, ThrowOnError>

  Returns RequestResult<
      DataMergeTagsResponses,
      DataMergeTagsErrors,
      ThrowOnError,
      "fields",
  >

deleteCustomScript

• deleteCustomScript<ThrowOnError extends boolean = false>(
      options: Options<DeleteCustomScriptData, ThrowOnError>,
  ): RequestResult<
      DeleteCustomScriptResponses,
      DeleteCustomScriptErrors,
      ThrowOnError,
      "fields",
  >

  Delete a Custom Script

  Deletes a single registered custom script. All versions of the script will be permanently removed.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<DeleteCustomScriptData, ThrowOnError>

  Returns RequestResult<
      DeleteCustomScriptResponses,
      DeleteCustomScriptErrors,
      ThrowOnError,
      "fields",
  >

executeCustomScript

• executeCustomScript<ThrowOnError extends boolean = false>(
      options: Options<ExecuteCustomScriptData, ThrowOnError>,
  ): RequestResult<
      ExecuteCustomScriptResponses,
      ExecuteCustomScriptErrors,
      ThrowOnError,
      "fields",
  >

  Submit a custom script execution request

  Submits execution requests for custom scripts. Defines input assets and parameters that the custom script will use during execution.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ExecuteCustomScriptData, ThrowOnError>

  Returns RequestResult<
      ExecuteCustomScriptResponses,
      ExecuteCustomScriptErrors,
      ThrowOnError,
      "fields",
  >

getConvertPdfToInDesignJobStatus

• getConvertPdfToInDesignJobStatus<ThrowOnError extends boolean = false>(
      options: Options<GetConvertPdfToInDesignJobStatusData, ThrowOnError>,
  ): RequestResult<
      GetConvertPdfToInDesignJobStatusResponses,
      GetConvertPdfToInDesignJobStatusErrors,
      ThrowOnError,
      "fields",
  >

  Get status - Convert PDF to InDesign API

  Returns the latest status of a job, in this case a PDF to InDesign conversion job. Poll this endpoint to retrieve the job results, warnings, and download URL of the output, in this case an output ZIP file.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GetConvertPdfToInDesignJobStatusData, ThrowOnError>

  Returns RequestResult<
      GetConvertPdfToInDesignJobStatusResponses,
      GetConvertPdfToInDesignJobStatusErrors,
      ThrowOnError,
      "fields",
  >

getCustomScriptDetails

• getCustomScriptDetails<ThrowOnError extends boolean = false>(
      options: Options<GetCustomScriptDetailsData, ThrowOnError>,
  ): RequestResult<
      GetCustomScriptDetailsResponses,
      GetCustomScriptDetailsErrors,
      ThrowOnError,
      "fields",
  >

  Get Custom Script details

  Retrieves details of a single registered custom script. Includes version, download link, registration date, and script name.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GetCustomScriptDetailsData, ThrowOnError>

  Returns RequestResult<
      GetCustomScriptDetailsResponses,
      GetCustomScriptDetailsErrors,
      ThrowOnError,
      "fields",
  >

getDocumentInfo

• getDocumentInfo<ThrowOnError extends boolean = false>(
      options: Options<GetDocumentInfoData, ThrowOnError>,
  ): RequestResult<
      GetDocumentInfoResponses,
      GetDocumentInfoErrors,
      ThrowOnError,
      "fields",
  >

  Get document information

  Retrieve comprehensive information about INDD/IDML documents. Returns data based on the enabled information types specified in the request.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GetDocumentInfoData, ThrowOnError>

  Returns RequestResult<
      GetDocumentInfoResponses,
      GetDocumentInfoErrors,
      ThrowOnError,
      "fields",
  >

getDocumentInfoJobStatus

• getDocumentInfoJobStatus<ThrowOnError extends boolean = false>(
      options: Options<GetDocumentInfoJobStatusData, ThrowOnError>,
  ): RequestResult<
      GetDocumentInfoJobStatusResponses,
      unknown,
      ThrowOnError,
      "fields",
  >

  Get status - Document Info API

  Returns the latest status of a Document Info job. Poll this endpoint to retrieve the extracted document information including pages, links, fonts, page items, and text stories.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GetDocumentInfoJobStatusData, ThrowOnError>

  Returns RequestResult<
      GetDocumentInfoJobStatusResponses,
      unknown,
      ThrowOnError,
      "fields",
  >

getJobStatus

• getJobStatus<ThrowOnError extends boolean = false>(
      options: Options<GetJobStatusData, ThrowOnError>,
  ): RequestResult<
      GetJobStatusResponses,
      GetJobStatusErrors,
      ThrowOnError,
      "fields",
  >

  Get the status of a job

  Returns the latest status of an executed custom script job.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GetJobStatusData, ThrowOnError>

  Returns RequestResult<GetJobStatusResponses, GetJobStatusErrors, ThrowOnError, "fields">

listAppVersions

• listAppVersions<ThrowOnError extends boolean = false>(
      options: Options<ListAppVersionsData, ThrowOnError>,
  ): RequestResult<
      ListAppVersionsResponses,
      ListAppVersionsErrors,
      ThrowOnError,
      "fields",
  >

  Get Current App Versions

  Retrieves information about all available InDesign app versions. Returns major version, minor version, and status for each registered app version.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ListAppVersionsData, ThrowOnError>

  Returns RequestResult<
      ListAppVersionsResponses,
      ListAppVersionsErrors,
      ThrowOnError,
      "fields",
  >

listCustomScripts

• listCustomScripts<ThrowOnError extends boolean = false>(
      options: Options<ListCustomScriptsData, ThrowOnError>,
  ): RequestResult<
      ListCustomScriptsResponses,
      ListCustomScriptsErrors,
      ThrowOnError,
      "fields",
  >

  List custom scripts API

  Retrieves details of the latest version of all registered custom scripts. Includes version, download link, registration date, and script name. Response is paginated based on list length.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ListCustomScriptsData, ThrowOnError>

  Returns RequestResult<
      ListCustomScriptsResponses,
      ListCustomScriptsErrors,
      ThrowOnError,
      "fields",
  >

remapLinks

• remapLinks<ThrowOnError extends boolean = false>(
      options: Options<RemapLinksData, ThrowOnError>,
  ): RequestResult<
      RemapLinksResponses,
      RemapLinksErrors,
      ThrowOnError,
      "fields",
  >

  Remap links

  Replaces file-based links in InDesign documents with AEM URLs. Particularly useful for customers working with Adobe Experience Manager (AEM) using Adobe Asset Link, enabling designers to work with output files that have direct links to AEM URLs.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<RemapLinksData, ThrowOnError>

  Returns RequestResult<RemapLinksResponses, RemapLinksErrors, ThrowOnError, "fields">

renditionJob

• renditionJob<ThrowOnError extends boolean = false>(
      options: Options<RenditionJobData, ThrowOnError>,
  ): RequestResult<
      RenditionJobResponses,
      RenditionJobErrors,
      ThrowOnError,
      "fields",
  >

  Create JPEG, PNG, or PDF renditions

  Creates JPEG, PNG, or PDF renditions of InDesign documents. Supports multiple output formats: JPEG (image/jpeg), PNG (image/png), and PDF (application/pdf).

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<RenditionJobData, ThrowOnError>

  Returns RequestResult<RenditionJobResponses, RenditionJobErrors, ThrowOnError, "fields">

submitCustomScript

• submitCustomScript<ThrowOnError extends boolean = false>(
      options: Options<SubmitCustomScriptData, ThrowOnError>,
  ): RequestResult<
      SubmitCustomScriptResponses,
      SubmitCustomScriptErrors,
      ThrowOnError,
      "fields",
  >

  Submit a Custom Script

  Submits custom script bundles for registration. Returns a URL for posting execution requests for the registered script.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<SubmitCustomScriptData, ThrowOnError>

  Returns RequestResult<
      SubmitCustomScriptResponses,
      SubmitCustomScriptErrors,
      ThrowOnError,
      "fields",
  >

updateScriptAppVersion

• updateScriptAppVersion<ThrowOnError extends boolean = false>(
      options: Options<UpdateScriptAppVersionData, ThrowOnError>,
  ): RequestResult<
      UpdateScriptAppVersionResponses,
      UpdateScriptAppVersionErrors,
      ThrowOnError,
      "fields",
  >

  Update Custom Script App Version

  Updates the InDesign app version configuration for a registered custom script. Allows customers to specify version strategies: use latest version, fix to a major version, or fix to a specific major and minor version.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<UpdateScriptAppVersionData, ThrowOnError>

  Returns RequestResult<
      UpdateScriptAppVersionResponses,
      UpdateScriptAppVersionErrors,
      ThrowOnError,
      "fields",
  >