> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Encodian API reference

> API reference for the Encodian plugin in Corsair: every `encodian.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Barcodes

### aiBarcodeRead

`barcodes.aiBarcodeRead`

Barcode - Read (AI)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.aiBarcodeRead({"body":{"FileContent":"<base64-encoded PNG barcode file>"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileContent?: string,
>   startPage?: number,
>   endPage?: number,
>   barcodeRemoveControlChars?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `barcodes` | `string[] \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### createBarcode

`barcodes.createBarcode`

Barcode - Create

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.createBarcode({"body":{"codeTextEncoding":"Default","dotCodemask":0}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   barcodeType?: AustraliaPost | Aztec | Codabar | CodablockF | Code11 | Code39Standard | Code39Extended | Code128 | Code16K | DatabarExpanded | DatabarExpandedStacked | DatabarLimited | DatabarOmniDirectional | DatabarStacked | DatabarStackedOmniDirectional | DatabarTruncated | DataMatrix | DotCode | EAN8 | EAN13 | GS1Code128 | GS1CodablockF | Interleaved2of5 | ISBN | ISMN | ISSN | ITF6 | ITF14 | MaxiCode | Pdf417 | Planet | Postnet | Standard2of5 | UPCA | UpcaGs1Code128Coupon | UpcaGs1DatabarCoupon | UPCE,
>   barcodeData?: string,
>   barcodeImageFormat?: PNG | JPG | SVG | BMP | TIFF | GIF,
>   captionAbove?: string,
>   captionBelow?: string,
>   sizeMode?: None | Nearest | Fixed | Interpolation,
>   height?: number,
>   width?: number,
>   backColor?: string,
>   barHeight?: number,
>   barColor?: string,
>   filledBars?: boolean,
>   borderColor?: string,
>   borderStyle?: Dash | DashDot | DashDotDot | Dot | Solid,
>   borderVisible?: boolean,
>   borderWidth?: number,
>   paddingBottom?: number,
>   paddingTop?: number,
>   paddingLeft?: number,
>   paddingRight?: number,
>   resolution?: number,
>   rotationangle?: number,
>   xDimension?: number,
>   barcodeValueTextLocation?: None | Above | Below,
>   barcodeCaptionAboveFont?: string,
>   barcodeCaptionAboveFontSize?: number,
>   barcodeCaptionAboveFontColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   barcodeCaptionAboveFontStyle?: Regular | Bold | Italic | Underline | Strikeout,
>   barcodeCaptionAboveFontAlignment?: Left | Centre | Right,
>   barcodeCaptionBelowFont?: string,
>   barcodeCaptionBelowFontSize?: number,
>   barcodeCaptionBelowFontColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   barcodeCaptionBelowFontStyle?: Regular | Bold | Italic | Underline | Strikeout,
>   barcodeCaptionBelowFontAlignment?: Left | Centre | Right,
>   aspectRatio?: number,
>   columns?: number,
>   rows?: number,
>   itfBorderThickness?: number,
>   itfBorderType?: None | Frame | Bar | FrameOut | BarOut,
>   quietZoneCoef?: number,
>   postalShortBarHeight?: number,
>   wideNarrowRatio?: number,
>   supplementData?: string,
>   supplementSpace?: number,
>   australianPostEncodingTable?: CTable | NTable | Other,
>   australianPostShortBarHeight?: number,
>   aztecErrorLevel?: number,
>   aztecSymbolMode?: Auto | Compact | FullRange | Rune,
>   codabarChecksumMode?: Mod10 | Mod16,
>   codabarStartSymbol?: A | B | C | D,
>   codabarStopSymbol?: A | B | C | D,
>   code16KQuietZoneLeftCoef?: number,
>   code16KQuietZoneRightCoef?: number,
>   dataMatrixEcc?: EccAuto | Ecc000 | Ecc050 | Ecc080 | Ecc100 | Ecc140 | Ecc200,
>   dataMatrixEncodeMode?: Auto | ASCII | Bytes | C40 | Text | EDIFACT | ANSIX12 | ExtendedCodetext | Extended | Base256 | Binary | ECI,
>   maxiCodeEncodeMode?: number,
>   pdf417CompactionMode?: Auto | Text | Numeric | Binary,
>   pdf417ErrorLevel?: Level0 | Level1 | Level2 | Level3 | Level4 | Level5 | Level6 | Level7 | Level8,
>   pdf417MacroFileID?: number,
>   pdf417MacroSegmentID?: number,
>   pdf417MacroSegmentsCount?: number,
>   pdf417Truncate?: boolean,
>   codeTextEncoding: Default | Latin1 | BigEndianUnicode | UTF16 | UTF8 | UTF7 | ASCII,
>   dotCodemask: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   barcodeTypeParameter?: AustraliaPost | Aztec | Codabar | CodablockF | Code11 | Code39Standard | Code39Extended | Code128 | Code16K | DatabarExpanded | DatabarExpandedStacked | DatabarLimited | DatabarOmniDirectional | DatabarStacked | DatabarStackedOmniDirectional | DatabarTruncated | DataMatrix | DotCode | EAN8 | EAN13 | GS1Code128 | GS1CodablockF | Interleaved2of5 | ISBN | ISMN | ISSN | ITF6 | ITF14 | MaxiCode | Pdf417 | Planet | Postnet | Standard2of5 | UPCA | UpcaGs1Code128Coupon | UpcaGs1DatabarCoupon | UPCE
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### createQrCode

`barcodes.createQrCode`

QR Code - Create

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.createQrCode({"body":{"barcodeData":"x","barcodeImageFormat":"PNG"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   barcodeData: string,
>   barcodeImageFormat: PNG | JPG | SVG | BMP | TIFF | GIF,
>   height?: number,
>   width?: number,
>   sizeMode?: None | Nearest | Fixed | Interpolation,
>   foreColor?: string,
>   backColor?: string,
>   visibleBorder?: boolean,
>   borderColor?: string,
>   borderStyle?: Dash | DashDot | DashDotDot | Dot | Solid,
>   borderWidth?: number,
>   resolution?: number,
>   encodeMode?: Auto | Bytes | ECIEncoding | ExtendedCodetext | Utf16BEBOM | Utf8BOM,
>   encodeType?: Auto | ForceMicroQR | ForceQR,
>   textEncodingType?: Default | Latin1 | BigEndianUnicode | UTF16 | UTF8 | UTF7 | ASCII,
>   logoFileName?: string,
>   logoFileContent?: string,
>   logoPosition?: Top | Centre,
>   captionAboveText?: string,
>   captionAboveFont?: string,
>   captionAboveFontSize?: number,
>   captionAboveFontColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   captionAboveAlignment?: Left | Centre | Right,
>   captionAboveNoWrap?: boolean,
>   captionBelowText?: string,
>   captionBelowFont?: string,
>   captionBelowFontSize?: number,
>   captionBelowFontColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   captionBelowAlignment?: Left | Centre | Right,
>   captionBelowNoWrap?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### createSwissQrCode

`barcodes.createSwissQrCode`

Swiss QR Code - Create

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.createSwissQrCode({"body":{"account":"x","amount":0,"creditor":{"countryCode":"Afghanistan","name":"x"},"currency":"CHF","debtor":{"countryCode":"Afghanistan","name":"x"},"imageFormat":"PNG","reference":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   imageFormat: PNG | JPG | SVG | BMP | TIFF | GIF,
>   account: string,
>   currency: CHF | EUR,
>   amount: number,
>   reference: string,
>   creditor: {
>     name: string,
>     houseNo?: string,
>     addressLine1?: string,
>     addressLine2?: string,
>     street?: string,
>     town?: string,
>     postcode?: string,
>     countryCode: Afghanistan | AlandIslands | Albania | Algeria | AmericanSamoa | Andorra | Angola | Anguilla | Antarctica | AntiguaAndBarbuda | Argentina | Armenia | Aruba | Australia | Austria | Azerbaijan | Bahamas | Bahrain | Bangladesh | Barbados | Belarus | Belgium | Belize | Benin | Bermuda | Bhutan | Bolivia | BonaireSintEustatiusAndSaba | BosniaAndHerzegovina | Botswana | BouvetIsland | Brazil | BritishIndianOceanTerritory | BruneiDarussalam | Bulgaria | BurkinaFaso | Burundi | Cambodia | Cameroon | Canada | CaboVerde | CaymanIslands | CentralAfricanRepublic | Chad | Chile | China | ChristmasIsland | CocosKeelingIslands | Colombia | Comoros | Congo | CongoDemocraticRepublic | CookIslands | CostaRica | CoteDIvoire | Croatia | Cuba | Curacao | Cyprus | Czechia | Denmark | Djibouti | Dominica | DominicanRepublic | Ecuador | Egypt | ElSalvador | EquatorialGuinea | Eritrea | Estonia | Eswatini | Ethiopia | FalklandIslands | FaroeIslands | Fiji | Finland | France | FrenchGuiana | FrenchPolynesia | FrenchSouthernTerritories | Gabon | Gambia | Georgia | Germany | Ghana | Gibraltar | Greece | Greenland | Grenada | Guadeloupe | Guam | Guatemala | Guernsey | Guinea | GuineaBissau | Guyana | Haiti | HeardAndMcDonaldIslands | HolySee | Honduras | HongKong | Hungary | Iceland | India | Indonesia | Iran | Iraq | Ireland | IsleOfMan | Israel | Italy | Jamaica | Japan | Jersey | Jordan | Kazakhstan | Kenya | Kiribati | KoreaDemocraticPeoplesRepublic | KoreaRepublic | Kuwait | Kyrgyzstan | Laos | Latvia | Lebanon | Lesotho | Liberia | Libya | Liechtenstein | Lithuania | Luxembourg | Macao | Madagascar | Malawi | Malaysia | Maldives | Mali | Malta | MarshallIslands | Martinique | Mauritania | Mauritius | Mayotte | Mexico | Micronesia | Moldova | Monaco | Mongolia | Montenegro | Montserrat | Morocco | Mozambique | Myanmar | Namibia | Nauru | Nepal | Netherlands | NewCaledonia | NewZealand | Nicaragua | Niger | Nigeria | Niue | NorfolkIsland | NorthMacedonia | NorthernMarianaIslands | Norway | Oman | Pakistan | Palau | PalestinianTerritory | Panama | PapuaNewGuinea | Paraguay | Peru | Philippines | Pitcairn | Poland | Portugal | PuertoRico | Qatar | Reunion | Romania | Russia | Rwanda | SaintBarthelemy | SaintHelenaAscensionAndTristanDaCunha | SaintKittsAndNevis | SaintLucia | SaintMartin | SaintPierreAndMiquelon | SaintVincentAndTheGrenadines | Samoa | SanMarino | SaoTomeAndPrincipe | SaudiArabia | Senegal | Serbia | Seychelles | SierraLeone | Singapore | SintMaarten | Slovakia | Slovenia | SolomonIslands | Somalia | SouthAfrica | SouthGeorgiaAndSouthSandwichIslands | SouthSudan | Spain | SriLanka | Sudan | Suriname | SvalbardAndJanMayen | Sweden | Switzerland | Syria | Taiwan | Tajikistan | Tanzania | Thailand | TimorLeste | Togo | Tokelau | Tonga | TrinidadAndTobago | Tunisia | Turkiye | Turkmenistan | TurksAndCaicosIslands | Tuvalu | Uganda | Ukraine | UnitedArabEmirates | UnitedKingdom | UnitedStatesMinorOutlyingIslands | UnitedStates | Uruguay | Uzbekistan | Vanuatu | Venezuela | Vietnam | VirginIslandsBritish | VirginIslandsUS | WallisAndFutuna | WesternSahara | Yemen | Zambia | Zimbabwe
>   },
>   debtor: {
>     name: string,
>     houseNo?: string,
>     addressLine1?: string,
>     addressLine2?: string,
>     street?: string,
>     town?: string,
>     postcode?: string,
>     countryCode: Afghanistan | AlandIslands | Albania | Algeria | AmericanSamoa | Andorra | Angola | Anguilla | Antarctica | AntiguaAndBarbuda | Argentina | Armenia | Aruba | Australia | Austria | Azerbaijan | Bahamas | Bahrain | Bangladesh | Barbados | Belarus | Belgium | Belize | Benin | Bermuda | Bhutan | Bolivia | BonaireSintEustatiusAndSaba | BosniaAndHerzegovina | Botswana | BouvetIsland | Brazil | BritishIndianOceanTerritory | BruneiDarussalam | Bulgaria | BurkinaFaso | Burundi | Cambodia | Cameroon | Canada | CaboVerde | CaymanIslands | CentralAfricanRepublic | Chad | Chile | China | ChristmasIsland | CocosKeelingIslands | Colombia | Comoros | Congo | CongoDemocraticRepublic | CookIslands | CostaRica | CoteDIvoire | Croatia | Cuba | Curacao | Cyprus | Czechia | Denmark | Djibouti | Dominica | DominicanRepublic | Ecuador | Egypt | ElSalvador | EquatorialGuinea | Eritrea | Estonia | Eswatini | Ethiopia | FalklandIslands | FaroeIslands | Fiji | Finland | France | FrenchGuiana | FrenchPolynesia | FrenchSouthernTerritories | Gabon | Gambia | Georgia | Germany | Ghana | Gibraltar | Greece | Greenland | Grenada | Guadeloupe | Guam | Guatemala | Guernsey | Guinea | GuineaBissau | Guyana | Haiti | HeardAndMcDonaldIslands | HolySee | Honduras | HongKong | Hungary | Iceland | India | Indonesia | Iran | Iraq | Ireland | IsleOfMan | Israel | Italy | Jamaica | Japan | Jersey | Jordan | Kazakhstan | Kenya | Kiribati | KoreaDemocraticPeoplesRepublic | KoreaRepublic | Kuwait | Kyrgyzstan | Laos | Latvia | Lebanon | Lesotho | Liberia | Libya | Liechtenstein | Lithuania | Luxembourg | Macao | Madagascar | Malawi | Malaysia | Maldives | Mali | Malta | MarshallIslands | Martinique | Mauritania | Mauritius | Mayotte | Mexico | Micronesia | Moldova | Monaco | Mongolia | Montenegro | Montserrat | Morocco | Mozambique | Myanmar | Namibia | Nauru | Nepal | Netherlands | NewCaledonia | NewZealand | Nicaragua | Niger | Nigeria | Niue | NorfolkIsland | NorthMacedonia | NorthernMarianaIslands | Norway | Oman | Pakistan | Palau | PalestinianTerritory | Panama | PapuaNewGuinea | Paraguay | Peru | Philippines | Pitcairn | Poland | Portugal | PuertoRico | Qatar | Reunion | Romania | Russia | Rwanda | SaintBarthelemy | SaintHelenaAscensionAndTristanDaCunha | SaintKittsAndNevis | SaintLucia | SaintMartin | SaintPierreAndMiquelon | SaintVincentAndTheGrenadines | Samoa | SanMarino | SaoTomeAndPrincipe | SaudiArabia | Senegal | Serbia | Seychelles | SierraLeone | Singapore | SintMaarten | Slovakia | Slovenia | SolomonIslands | Somalia | SouthAfrica | SouthGeorgiaAndSouthSandwichIslands | SouthSudan | Spain | SriLanka | Sudan | Suriname | SvalbardAndJanMayen | Sweden | Switzerland | Syria | Taiwan | Tajikistan | Tanzania | Thailand | TimorLeste | Togo | Tokelau | Tonga | TrinidadAndTobago | Tunisia | Turkiye | Turkmenistan | TurksAndCaicosIslands | Tuvalu | Uganda | Ukraine | UnitedArabEmirates | UnitedKingdom | UnitedStatesMinorOutlyingIslands | UnitedStates | Uruguay | Uzbekistan | Vanuatu | Venezuela | Vietnam | VirginIslandsBritish | VirginIslandsUS | WallisAndFutuna | WesternSahara | Yemen | Zambia | Zimbabwe
>   },
>   encodeMode?: Auto | Bytes | ECIEncoding | ExtendedCodetext | Utf16BEBOM | Utf8BOM,
>   errorCorrectionLevel?: Low | Medium | High | Maximum,
>   resolution?: number,
>   sizeMode?: None | Nearest | Fixed | Interpolation,
>   height?: number,
>   width?: number,
>   borderVisible?: boolean,
>   borderColor?: string,
>   borderStyle?: Dash | DashDot | DashDotDot | Dot | Solid,
>   borderWidth?: number,
>   backColor?: string,
>   foreColor?: string,
>   paddingBottom?: number,
>   paddingLeft?: number,
>   paddingRight?: number,
>   paddingTop?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### readBarcodeFromDocument

`barcodes.readBarcodeFromDocument`

Barcode - Read from Document

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.readBarcodeFromDocument({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileType?: PDF | DOCX,
>   FileContent?: string,
>   barcodeReadConfidence?: Low | Medium | High,
>   barcodeReadQuality?: Normal | High | Low | Max,
>   startPage?: number,
>   endPage?: number,
>   barcodeRemoveControlChars?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `barcodes` | `string[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### readBarcodeFromImage

`barcodes.readBarcodeFromImage`

Barcode - Read from Image

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.readBarcodeFromImage({"body":{"barcodeImageFormat":"PNG","fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   barcodeImageFormat: PNG | JPG | BMP | TIFF | GIF | EMF,
>   barcodeReadConfidence?: Low | Medium | High,
>   barcodeRemoveControlChars?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Value` | `string` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### readQrCodeFromDocument

`barcodes.readQrCodeFromDocument`

QR Code - Read from Document

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.readQrCodeFromDocument({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileType?: PDF | DOCX,
>   FileContent?: string,
>   barcodeReadConfidence?: Low | Medium | High,
>   barcodeReadQuality?: Normal | High | Low | Max,
>   startPage?: number,
>   endPage?: number,
>   barcodeRemoveControlChars?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `qrCodes` | `string[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### readQrCodeFromImage

`barcodes.readQrCodeFromImage`

QR Code - Read from Image

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.readQrCodeFromImage({"body":{"barcodeImageFormat":"PNG","fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   barcodeImageFormat: PNG | JPG | BMP | TIFF | GIF | EMF,
>   barcodeReadConfidence?: Low | Medium | High,
>   barcodeRemoveControlChars?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Value` | `string` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### readSwissQrCodeFromImage

`barcodes.readSwissQrCodeFromImage`

Swiss QR Code - Read from Image

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.readSwissQrCodeFromImage({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   barcodeRemoveControlChars?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `value` | `string \| null` | No | — |
| `account` | `string \| null` | No | — |
| `currency` | `CHF \| EUR \| string \| null` | No | — |
| `amount` | `number \| null` | No | — |
| `reference` | `string \| null` | No | — |
| `creditorName` | `string \| null` | No | — |
| `creditorHouseNo` | `string \| null` | No | — |
| `creditorAddressLine1` | `string \| null` | No | — |
| `creditorAddressLine2` | `string \| null` | No | — |
| `creditorStreet` | `string \| null` | No | — |
| `creditorTown` | `string \| null` | No | — |
| `creditorPostcode` | `string \| null` | No | — |
| `creditorCountryCode` | `Afghanistan \| AlandIslands \| Albania \| Algeria \| AmericanSamoa \| Andorra \| Angola \| Anguilla \| Antarctica \| AntiguaAndBarbuda \| Argentina \| Armenia \| Aruba \| Australia \| Austria \| Azerbaijan \| Bahamas \| Bahrain \| Bangladesh \| Barbados \| Belarus \| Belgium \| Belize \| Benin \| Bermuda \| Bhutan \| Bolivia \| BonaireSintEustatiusAndSaba \| BosniaAndHerzegovina \| Botswana \| BouvetIsland \| Brazil \| BritishIndianOceanTerritory \| BruneiDarussalam \| Bulgaria \| BurkinaFaso \| Burundi \| Cambodia \| Cameroon \| Canada \| CaboVerde \| CaymanIslands \| CentralAfricanRepublic \| Chad \| Chile \| China \| ChristmasIsland \| CocosKeelingIslands \| Colombia \| Comoros \| Congo \| CongoDemocraticRepublic \| CookIslands \| CostaRica \| CoteDIvoire \| Croatia \| Cuba \| Curacao \| Cyprus \| Czechia \| Denmark \| Djibouti \| Dominica \| DominicanRepublic \| Ecuador \| Egypt \| ElSalvador \| EquatorialGuinea \| Eritrea \| Estonia \| Eswatini \| Ethiopia \| FalklandIslands \| FaroeIslands \| Fiji \| Finland \| France \| FrenchGuiana \| FrenchPolynesia \| FrenchSouthernTerritories \| Gabon \| Gambia \| Georgia \| Germany \| Ghana \| Gibraltar \| Greece \| Greenland \| Grenada \| Guadeloupe \| Guam \| Guatemala \| Guernsey \| Guinea \| GuineaBissau \| Guyana \| Haiti \| HeardAndMcDonaldIslands \| HolySee \| Honduras \| HongKong \| Hungary \| Iceland \| India \| Indonesia \| Iran \| Iraq \| Ireland \| IsleOfMan \| Israel \| Italy \| Jamaica \| Japan \| Jersey \| Jordan \| Kazakhstan \| Kenya \| Kiribati \| KoreaDemocraticPeoplesRepublic \| KoreaRepublic \| Kuwait \| Kyrgyzstan \| Laos \| Latvia \| Lebanon \| Lesotho \| Liberia \| Libya \| Liechtenstein \| Lithuania \| Luxembourg \| Macao \| Madagascar \| Malawi \| Malaysia \| Maldives \| Mali \| Malta \| MarshallIslands \| Martinique \| Mauritania \| Mauritius \| Mayotte \| Mexico \| Micronesia \| Moldova \| Monaco \| Mongolia \| Montenegro \| Montserrat \| Morocco \| Mozambique \| Myanmar \| Namibia \| Nauru \| Nepal \| Netherlands \| NewCaledonia \| NewZealand \| Nicaragua \| Niger \| Nigeria \| Niue \| NorfolkIsland \| NorthMacedonia \| NorthernMarianaIslands \| Norway \| Oman \| Pakistan \| Palau \| PalestinianTerritory \| Panama \| PapuaNewGuinea \| Paraguay \| Peru \| Philippines \| Pitcairn \| Poland \| Portugal \| PuertoRico \| Qatar \| Reunion \| Romania \| Russia \| Rwanda \| SaintBarthelemy \| SaintHelenaAscensionAndTristanDaCunha \| SaintKittsAndNevis \| SaintLucia \| SaintMartin \| SaintPierreAndMiquelon \| SaintVincentAndTheGrenadines \| Samoa \| SanMarino \| SaoTomeAndPrincipe \| SaudiArabia \| Senegal \| Serbia \| Seychelles \| SierraLeone \| Singapore \| SintMaarten \| Slovakia \| Slovenia \| SolomonIslands \| Somalia \| SouthAfrica \| SouthGeorgiaAndSouthSandwichIslands \| SouthSudan \| Spain \| SriLanka \| Sudan \| Suriname \| SvalbardAndJanMayen \| Sweden \| Switzerland \| Syria \| Taiwan \| Tajikistan \| Tanzania \| Thailand \| TimorLeste \| Togo \| Tokelau \| Tonga \| TrinidadAndTobago \| Tunisia \| Turkiye \| Turkmenistan \| TurksAndCaicosIslands \| Tuvalu \| Uganda \| Ukraine \| UnitedArabEmirates \| UnitedKingdom \| UnitedStatesMinorOutlyingIslands \| UnitedStates \| Uruguay \| Uzbekistan \| Vanuatu \| Venezuela \| Vietnam \| VirginIslandsBritish \| VirginIslandsUS \| WallisAndFutuna \| WesternSahara \| Yemen \| Zambia \| Zimbabwe \| string \| null` | No | — |
| `debtorName` | `string \| null` | No | — |
| `debtorHouseNo` | `string \| null` | No | — |
| `debtorAddressLine1` | `string \| null` | No | — |
| `debtorAddressLine2` | `string \| null` | No | — |
| `debtorStreet` | `string \| null` | No | — |
| `debtorTown` | `string \| null` | No | — |
| `debtorPostcode` | `string \| null` | No | — |
| `debtorCountryCode` | `Afghanistan \| AlandIslands \| Albania \| Algeria \| AmericanSamoa \| Andorra \| Angola \| Anguilla \| Antarctica \| AntiguaAndBarbuda \| Argentina \| Armenia \| Aruba \| Australia \| Austria \| Azerbaijan \| Bahamas \| Bahrain \| Bangladesh \| Barbados \| Belarus \| Belgium \| Belize \| Benin \| Bermuda \| Bhutan \| Bolivia \| BonaireSintEustatiusAndSaba \| BosniaAndHerzegovina \| Botswana \| BouvetIsland \| Brazil \| BritishIndianOceanTerritory \| BruneiDarussalam \| Bulgaria \| BurkinaFaso \| Burundi \| Cambodia \| Cameroon \| Canada \| CaboVerde \| CaymanIslands \| CentralAfricanRepublic \| Chad \| Chile \| China \| ChristmasIsland \| CocosKeelingIslands \| Colombia \| Comoros \| Congo \| CongoDemocraticRepublic \| CookIslands \| CostaRica \| CoteDIvoire \| Croatia \| Cuba \| Curacao \| Cyprus \| Czechia \| Denmark \| Djibouti \| Dominica \| DominicanRepublic \| Ecuador \| Egypt \| ElSalvador \| EquatorialGuinea \| Eritrea \| Estonia \| Eswatini \| Ethiopia \| FalklandIslands \| FaroeIslands \| Fiji \| Finland \| France \| FrenchGuiana \| FrenchPolynesia \| FrenchSouthernTerritories \| Gabon \| Gambia \| Georgia \| Germany \| Ghana \| Gibraltar \| Greece \| Greenland \| Grenada \| Guadeloupe \| Guam \| Guatemala \| Guernsey \| Guinea \| GuineaBissau \| Guyana \| Haiti \| HeardAndMcDonaldIslands \| HolySee \| Honduras \| HongKong \| Hungary \| Iceland \| India \| Indonesia \| Iran \| Iraq \| Ireland \| IsleOfMan \| Israel \| Italy \| Jamaica \| Japan \| Jersey \| Jordan \| Kazakhstan \| Kenya \| Kiribati \| KoreaDemocraticPeoplesRepublic \| KoreaRepublic \| Kuwait \| Kyrgyzstan \| Laos \| Latvia \| Lebanon \| Lesotho \| Liberia \| Libya \| Liechtenstein \| Lithuania \| Luxembourg \| Macao \| Madagascar \| Malawi \| Malaysia \| Maldives \| Mali \| Malta \| MarshallIslands \| Martinique \| Mauritania \| Mauritius \| Mayotte \| Mexico \| Micronesia \| Moldova \| Monaco \| Mongolia \| Montenegro \| Montserrat \| Morocco \| Mozambique \| Myanmar \| Namibia \| Nauru \| Nepal \| Netherlands \| NewCaledonia \| NewZealand \| Nicaragua \| Niger \| Nigeria \| Niue \| NorfolkIsland \| NorthMacedonia \| NorthernMarianaIslands \| Norway \| Oman \| Pakistan \| Palau \| PalestinianTerritory \| Panama \| PapuaNewGuinea \| Paraguay \| Peru \| Philippines \| Pitcairn \| Poland \| Portugal \| PuertoRico \| Qatar \| Reunion \| Romania \| Russia \| Rwanda \| SaintBarthelemy \| SaintHelenaAscensionAndTristanDaCunha \| SaintKittsAndNevis \| SaintLucia \| SaintMartin \| SaintPierreAndMiquelon \| SaintVincentAndTheGrenadines \| Samoa \| SanMarino \| SaoTomeAndPrincipe \| SaudiArabia \| Senegal \| Serbia \| Seychelles \| SierraLeone \| Singapore \| SintMaarten \| Slovakia \| Slovenia \| SolomonIslands \| Somalia \| SouthAfrica \| SouthGeorgiaAndSouthSandwichIslands \| SouthSudan \| Spain \| SriLanka \| Sudan \| Suriname \| SvalbardAndJanMayen \| Sweden \| Switzerland \| Syria \| Taiwan \| Tajikistan \| Tanzania \| Thailand \| TimorLeste \| Togo \| Tokelau \| Tonga \| TrinidadAndTobago \| Tunisia \| Turkiye \| Turkmenistan \| TurksAndCaicosIslands \| Tuvalu \| Uganda \| Ukraine \| UnitedArabEmirates \| UnitedKingdom \| UnitedStatesMinorOutlyingIslands \| UnitedStates \| Uruguay \| Uzbekistan \| Vanuatu \| Venezuela \| Vietnam \| VirginIslandsBritish \| VirginIslandsUS \| WallisAndFutuna \| WesternSahara \| Yemen \| Zambia \| Zimbabwe \| string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### readSwissQrCodesFromDocument

`barcodes.readSwissQrCodesFromDocument`

Swiss QR Code - Read from Document

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.barcodes.readSwissQrCodesFromDocument({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   barcodeReadConfidence?: Low | Medium | High,
>   barcodeReadQuality?: Normal | High | Low | Max,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   barcodeRemoveControlChars?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `swissQrCodes` | `object[] \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] swissQrCodes full type
>
> ```ts theme={null}
> {
>   value?: string | null,
>   account?: string | null,
>   amount?: number | null,
>   currency?: CHF | EUR | string | null,
>   reference?: string | null,
>   creditor?: {
>     name?: string | null,
>     houseNo?: string | null,
>     addressLine1?: string | null,
>     addressLine2?: string | null,
>     street?: string | null,
>     town?: string | null,
>     postcode?: string | null,
>     countryCode?: Afghanistan | AlandIslands | Albania | Algeria | AmericanSamoa | Andorra | Angola | Anguilla | Antarctica | AntiguaAndBarbuda | Argentina | Armenia | Aruba | Australia | Austria | Azerbaijan | Bahamas | Bahrain | Bangladesh | Barbados | Belarus | Belgium | Belize | Benin | Bermuda | Bhutan | Bolivia | BonaireSintEustatiusAndSaba | BosniaAndHerzegovina | Botswana | BouvetIsland | Brazil | BritishIndianOceanTerritory | BruneiDarussalam | Bulgaria | BurkinaFaso | Burundi | Cambodia | Cameroon | Canada | CaboVerde | CaymanIslands | CentralAfricanRepublic | Chad | Chile | China | ChristmasIsland | CocosKeelingIslands | Colombia | Comoros | Congo | CongoDemocraticRepublic | CookIslands | CostaRica | CoteDIvoire | Croatia | Cuba | Curacao | Cyprus | Czechia | Denmark | Djibouti | Dominica | DominicanRepublic | Ecuador | Egypt | ElSalvador | EquatorialGuinea | Eritrea | Estonia | Eswatini | Ethiopia | FalklandIslands | FaroeIslands | Fiji | Finland | France | FrenchGuiana | FrenchPolynesia | FrenchSouthernTerritories | Gabon | Gambia | Georgia | Germany | Ghana | Gibraltar | Greece | Greenland | Grenada | Guadeloupe | Guam | Guatemala | Guernsey | Guinea | GuineaBissau | Guyana | Haiti | HeardAndMcDonaldIslands | HolySee | Honduras | HongKong | Hungary | Iceland | India | Indonesia | Iran | Iraq | Ireland | IsleOfMan | Israel | Italy | Jamaica | Japan | Jersey | Jordan | Kazakhstan | Kenya | Kiribati | KoreaDemocraticPeoplesRepublic | KoreaRepublic | Kuwait | Kyrgyzstan | Laos | Latvia | Lebanon | Lesotho | Liberia | Libya | Liechtenstein | Lithuania | Luxembourg | Macao | Madagascar | Malawi | Malaysia | Maldives | Mali | Malta | MarshallIslands | Martinique | Mauritania | Mauritius | Mayotte | Mexico | Micronesia | Moldova | Monaco | Mongolia | Montenegro | Montserrat | Morocco | Mozambique | Myanmar | Namibia | Nauru | Nepal | Netherlands | NewCaledonia | NewZealand | Nicaragua | Niger | Nigeria | Niue | NorfolkIsland | NorthMacedonia | NorthernMarianaIslands | Norway | Oman | Pakistan | Palau | PalestinianTerritory | Panama | PapuaNewGuinea | Paraguay | Peru | Philippines | Pitcairn | Poland | Portugal | PuertoRico | Qatar | Reunion | Romania | Russia | Rwanda | SaintBarthelemy | SaintHelenaAscensionAndTristanDaCunha | SaintKittsAndNevis | SaintLucia | SaintMartin | SaintPierreAndMiquelon | SaintVincentAndTheGrenadines | Samoa | SanMarino | SaoTomeAndPrincipe | SaudiArabia | Senegal | Serbia | Seychelles | SierraLeone | Singapore | SintMaarten | Slovakia | Slovenia | SolomonIslands | Somalia | SouthAfrica | SouthGeorgiaAndSouthSandwichIslands | SouthSudan | Spain | SriLanka | Sudan | Suriname | SvalbardAndJanMayen | Sweden | Switzerland | Syria | Taiwan | Tajikistan | Tanzania | Thailand | TimorLeste | Togo | Tokelau | Tonga | TrinidadAndTobago | Tunisia | Turkiye | Turkmenistan | TurksAndCaicosIslands | Tuvalu | Uganda | Ukraine | UnitedArabEmirates | UnitedKingdom | UnitedStatesMinorOutlyingIslands | UnitedStates | Uruguay | Uzbekistan | Vanuatu | Venezuela | Vietnam | VirginIslandsBritish | VirginIslandsUS | WallisAndFutuna | WesternSahara | Yemen | Zambia | Zimbabwe | string | null
>   } | null,
>   debtor?: {
>     name?: string | null,
>     houseNo?: string | null,
>     addressLine1?: string | null,
>     addressLine2?: string | null,
>     street?: string | null,
>     town?: string | null,
>     postcode?: string | null,
>     countryCode?: Afghanistan | AlandIslands | Albania | Algeria | AmericanSamoa | Andorra | Angola | Anguilla | Antarctica | AntiguaAndBarbuda | Argentina | Armenia | Aruba | Australia | Austria | Azerbaijan | Bahamas | Bahrain | Bangladesh | Barbados | Belarus | Belgium | Belize | Benin | Bermuda | Bhutan | Bolivia | BonaireSintEustatiusAndSaba | BosniaAndHerzegovina | Botswana | BouvetIsland | Brazil | BritishIndianOceanTerritory | BruneiDarussalam | Bulgaria | BurkinaFaso | Burundi | Cambodia | Cameroon | Canada | CaboVerde | CaymanIslands | CentralAfricanRepublic | Chad | Chile | China | ChristmasIsland | CocosKeelingIslands | Colombia | Comoros | Congo | CongoDemocraticRepublic | CookIslands | CostaRica | CoteDIvoire | Croatia | Cuba | Curacao | Cyprus | Czechia | Denmark | Djibouti | Dominica | DominicanRepublic | Ecuador | Egypt | ElSalvador | EquatorialGuinea | Eritrea | Estonia | Eswatini | Ethiopia | FalklandIslands | FaroeIslands | Fiji | Finland | France | FrenchGuiana | FrenchPolynesia | FrenchSouthernTerritories | Gabon | Gambia | Georgia | Germany | Ghana | Gibraltar | Greece | Greenland | Grenada | Guadeloupe | Guam | Guatemala | Guernsey | Guinea | GuineaBissau | Guyana | Haiti | HeardAndMcDonaldIslands | HolySee | Honduras | HongKong | Hungary | Iceland | India | Indonesia | Iran | Iraq | Ireland | IsleOfMan | Israel | Italy | Jamaica | Japan | Jersey | Jordan | Kazakhstan | Kenya | Kiribati | KoreaDemocraticPeoplesRepublic | KoreaRepublic | Kuwait | Kyrgyzstan | Laos | Latvia | Lebanon | Lesotho | Liberia | Libya | Liechtenstein | Lithuania | Luxembourg | Macao | Madagascar | Malawi | Malaysia | Maldives | Mali | Malta | MarshallIslands | Martinique | Mauritania | Mauritius | Mayotte | Mexico | Micronesia | Moldova | Monaco | Mongolia | Montenegro | Montserrat | Morocco | Mozambique | Myanmar | Namibia | Nauru | Nepal | Netherlands | NewCaledonia | NewZealand | Nicaragua | Niger | Nigeria | Niue | NorfolkIsland | NorthMacedonia | NorthernMarianaIslands | Norway | Oman | Pakistan | Palau | PalestinianTerritory | Panama | PapuaNewGuinea | Paraguay | Peru | Philippines | Pitcairn | Poland | Portugal | PuertoRico | Qatar | Reunion | Romania | Russia | Rwanda | SaintBarthelemy | SaintHelenaAscensionAndTristanDaCunha | SaintKittsAndNevis | SaintLucia | SaintMartin | SaintPierreAndMiquelon | SaintVincentAndTheGrenadines | Samoa | SanMarino | SaoTomeAndPrincipe | SaudiArabia | Senegal | Serbia | Seychelles | SierraLeone | Singapore | SintMaarten | Slovakia | Slovenia | SolomonIslands | Somalia | SouthAfrica | SouthGeorgiaAndSouthSandwichIslands | SouthSudan | Spain | SriLanka | Sudan | Suriname | SvalbardAndJanMayen | Sweden | Switzerland | Syria | Taiwan | Tajikistan | Tanzania | Thailand | TimorLeste | Togo | Tokelau | Tonga | TrinidadAndTobago | Tunisia | Turkiye | Turkmenistan | TurksAndCaicosIslands | Tuvalu | Uganda | Ukraine | UnitedArabEmirates | UnitedKingdom | UnitedStatesMinorOutlyingIslands | UnitedStates | Uruguay | Uzbekistan | Vanuatu | Venezuela | Vietnam | VirginIslandsBritish | VirginIslandsUS | WallisAndFutuna | WesternSahara | Yemen | Zambia | Zimbabwe | string | null
>   } | null,
>   pageNumber?: number | null
> }[] | null
> ```

***

## Conversion

### basicConversion

`conversion.basicConversion`

Convert - File to PDF

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.basicConversion({"body":{"fileContent":"AA==","FileName":"x","outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent: string,
>   outputFilename: string,
>   removeDocumentMarkup?: boolean,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   GenerateBookmarks?: boolean,
>   CultureName?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertCad

`conversion.convertCad`

Convert - CAD

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertCad({"body":{"fileContent":"AA==","fileName":"x","outputFilename":"x","outputFormat":"PDF"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   fileName: string,
>   fileContent: string,
>   outputFormat: PDF | BMP | GIF | JPG | PNG | TIFF,
>   pageWidth?: number,
>   pageHeight?: number,
>   backgroundColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   drawType?: UseDrawColor | UseObjectColor,
>   drawColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   automaticLayoutsScaling?: boolean,
>   convertModelOnly?: boolean
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   outputFormatParameter?: PDF | BMP | GIF | JPG | PNG | TIFF
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertExcel

`conversion.convertExcel`

Convert - Excel

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertExcel({"body":{"fileContent":"AA==","fileName":"x","outputFilename":"x","outputFormat":"PDF"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   fileName: string,
>   fileContent: string,
>   outputFormat: PDF | HTML | CSV | TXT | XLSX | XLS | XLTX | PNG | TIFF | XLSB | XLSM,
>   worksheet?: string,
>   onePagePerSheet?: boolean,
>   allColumnsInOnePagePerSheet?: boolean,
>   removeDocumentMarkup?: boolean,
>   exportHiddenSheets?: boolean,
>   csvDelimiter?: string,
>   autoFit?: boolean,
>   cultureName?: string,
>   generateBookmarks?: boolean,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   tiffCompression?: None | Ccitt3 | Ccitt4 | Lzw | Rle
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   outputFormatParameter?: PDF | HTML | CSV | TXT | XLSX | XLS | XLTX | PNG | TIFF | XLSB | XLSM
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertHeicToPdf

`conversion.convertHeicToPdf`

Convert - HEIC to PDF

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertHeicToPdf({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertImageToPdf

`conversion.convertImageToPdf`

Convert - Image to PDF

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertImageToPdf({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ocrType?: None | AI | Standard,
>   fileContent: string,
>   ocrLanguage?: Albanian | Arabic | Azerbaijani | Basque | Belarusian | Bengali | Bosnian | Bulgarian | Burmese | Catalan | ChineseSimplified | ChineseTraditional | Croatian | Czech | Danish | Dutch | English | Estonian | Finnish | French | Georgian | German | Greek | Gujarati | Hebrew | Hindi | Hungarian | Icelandic | Indonesian | Italian | Japanese | Kannada | Kazakh | Khmer | Korean | Kurdish | Kyrgyz | Laotian | Latin | Latvian | Lithuanian | Macedonian | Maharashtra | Malay | Malayalam | Maltese | Nepali | Norwegian | Oriya | Panjabi | Persian | Polish | Portuguese | Pushto | Romanian | Russian | Sanskrit | Serbian | Singhalese | Slovakian | Slovenian | Spanish | Swahili | Swedish | Syriac | Tamil | Telugu | Thai | Turkish | Ukrainian | Urdu | Uzbek | Vietnamese | Welsh | Yiddish
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ocrTypeParameter?: None | AI | Standard
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertJsonToExcel

`conversion.convertJsonToExcel`

Convert - JSON to Excel

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertJsonToExcel({"body":{"outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   fileContent?: string,
>   jsonData?: string,
>   row?: number,
>   column?: number,
>   worksheetName?: string,
>   convertNumericAndDate?: boolean,
>   dateFormat?: string,
>   numericFormat?: string,
>   ignoreNulls?: boolean,
>   titleFontColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   isTitleBold?: boolean,
>   isTitleTextWrapped?: boolean,
>   ignoreAttributeTitles?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertMailMessage

`conversion.convertMailMessage`

Convert - Email

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertMailMessage({"body":{"fileContent":"AA==","fileName":"x","outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   fileName: string,
>   fileContent: string,
>   mergeAttachments?: boolean,
>   emailPosition?: First | Last,
>   timezone?: Default | AUSCentralStandardTime | AUSEasternStandardTime | AfghanistanStandardTime | AlaskanStandardTime | AleutianStandardTime | AltaiStandardTime | ArabStandardTime | ArabianStandardTime | ArabicStandardTime | ArgentinaStandardTime | AstrakhanStandardTime | AtlanticStandardTime | AusCentralWStandardTime | AzerbaijanStandardTime | AzoresStandardTime | BahiaStandardTime | BangladeshStandardTime | BelarusStandardTime | BougainvilleStandardTime | CanadaCentralStandardTime | CapeVerdeStandardTime | CaucasusStandardTime | CenAustraliaStandardTime | CentralAmericaStandardTime | CentralAsiaStandardTime | CentralBrazilianStandardTime | CentralEuropeStandardTime | CentralEuropeanStandardTime | CentralPacificStandardTime | CentralStandardTime | CentralStandardTimeMexico | ChathamIslandsStandardTime | ChinaStandardTime | CubaStandardTime | DatelineStandardTime | EAfricaStandardTime | EAustraliaStandardTime | EEuropeStandardTime | ESouthAmericaStandardTime | EasterIslandStandardTime | EasternStandardTime | EasternStandardTimeMexico | EgyptStandardTime | EkaterinburgStandardTime | FLEStandardTime | FijiStandardTime | GMTStandardTime | GTBStandardTime | GeorgianStandardTime | GreenlandStandardTime | GreenwichStandardTime | HaitiStandardTime | HawaiianStandardTime | IndiaStandardTime | IranStandardTime | IsraelStandardTime | JordanStandardTime | KaliningradStandardTime | KamchatkaStandardTime | KoreaStandardTime | LibyaStandardTime | LineIslandsStandardTime | LordHoweStandardTime | MagadanStandardTime | MagallanesStandardTime | MarquesasStandardTime | MauritiusStandardTime | MidAtlanticStandardTime | MiddleEastStandardTime | MontevideoStandardTime | MoroccoStandardTime | MountainStandardTime | MountainStandardTimeMexico | MyanmarStandardTime | NCentralAsiaStandardTime | NamibiaStandardTime | NepalStandardTime | NewZealandStandardTime | NewfoundlandStandardTime | NorfolkStandardTime | NorthAsiaEastStandardTime | NorthAsiaStandardTime | NorthKoreaStandardTime | OmskStandardTime | PacificSAStandardTime | PacificStandardTime | PacificStandardTimeMexico | PakistanStandardTime | ParaguayStandardTime | QyzylordaStandardTime | RomanceStandardTime | RussiaTimeZone10 | RussiaTimeZone11 | RussiaTimeZone3 | RussianStandardTime | SAEasternStandardTime | SAPacificStandardTime | SAWesternStandardTime | SEAsiaStandardTime | SaintPierreStandardTime | SakhalinStandardTime | SamoaStandardTime | SaoTomeStandardTime | SaratovStandardTime | SingaporeStandardTime | SouthAfricaStandardTime | SouthSudanStandardTime | SriLankaStandardTime | SudanStandardTime | SyriaStandardTime | TaipeiStandardTime | TasmaniaStandardTime | TocantinsStandardTime | TokyoStandardTime | TomskStandardTime | TongaStandardTime | TransbaikalStandardTime | TurkeyStandardTime | TurksAndCaicosStandardTime | USEasternStandardTime | USMountainStandardTime | UTC | UTC02 | UTC08 | UTC09 | UTC11 | UTC12 | UTC13 | UlaanbaatarStandardTime | VenezuelaStandardTime | VladivostokStandardTime | VolgogradStandardTime | WAustraliaStandardTime | WCentralAfricaStandardTime | WEuropeStandardTime | WMongoliaStandardTime | WestAsiaStandardTime | WestBankStandardTime | WestPacificStandardTime | YakutskStandardTime | YukonStandardTime,
>   generateBookmarks?: boolean,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertPdfToExcel

`conversion.convertPdfToExcel`

Convert - PDF to Excel

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertPdfToExcel({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertPdfToImages

`conversion.convertPdfToImages`

Convert - PDF to Images

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertPdfToImages({"body":{"fileContent":"AA==","imageFormat":"JPG"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   imageFormat: JPG | PNG,
>   filenamePrefix?: string,
>   resolution?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

### convertPdfToJpg

`conversion.convertPdfToJpg`

Convert - PDF to JPG

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertPdfToJpg({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   outputFilename?: string,
>   imageQuality?: number,
>   resolution?: number,
>   resolutionUnit?: None | Inch | CM,
>   compressionColourMode?: Grayscale | YCbCr | CMYK | YCCK | RGB,
>   compressionType?: Baseline | Progressive,
>   enhancedCompression?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertPdfToPng

`conversion.convertPdfToPng`

Convert - PDF to PNG

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertPdfToPng({"body":{"bitDepth":0,"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   outputFilename?: string,
>   progressive?: boolean,
>   compression?: None | Low | Medium | High,
>   resolution?: number,
>   bitDepthSelector?: Auto | One | Two | Four | Eight | Sixteen,
>   bitDepth: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertPdfToTiff

`conversion.convertPdfToTiff`

Convert - PDF to TIFF

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertPdfToTiff({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   outputFilename?: string,
>   resolution?: number,
>   tiffCompression?: None | CCITT3 | CCITT4 | LZW | RLE,
>   pageOrientation?: Inherit | Portrait | Landscape,
>   skipBlankPages?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertPdfToWord

`conversion.convertPdfToWord`

Convert - PDF to Word

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertPdfToWord({"body":{"fileName":"x","finalOperation":false,"outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   outputFilename: string,
>   fileContent?: string,
>   mode?: Full | PreserveLayout,
>   recognizeBullets?: boolean,
>   finalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertPowerPoint

`conversion.convertPowerPoint`

Convert - PowerPoint

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertPowerPoint({"body":{"fileContent":"AA==","fileName":"x","outputFilename":"x","outputFormat":"PDF"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   outputFormat: PDF | HTML | POTX | PPTX | TXT | PNG | TIFF,
>   fileName: string,
>   fileContent: string,
>   slideOrientation?: Inherit | Portrait | Landscape,
>   slideSize?: Inherit | Widescreen | A3Paper | A4Paper | B4IsoPaper | B4JisPaper | B5IsoPaper | B5JisPaper | Banner | HagakiCard | Ledger | LetterPaper | OnScreen | OnScreen16x10 | OnScreen16x9 | Overhead | Slide35mm,
>   slideScale?: DoNotScale | EnsureFit | Maximise,
>   showHiddenSlides?: boolean,
>   removeDocumentMarkup?: boolean,
>   cultureName?: string,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   pdfImageResolution?: number,
>   pdfExportMetafilesAsVectorGraphics?: boolean,
>   slideIndex?: number,
>   resolution?: number,
>   tiffCompression?: None | Ccitt3 | Ccitt4 | Lzw | Rle
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   outputFormatParameter?: PDF | HTML | POTX | PPTX | TXT | PNG | TIFF
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertToPdfA

`conversion.convertToPdfA`

Convert - PDF to PDFA

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertToPdfA({"body":{"FileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertVisio

`conversion.convertVisio`

Convert - Visio

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertVisio({"body":{"fileContent":"AA==","fileName":"x","outputFormat":"PDF"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFormat: PDF | BMP | GIF | HTML | JPG | PNG | SVG | TIFF | VSDX,
>   fileName: string,
>   fileContent: string,
>   defaultFont?: string,
>   includeHiddenPages?: boolean,
>   jpegQuality?: number,
>   pageCount?: number,
>   pageIndex?: number,
>   pageSize?: Inherit | A1 | A2 | A3 | A4 | A5 | B4 | B5 | EnvelopeDL | Executive | Legal | Letter | Tabloid,
>   saveForegroundPagesOnly?: boolean,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   saveToolBar?: boolean,
>   tiffCompression?: None | Rle | Ccitt3 | Ccitt4 | Lzw,
>   smoothingMode?: Default | Invalid | HighSpeed | HighQuality | None | AntiAlias,
>   scale?: number,
>   resolution?: number,
>   interpolationMode?: Default | Invalid | Low | High | Bilinear | Bicubic | NearestNeighbor | HighQualityBilinear | HighQualityBicubic,
>   pixelOffsetMode?: Default | Invalid | HighSpeed | HighQuality | None | Half,
>   imageContrast?: number,
>   imageColorMode?: None | Grayscale | BlackAndWhite,
>   imageBrightness?: number,
>   compositingQuality?: Default | Invalid | HighSpeed | HighQuality | GammaCorrected | AssumeLinear,
>   autoFitPageToDrawingContent?: boolean
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   outputFormatParameter?: PDF | BMP | GIF | HTML | JPG | PNG | SVG | TIFF | VSDX
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### convertWord

`conversion.convertWord`

Convert - Word

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.convertWord({"body":{"fileContent":"AA==","fileName":"x","outputFilename":"x","outputFormat":"PDF"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   outputFormat: PDF | DOCX | DOC | DOTX | RTF | HTML | TXT | PNG | TIFF | DOCM,
>   fileName: string,
>   fileContent: string,
>   pageOrientation?: Inherit | Portrait | Landscape,
>   pageSize?: Inherit | A3 | A4 | A5 | B4 | B5 | EnvelopeDL | Executive | Folio | Ledger | Legal | Letter | Quarto | Statement | Tabloid,
>   removeDocumentMarkup?: boolean,
>   showRevisionsInBalloons?: None | FormattingOnly | All,
>   trackedChangesTextColorInserted?: Auto | Black | Blue | BrightGreen | ClassicBlue | ClassicRed | DarkBlue | DarkRed | DarkYellow | Gray25 | Gray50 | Green | Pink | Red | Teal | Turquoise | Violet | White | Yellow | NoHighlight | ByAuthor,
>   trackedChangesTextColorDeleted?: Auto | Black | Blue | BrightGreen | ClassicBlue | ClassicRed | DarkBlue | DarkRed | DarkYellow | Gray25 | Gray50 | Green | Pink | Red | Teal | Turquoise | Violet | White | Yellow | NoHighlight | ByAuthor,
>   trackedChangesTextColorMovedTo?: Auto | Black | Blue | BrightGreen | ClassicBlue | ClassicRed | DarkBlue | DarkRed | DarkYellow | Gray25 | Gray50 | Green | Pink | Red | Teal | Turquoise | Violet | White | Yellow | NoHighlight | ByAuthor,
>   trackedChangesTextColorMovedFrom?: Auto | Black | Blue | BrightGreen | ClassicBlue | ClassicRed | DarkBlue | DarkRed | DarkYellow | Gray25 | Gray50 | Green | Pink | Red | Teal | Turquoise | Violet | White | Yellow | NoHighlight | ByAuthor,
>   trackedChangesColorComments?: Auto | Black | Blue | BrightGreen | ClassicBlue | ClassicRed | DarkBlue | DarkRed | DarkYellow | Gray25 | Gray50 | Green | Pink | Red | Teal | Turquoise | Violet | White | Yellow | NoHighlight | ByAuthor,
>   timezone?: Default | AUSCentralStandardTime | AUSEasternStandardTime | AfghanistanStandardTime | AlaskanStandardTime | AleutianStandardTime | AltaiStandardTime | ArabStandardTime | ArabianStandardTime | ArabicStandardTime | ArgentinaStandardTime | AstrakhanStandardTime | AtlanticStandardTime | AusCentralWStandardTime | AzerbaijanStandardTime | AzoresStandardTime | BahiaStandardTime | BangladeshStandardTime | BelarusStandardTime | BougainvilleStandardTime | CanadaCentralStandardTime | CapeVerdeStandardTime | CaucasusStandardTime | CenAustraliaStandardTime | CentralAmericaStandardTime | CentralAsiaStandardTime | CentralBrazilianStandardTime | CentralEuropeStandardTime | CentralEuropeanStandardTime | CentralPacificStandardTime | CentralStandardTime | CentralStandardTimeMexico | ChathamIslandsStandardTime | ChinaStandardTime | CubaStandardTime | DatelineStandardTime | EAfricaStandardTime | EAustraliaStandardTime | EEuropeStandardTime | ESouthAmericaStandardTime | EasterIslandStandardTime | EasternStandardTime | EasternStandardTimeMexico | EgyptStandardTime | EkaterinburgStandardTime | FLEStandardTime | FijiStandardTime | GMTStandardTime | GTBStandardTime | GeorgianStandardTime | GreenlandStandardTime | GreenwichStandardTime | HaitiStandardTime | HawaiianStandardTime | IndiaStandardTime | IranStandardTime | IsraelStandardTime | JordanStandardTime | KaliningradStandardTime | KamchatkaStandardTime | KoreaStandardTime | LibyaStandardTime | LineIslandsStandardTime | LordHoweStandardTime | MagadanStandardTime | MagallanesStandardTime | MarquesasStandardTime | MauritiusStandardTime | MidAtlanticStandardTime | MiddleEastStandardTime | MontevideoStandardTime | MoroccoStandardTime | MountainStandardTime | MountainStandardTimeMexico | MyanmarStandardTime | NCentralAsiaStandardTime | NamibiaStandardTime | NepalStandardTime | NewZealandStandardTime | NewfoundlandStandardTime | NorfolkStandardTime | NorthAsiaEastStandardTime | NorthAsiaStandardTime | NorthKoreaStandardTime | OmskStandardTime | PacificSAStandardTime | PacificStandardTime | PacificStandardTimeMexico | PakistanStandardTime | ParaguayStandardTime | QyzylordaStandardTime | RomanceStandardTime | RussiaTimeZone10 | RussiaTimeZone11 | RussiaTimeZone3 | RussianStandardTime | SAEasternStandardTime | SAPacificStandardTime | SAWesternStandardTime | SEAsiaStandardTime | SaintPierreStandardTime | SakhalinStandardTime | SamoaStandardTime | SaoTomeStandardTime | SaratovStandardTime | SingaporeStandardTime | SouthAfricaStandardTime | SouthSudanStandardTime | SriLankaStandardTime | SudanStandardTime | SyriaStandardTime | TaipeiStandardTime | TasmaniaStandardTime | TocantinsStandardTime | TokyoStandardTime | TomskStandardTime | TongaStandardTime | TransbaikalStandardTime | TurkeyStandardTime | TurksAndCaicosStandardTime | USEasternStandardTime | USMountainStandardTime | UTC | UTC02 | UTC08 | UTC09 | UTC11 | UTC12 | UTC13 | UlaanbaatarStandardTime | VenezuelaStandardTime | VladivostokStandardTime | VolgogradStandardTime | WAustraliaStandardTime | WCentralAfricaStandardTime | WEuropeStandardTime | WMongoliaStandardTime | WestAsiaStandardTime | WestBankStandardTime | WestPacificStandardTime | YakutskStandardTime | YukonStandardTime,
>   cultureName?: string,
>   wordComplianceLevel?: Ecma | Transitional | Strict,
>   generateBookmarks?: boolean,
>   customProperties?: None | Standard | Metadata,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   enableOpenType?: boolean,
>   convertToPdfForm?: boolean,
>   pageIndex?: number,
>   tiffCompression?: None | Ccitt3 | Ccitt4 | Lzw | Rle,
>   htmlVersion?: XHTML | HTML5,
>   exportListLabels?: Auto | AsInlineText | ByHTMLTags
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   outputFormatParameter?: PDF | DOCX | DOC | DOTX | RTF | HTML | TXT | PNG | TIFF | DOCM
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### htmlToImage

`conversion.htmlToImage`

Convert - HTML to Image

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.htmlToImage({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string,
>   htmlData?: string,
>   Url?: string,
>   imgWidth?: number,
>   imgHeight?: number,
>   cssType?: Screen | Print,
>   decodeHtmlData?: boolean,
>   delay?: number,
>   enableJavaScript?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### htmlToPdf

`conversion.htmlToPdf`

Convert - HTML to PDF

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.htmlToPdf({"body":{"encoding":"UTF8","FileName":"x","htmlData":"<html><body>Example</body></html>","outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   outputFilename: string,
>   fileContent?: string,
>   htmlData?: string,
>   htmlUrl?: string,
>   pageOrientation?: Portrait | Landscape,
>   pageSize?: Default | A1 | A2 | A3 | A4 | A5 | A6 | B4 | B5 | EnvelopeDL | Executive | Folio | Ledger | Legal | Letter | Quarto | Statement | Tabloid | Custom,
>   viewPort?: Default | Mobile | Tablet | Laptop | LaptopL | FourK,
>   MarginTop?: number,
>   MarginBottom?: number,
>   MarginRight?: number,
>   MarginLeft?: number,
>   pageWidth?: number,
>   pageHeight?: number,
>   enableBookmarks?: boolean,
>   enableJavaScript?: boolean,
>   enableHyperlinks?: boolean,
>   createPdfForm?: boolean,
>   decodeHtmlData?: boolean,
>   cssType?: Screen | Print,
>   repeatTableHeader?: boolean,
>   repeatTableFooter?: boolean,
>   splitImages?: boolean,
>   splitTextLines?: boolean,
>   encoding: UTF8 | UTF7 | UTF32 | ASCII | Unicode | BigEndianUnicode,
>   delay?: number,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### htmlToPDFV2

`conversion.htmlToPDFV2`

Convert - HTML to PDF (V2)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.htmlToPDFV2({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string,
>   htmlData?: string,
>   Url?: string,
>   pageOrientation?: Portrait | Landscape,
>   pageSize?: Default | A1 | A2 | A3 | A4 | A5 | A6 | B4 | B5 | EnvelopeDL | Executive | Folio | Ledger | Legal | Letter | Quarto | Statement | Tabloid | Custom,
>   createBookmarks?: boolean,
>   createToC?: boolean,
>   cssType?: Screen | Print,
>   decodeHtmlData?: boolean,
>   delay?: number,
>   enableHyperlinks?: boolean,
>   enableJavaScript?: boolean,
>   marginTop?: number,
>   marginBottom?: number,
>   marginRight?: number,
>   marginLeft?: number,
>   pageRotationAngle?: None | Rotate90 | Rotate180 | Rotate270,
>   pageWidth?: number,
>   pageHeight?: number,
>   scale?: number,
>   viewPort?: Default | Mobile | Tablet | Laptop | LaptopL | FourK
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### htmlToWord

`conversion.htmlToWord`

Convert - HTML to Word

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.htmlToWord({"body":{"FileName":"x","FinalOperation":false,"outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   outputFilename: string,
>   fileContent?: string,
>   htmlData?: string,
>   htmlUrl?: string,
>   pageOrientation?: Portrait | Landscape,
>   pageSize?: Default | A1 | A2 | A3 | A4 | A5 | A6 | B4 | B5 | EnvelopeDL | Executive | Folio | Ledger | Legal | Letter | Quarto | Statement | Tabloid | Custom,
>   decodeHtmlData?: boolean,
>   encoding?: UTF8 | UTF7 | UTF32 | ASCII | Unicode | BigEndianUnicode,
>   MarginTop?: number,
>   MarginBottom?: number,
>   MarginRight?: number,
>   MarginLeft?: number,
>   pageWidth?: number,
>   pageHeight?: number,
>   WordComplianceLevel?: Ecma | Transitional | Strict,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### textToPdf

`conversion.textToPdf`

Convert - Text to PDF

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.textToPdf({"body":{"FileName":"x","outputFilename":"x","textData":"Example text"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   outputFilename: string,
>   fileContent?: string,
>   textData?: string,
>   textEncodingType?: Default | Latin1 | BigEndianUnicode | UTF16 | UTF8 | UTF7 | ASCII,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### wordToPdfForm

`conversion.wordToPdfForm`

Convert - Word to PDF Form

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.conversion.wordToPdfForm({"body":{"fileContent":"AA==","FileName":"x","outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent: string,
>   outputFilename: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

## Excel

### addRowsToExcel

`excel.addRowsToExcel`

Excel - Add Rows

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.addRowsToExcel({"body":{"fileContent":"AA==","jsonData":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   jsonData: string,
>   insertionRow?: number,
>   insertionColumn?: number,
>   tableName?: string,
>   worksheetName?: string,
>   convertNumericAndDate?: boolean,
>   dateFormat?: string,
>   numericFormat?: string,
>   ignoreAttributeTitles?: boolean,
>   ignoreNulls?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### deleteExcelWorksheets

`excel.deleteExcelWorksheets`

Excel - Delete Worksheets

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.deleteExcelWorksheets({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   worksheetNames?: string,
>   worksheetIndexes?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### deleteRowsFromExcel

`excel.deleteRowsFromExcel`

Excel - Delete Rows

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.deleteRowsFromExcel({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   firstRow?: number,
>   lastRow?: number,
>   worksheetName?: string,
>   rowArray?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### excelAddImageHeaderOrFooter

`excel.excelAddImageHeaderOrFooter`

Excel - Add Image Header or Footer

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelAddImageHeaderOrFooter({"body":{"fileContent":"AA==","imageFileContent":"AA==","position":"HeaderLeft"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   imageFileContent: string,
>   position: HeaderLeft | HeaderCentral | HeaderRight | FooterLeft | FooterCentral | FooterRight,
>   worksheetNames?: string,
>   worksheetIndexes?: string,
>   marginTop?: number,
>   marginBottom?: number,
>   marginRight?: number,
>   marginLeft?: number,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### excelAddTextHeadersAndFooters

`excel.excelAddTextHeadersAndFooters`

Excel - Add Text Header or Footer

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelAddTextHeadersAndFooters({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   headerLeft?: string,
>   headerCentral?: string,
>   headerRight?: string,
>   footerLeft?: string,
>   footerCentral?: string,
>   footerRight?: string,
>   worksheetNames?: string,
>   worksheetIndexes?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### excelMergeWorksheets

`excel.excelMergeWorksheets`

Excel - Merge Worksheets

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelMergeWorksheets({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   primaryWorksheet?: string,
>   worksheetsToMerge?: string,
>   includeFirstRow?: boolean,
>   deleteMergedWorksheets?: boolean,
>   convertExpressionsToValues?: None | CrossSheet | All,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### excelRemoveHeadersAndFooters

`excel.excelRemoveHeadersAndFooters`

Excel - Remove Headers and Footers

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelRemoveHeadersAndFooters({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   headerLeft?: boolean,
>   headerCentral?: boolean,
>   headerRight?: boolean,
>   footerLeft?: boolean,
>   footerCentral?: boolean,
>   footerRight?: boolean,
>   worksheetNames?: string,
>   worksheetIndexes?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### excelRenameWorksheets

`excel.excelRenameWorksheets`

Excel - Rename Worksheets

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelRenameWorksheets({"body":{"fileContent":"AA==","worksheets":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   worksheets: {
>     currentName?: string,
>     index?: number,
>     newName?: string
>   }[],
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### excelReplaceText

`excel.excelReplaceText`

Excel - Replace Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelReplaceText({"body":{"fileContent":"AA==","phrases":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   phrases: {
>     searchText: string,
>     isExpression?: boolean,
>     replacementText?: string,
>     matchEntireCellContents?: boolean,
>     caseSensitive?: boolean,
>     font?: string,
>     fontColour?: Inherit | AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>     fontSize?: number,
>     fontBold?: Inherit | Apply | Remove,
>     fontItalic?: Inherit | Apply | Remove,
>     styleStrikethroughType?: Inherit | Single | Double | None,
>     styleUnderlineType?: Inherit | Single | Double | Accounting | DoubleAccounting | Dash | DashDotDotHeavy | DashDotHeavy | DashedHeavy | DashLong | DashLongHeavy | DotDash | DotDotDash | Dotted | DottedHeavy | Heavy | Wave | WavyDouble | WavyHeavy | Words | None,
>     styleScriptType?: Inherit | Subscript | Superscript | None
>   }[],
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### excelSeparateWorksheets

`excel.excelSeparateWorksheets`

Excel - Separate Worksheets

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelSeparateWorksheets({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `files` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] files full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

### excelWatermarkText

`excel.excelWatermarkText`

Excel - Add Text Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelWatermarkText({"body":{"columnPosition":0,"fileContent":"AA==","height":0,"rowPosition":0,"text":"x","width":0}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   text: string,
>   rowPosition: number,
>   columnPosition: number,
>   height: number,
>   width: number,
>   font?: string,
>   textColour?: string,
>   italic?: boolean,
>   bold?: boolean,
>   opacity?: number,
>   rotationAngle?: number,
>   worksheetNames?: string,
>   worksheetIndexes?: string,
>   watermarkId?: number,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `watermarkId` | `number \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### excelWatermarkTextRemove

`excel.excelWatermarkTextRemove`

Excel - Remove Text Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.excelWatermarkTextRemove({"body":{"fileContent":"AA==","watermarkId":0}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   watermarkId: number,
>   worksheetNames?: string,
>   worksheetIndexes?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### extractExcelWorksheets

`excel.extractExcelWorksheets`

Excel - Extract Worksheets

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.extractExcelWorksheets({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   worksheetNames?: string,
>   worksheetIndexes?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### getRowsFromExcel

`excel.getRowsFromExcel`

Excel - Extract Rows

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.getRowsFromExcel({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   worksheetName?: string,
>   hasHeaderRow?: boolean,
>   firstRow?: number,
>   lastRow?: number,
>   firstColumn?: number,
>   lastColumn?: number,
>   excludeEmptyRows?: boolean,
>   exportEmptyCells?: boolean,
>   exportValuesAsText?: boolean,
>   hyperlinkFormat?: Title | URL | HTML,
>   alwaysExportAsJsonObject?: boolean,
>   excludeHiddenRows?: boolean,
>   excludeHiddenColumns?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `rowData` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### mergeArrayOfExcelDocuments

`excel.mergeArrayOfExcelDocuments`

Excel - Merge Files

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.mergeArrayOfExcelDocuments({"body":{"documents":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename?: string,
>   mergeExcelOutputFormat?: PDF | CSV | TIFF | XLSX | XLS | XLSB | XLSM,
>   documents: {
>     fileName: string,
>     fileContent: string,
>     sortPosition?: number,
>     worksheetsToMerge?: number[],
>     csvDelimiter?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### mergeExcelRows

`excel.mergeExcelRows`

Excel - Merge Rows

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.mergeExcelRows({"body":{"documents":[],"outputFormat":"PDF"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename?: string,
>   outputFormat: PDF | CSV | TIFF | XLSX | XLS | XLSB | XLSM,
>   documents: {
>     fileName: string,
>     fileContent: string,
>     sortPosition?: number,
>     worksheetsToMerge?: number[],
>     includeFirstRow?: boolean
>   }[],
>   preserveFirstRow?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### parseCsv

`excel.parseCsv`

CSV - Parse

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.parseCsv({"body":{"FileContent":"AA==","FileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent: string,
>   delimiter?: string,
>   encoding?: ASCII | ISO88591 | ISO88592 | Latin1 | UTF8,
>   csvColumnHeaders?: string,
>   skipFirstLine?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `csvData` | `string` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### populateExcel

`excel.populateExcel`

Excel - Populate

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.populateExcel({"body":{"fileContent":"AA==","jsonData":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   jsonData: string,
>   jsonParseMode?: Standard | Strict,
>   calculateWorkbook?: boolean,
>   useExcelDataTypes?: boolean,
>   allowMissingMembers?: boolean,
>   inlineErrorMessages?: boolean,
>   removeEmptyParagraphs?: boolean,
>   dateTimeFormat?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### secureExcel

`excel.secureExcel`

Excel - Secure

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.secureExcel({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   secureOnOpenPassword?: string,
>   workbookProtectionType?: All | Structure | Windows | None,
>   workbookProtectionPassword?: string,
>   worksheetProtectionType?: All | Contents | Objects | Scenarios | None,
>   worksheetProtectionPassword?: string,
>   worksheetNames?: string,
>   worksheetIndexes?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### unlockExcel

`excel.unlockExcel`

Excel - Unlock

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.unlockExcel({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   secureOnOpenPassword?: string,
>   workbookProtectionPassword?: string,
>   worksheetProtectionPassword?: string,
>   worksheetNames?: string,
>   worksheetIndexes?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### updateRowsInExcel

`excel.updateRowsInExcel`

Excel - Update Rows

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.excel.updateRowsInExcel({"body":{"fileContent":"AA==","jsonData":"x","updateColumn":0,"updateRow":0}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   jsonData: string,
>   updateRow: number,
>   updateColumn: number,
>   worksheetName?: string,
>   convertNumericAndDate?: boolean,
>   dateFormat?: string,
>   numericFormat?: string,
>   ignoreAttributeTitles?: boolean,
>   ignoreNulls?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

## General

### addToZip

`general.addToZip`

Archive (ZIP) - Create

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.addToZip({"body":{"documents":[],"FinalOperation":false,"outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   documents: {
>     fileName?: string,
>     fileContent?: string,
>     folderPath?: string
>   }[],
>   Password?: string,
>   encryption?: ZipCrypto | AES128 | AES256,
>   encoding?: UTF8 | UTF7 | UTF32 | ASCII | Unicode | BigEndianUnicode,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### aiProcessBankCheckUs

`general.aiProcessBankCheckUs`

AI - Process Bank Check (US)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessBankCheckUs({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessBankStatementUs

`general.aiProcessBankStatementUs`

AI - Process Bank Statement (US)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessBankStatementUs({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessContract

`general.aiProcessContract`

AI - Process Contract

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessContract({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessCreditCard

`general.aiProcessCreditCard`

AI - Process Credit Card

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessCreditCard({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessHealthInsuranceCardUs

`general.aiProcessHealthInsuranceCardUs`

AI - Process Health Insurance Card (US)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessHealthInsuranceCardUs({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessIDDocument

`general.aiProcessIDDocument`

AI - Process ID Document

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessIDDocument({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessInvoice

`general.aiProcessInvoice`

AI - Process Invoice

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessInvoice({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessMarriageCertificateUs

`general.aiProcessMarriageCertificateUs`

AI - Process Marriage Certificate (US)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessMarriageCertificateUs({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessMortgageUs

`general.aiProcessMortgageUs`

AI - Process Mortgage Document (US)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessMortgageUs({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string,
>   processFileMortgageModel?: Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessPayStubUs

`general.aiProcessPayStubUs`

AI - Process Pay Stub (US)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessPayStubUs({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessReceipt

`general.aiProcessReceipt`

AI - Process Receipt

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessReceipt({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prebuiltModel?: Contract | HealthInsuranceCardUS | IDDocument | Invoice | Receipt | BankCheckUs | BankStatementUS | CreditCard | MarriageCertificateUS | Mortgage1003 | Mortgage1004 | Mortgage1005 | Mortgage1008 | MortgageClosingDisclosure | PayStubUS | TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   fileContent?: string,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiProcessTaxUs

`general.aiProcessTaxUs`

AI - Process Tax Document (US)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiProcessTaxUs({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string,
>   processFileTaxModel?: TaxUS | TaxW2 | TaxW4 | Tax1095A | Tax1095C | Tax1098 | Tax1098E | Tax1098T | Tax1099A | Tax1099B | Tax1099C | Tax1099CAP | Tax1099Combo | Tax1099DIV | Tax1099G | Tax1099H | Tax1099INT | Tax1099K | Tax1099LS | Tax1099LTC | Tax1099MISC | Tax1099NEC | Tax1099OID | Tax1099PATR | Tax1099Q | Tax1099QA | Tax1099R | Tax1099S | Tax1099SA | Tax1099SB | Tax1099SSA | Tax1040 | Tax1040Schedule1 | Tax1040Schedule2 | Tax1040Schedule3 | Tax1040Schedule8812 | Tax1040ScheduleA | Tax1040ScheduleB | Tax1040ScheduleC | Tax1040ScheduleD | Tax1040ScheduleE | Tax1040ScheduleEIC | Tax1040ScheduleF | Tax1040ScheduleH | Tax1040ScheduleJ | Tax1040ScheduleR | Tax1040ScheduleSE | Tax1040Senior,
>   dateFormat?: string,
>   removeNewLines?: boolean,
>   queryFields?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiRunPromptText

`general.aiRunPromptText`

AI – Run Prompt (Text)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiRunPromptText({"body":{"model":"GPT_4_1","prompt":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   model: GPT_4_1 | GPT_4_1_mini | o4_mini | GPT_5_4,
>   prompt: string,
>   conversation?: string,
>   context?: string,
>   frequencyPenalty?: number,
>   maxOutputTokens?: number,
>   presencePenalty?: number,
>   temperature?: number,
>   reasoningEffort?: Low | Medium | High
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string \| null` | No | — |
| `conversation` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiSpeechToText

`general.aiSpeechToText`

AI - Speech to Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiSpeechToText({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   locale?: string,
>   punctuationMode?: None | Dictated | Automatic | DictatedAndAutomatic,
>   profanityFilterMode?: None | Masked | Removed,
>   speakerIdentification?: JSON | Simplified | None,
>   numberOfSpeakers?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiTranslateFile

`general.aiTranslateFile`

AI - Translate File

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiTranslateFile({"body":{"fileContent":"AA==","fileName":"x","targetLanguage":"Afrikaans"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   sourceLanguage?: AUTO | Afrikaans | Albanian | Amharic | Arabic | Armenian | Assamese | AzerbaijaniLatin | Bangla | Bashkir | Basque | Bhojpuri | Bodo | BosnianLatin | Bulgarian | CantoneseTraditional | Catalan | ChineseLiterary | ChineseSimplified | ChineseTraditional | ChiShona | Croatian | Czech | Danish | Dari | Divehi | Dogri | Dutch | English | Estonian | Faroese | Fijian | Filipino | Finnish | French | FrenchCanadian | Galician | Georgian | German | Greek | Gujarati | HaitianCreole | Hausa | Hebrew | Hindi | HmongDawLatin | Hungarian | Icelandic | Igbo | Indonesian | Inuinnaqtun | Inuktitut | InuktitutLatin | Irish | Italian | Japanese | Kannada | Kashmiri | Kazakh | Khmer | Kinyarwanda | Klingon | KlingonPlqaD | Konkani | Korean | KurdishCentral | KurdishNorthern | KyrgyzCyrillic | Lao | Latvian | Lithuanian | Lingala | LowerSorbian | Luganda | Macedonian | Maithili | Malagasy | MalayLatin | Malayalam | Maltese | Maori | Marathi | MongolianCyrillic | MongolianTraditional | Myanmar | Nepali | Norwegian | Nyanja | Odia | Pashto | Persian | Polish | PortugueseBrazil | PortuguesePortugal | Punjabi | QueretaroOtomi | Romanian | Rundi | Russian | SamoanLatin | SerbianCyrillic | SerbianLatin | Sesotho | SesothoSaLeboa | Setswana | Sindhi | Sinhala | Slovak | Slovenian | SomaliArabic | Spanish | SwahiliLatin | Swedish | Tahitian | Tamil | TatarLatin | Telugu | Thai | Tibetan | Tigrinya | Tongan | Turkish | TurkmenLatin | Ukrainian | UpperSorbian | Urdu | UyghurArabic | UzbekLatin | Vietnamese | Welsh | Xhosa | Yoruba | YucatecMaya | Zulu,
>   targetLanguage: Afrikaans | Albanian | Amharic | Arabic | Armenian | Assamese | AzerbaijaniLatin | Bangla | Bashkir | Basque | Bhojpuri | Bodo | BosnianLatin | Bulgarian | CantoneseTraditional | Catalan | ChineseLiterary | ChineseSimplified | ChineseTraditional | ChiShona | Croatian | Czech | Danish | Dari | Divehi | Dogri | Dutch | English | Estonian | Faroese | Fijian | Filipino | Finnish | French | FrenchCanadian | Galician | Georgian | German | Greek | Gujarati | HaitianCreole | Hausa | Hebrew | Hindi | HmongDawLatin | Hungarian | Icelandic | Igbo | Indonesian | Inuinnaqtun | Inuktitut | InuktitutLatin | Irish | Italian | Japanese | Kannada | Kashmiri | Kazakh | Khmer | Kinyarwanda | Klingon | KlingonPlqaD | Konkani | Korean | KurdishCentral | KurdishNorthern | KyrgyzCyrillic | Lao | Latvian | Lithuanian | Lingala | LowerSorbian | Luganda | Macedonian | Maithili | Malagasy | MalayLatin | Malayalam | Maltese | Maori | Marathi | MongolianCyrillic | MongolianTraditional | Myanmar | Nepali | Norwegian | Nyanja | Odia | Pashto | Persian | Polish | PortugueseBrazil | PortuguesePortugal | Punjabi | QueretaroOtomi | Romanian | Rundi | Russian | SamoanLatin | SerbianCyrillic | SerbianLatin | Sesotho | SesothoSaLeboa | Setswana | Sindhi | Sinhala | Slovak | Slovenian | SomaliArabic | Spanish | SwahiliLatin | Swedish | Tahitian | Tamil | TatarLatin | Telugu | Thai | Tibetan | Tigrinya | Tongan | Turkish | TurkmenLatin | Ukrainian | UpperSorbian | Urdu | UyghurArabic | UzbekLatin | Vietnamese | Welsh | Xhosa | Yoruba | YucatecMaya | Zulu
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### aiTranslateText

`general.aiTranslateText`

AI - Translate Text (Single)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiTranslateText({"body":{"targetLanguage":"Afrikaans","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   sourceLanguage?: AUTO | Afrikaans | Albanian | Amharic | Arabic | Armenian | Assamese | AzerbaijaniLatin | Bangla | Bashkir | Basque | Bhojpuri | Bodo | BosnianLatin | Bulgarian | CantoneseTraditional | Catalan | ChineseLiterary | ChineseSimplified | ChineseTraditional | ChiShona | Croatian | Czech | Danish | Dari | Divehi | Dogri | Dutch | English | Estonian | Faroese | Fijian | Filipino | Finnish | French | FrenchCanadian | Galician | Georgian | German | Greek | Gujarati | HaitianCreole | Hausa | Hebrew | Hindi | HmongDawLatin | Hungarian | Icelandic | Igbo | Indonesian | Inuinnaqtun | Inuktitut | InuktitutLatin | Irish | Italian | Japanese | Kannada | Kashmiri | Kazakh | Khmer | Kinyarwanda | Klingon | KlingonPlqaD | Konkani | Korean | KurdishCentral | KurdishNorthern | KyrgyzCyrillic | Lao | Latvian | Lithuanian | Lingala | LowerSorbian | Luganda | Macedonian | Maithili | Malagasy | MalayLatin | Malayalam | Maltese | Maori | Marathi | MongolianCyrillic | MongolianTraditional | Myanmar | Nepali | Norwegian | Nyanja | Odia | Pashto | Persian | Polish | PortugueseBrazil | PortuguesePortugal | Punjabi | QueretaroOtomi | Romanian | Rundi | Russian | SamoanLatin | SerbianCyrillic | SerbianLatin | Sesotho | SesothoSaLeboa | Setswana | Sindhi | Sinhala | Slovak | Slovenian | SomaliArabic | Spanish | SwahiliLatin | Swedish | Tahitian | Tamil | TatarLatin | Telugu | Thai | Tibetan | Tigrinya | Tongan | Turkish | TurkmenLatin | Ukrainian | UpperSorbian | Urdu | UyghurArabic | UzbekLatin | Vietnamese | Welsh | Xhosa | Yoruba | YucatecMaya | Zulu,
>   targetLanguage: Afrikaans | Albanian | Amharic | Arabic | Armenian | Assamese | AzerbaijaniLatin | Bangla | Bashkir | Basque | Bhojpuri | Bodo | BosnianLatin | Bulgarian | CantoneseTraditional | Catalan | ChineseLiterary | ChineseSimplified | ChineseTraditional | ChiShona | Croatian | Czech | Danish | Dari | Divehi | Dogri | Dutch | English | Estonian | Faroese | Fijian | Filipino | Finnish | French | FrenchCanadian | Galician | Georgian | German | Greek | Gujarati | HaitianCreole | Hausa | Hebrew | Hindi | HmongDawLatin | Hungarian | Icelandic | Igbo | Indonesian | Inuinnaqtun | Inuktitut | InuktitutLatin | Irish | Italian | Japanese | Kannada | Kashmiri | Kazakh | Khmer | Kinyarwanda | Klingon | KlingonPlqaD | Konkani | Korean | KurdishCentral | KurdishNorthern | KyrgyzCyrillic | Lao | Latvian | Lithuanian | Lingala | LowerSorbian | Luganda | Macedonian | Maithili | Malagasy | MalayLatin | Malayalam | Maltese | Maori | Marathi | MongolianCyrillic | MongolianTraditional | Myanmar | Nepali | Norwegian | Nyanja | Odia | Pashto | Persian | Polish | PortugueseBrazil | PortuguesePortugal | Punjabi | QueretaroOtomi | Romanian | Rundi | Russian | SamoanLatin | SerbianCyrillic | SerbianLatin | Sesotho | SesothoSaLeboa | Setswana | Sindhi | Sinhala | Slovak | Slovenian | SomaliArabic | Spanish | SwahiliLatin | Swedish | Tahitian | Tamil | TatarLatin | Telugu | Thai | Tibetan | Tigrinya | Tongan | Turkish | TurkmenLatin | Ukrainian | UpperSorbian | Urdu | UyghurArabic | UzbekLatin | Vietnamese | Welsh | Xhosa | Yoruba | YucatecMaya | Zulu,
>   format?: HTML | Text,
>   profanityAction?: Delete | Keep | Replace,
>   profanityReplace?: Asterisk | Tag
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `translation` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### aiTranslateTextMultiple

`general.aiTranslateTextMultiple`

AI - Translate Text (Multiple)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.aiTranslateTextMultiple({"body":{"targetLanguages":[],"text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   sourceLanguage?: AUTO | Afrikaans | Albanian | Amharic | Arabic | Armenian | Assamese | AzerbaijaniLatin | Bangla | Bashkir | Basque | Bhojpuri | Bodo | BosnianLatin | Bulgarian | CantoneseTraditional | Catalan | ChineseLiterary | ChineseSimplified | ChineseTraditional | ChiShona | Croatian | Czech | Danish | Dari | Divehi | Dogri | Dutch | English | Estonian | Faroese | Fijian | Filipino | Finnish | French | FrenchCanadian | Galician | Georgian | German | Greek | Gujarati | HaitianCreole | Hausa | Hebrew | Hindi | HmongDawLatin | Hungarian | Icelandic | Igbo | Indonesian | Inuinnaqtun | Inuktitut | InuktitutLatin | Irish | Italian | Japanese | Kannada | Kashmiri | Kazakh | Khmer | Kinyarwanda | Klingon | KlingonPlqaD | Konkani | Korean | KurdishCentral | KurdishNorthern | KyrgyzCyrillic | Lao | Latvian | Lithuanian | Lingala | LowerSorbian | Luganda | Macedonian | Maithili | Malagasy | MalayLatin | Malayalam | Maltese | Maori | Marathi | MongolianCyrillic | MongolianTraditional | Myanmar | Nepali | Norwegian | Nyanja | Odia | Pashto | Persian | Polish | PortugueseBrazil | PortuguesePortugal | Punjabi | QueretaroOtomi | Romanian | Rundi | Russian | SamoanLatin | SerbianCyrillic | SerbianLatin | Sesotho | SesothoSaLeboa | Setswana | Sindhi | Sinhala | Slovak | Slovenian | SomaliArabic | Spanish | SwahiliLatin | Swedish | Tahitian | Tamil | TatarLatin | Telugu | Thai | Tibetan | Tigrinya | Tongan | Turkish | TurkmenLatin | Ukrainian | UpperSorbian | Urdu | UyghurArabic | UzbekLatin | Vietnamese | Welsh | Xhosa | Yoruba | YucatecMaya | Zulu,
>   targetLanguages: (Afrikaans | Albanian | Amharic | Arabic | Armenian | Assamese | AzerbaijaniLatin | Bangla | Bashkir | Basque | Bhojpuri | Bodo | BosnianLatin | Bulgarian | CantoneseTraditional | Catalan | ChineseLiterary | ChineseSimplified | ChineseTraditional | ChiShona | Croatian | Czech | Danish | Dari | Divehi | Dogri | Dutch | English | Estonian | Faroese | Fijian | Filipino | Finnish | French | FrenchCanadian | Galician | Georgian | German | Greek | Gujarati | HaitianCreole | Hausa | Hebrew | Hindi | HmongDawLatin | Hungarian | Icelandic | Igbo | Indonesian | Inuinnaqtun | Inuktitut | InuktitutLatin | Irish | Italian | Japanese | Kannada | Kashmiri | Kazakh | Khmer | Kinyarwanda | Klingon | KlingonPlqaD | Konkani | Korean | KurdishCentral | KurdishNorthern | KyrgyzCyrillic | Lao | Latvian | Lithuanian | Lingala | LowerSorbian | Luganda | Macedonian | Maithili | Malagasy | MalayLatin | Malayalam | Maltese | Maori | Marathi | MongolianCyrillic | MongolianTraditional | Myanmar | Nepali | Norwegian | Nyanja | Odia | Pashto | Persian | Polish | PortugueseBrazil | PortuguesePortugal | Punjabi | QueretaroOtomi | Romanian | Rundi | Russian | SamoanLatin | SerbianCyrillic | SerbianLatin | Sesotho | SesothoSaLeboa | Setswana | Sindhi | Sinhala | Slovak | Slovenian | SomaliArabic | Spanish | SwahiliLatin | Swedish | Tahitian | Tamil | TatarLatin | Telugu | Thai | Tibetan | Tigrinya | Tongan | Turkish | TurkmenLatin | Ukrainian | UpperSorbian | Urdu | UyghurArabic | UzbekLatin | Vietnamese | Welsh | Xhosa | Yoruba | YucatecMaya | Zulu)[],
>   format?: HTML | Text,
>   profanityAction?: Delete | Keep | Replace,
>   profanityReplace?: Asterisk | Tag
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `translations` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### buyAdditionalCredits

`general.buyAdditionalCredits`

Subscription - Buy Additional Credits (charges the subscription for extra Flowr credits)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.buyAdditionalCredits({"body":{"credits":0,"productName":"Flowr","purchaseType":"Automated"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   productName: Flowr | Vertr | Trigr,
>   purchaseType: Automated | Invoice,
>   credits: number,
>   purchaseOrder?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### extractFromArchive

`general.extractFromArchive`

Archive (ZIP) - Extract

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.extractFromArchive({"body":{"fileContent":"AA==","includeFolders":false}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   password?: string,
>   includeFolders: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

### extractFromArchiveV2

`general.extractFromArchiveV2`

Archive (ZIP) - Extract (V2)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.extractFromArchiveV2({"body":{"fileContent":"AA==","pathSeparator":"Backslash","recursive":false}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   password?: string,
>   pathSeparator: Backslash | ForwardSlash,
>   recursive: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null,
>   directory?: string | null
> }[]
> ```

***

### getEmailAttachments

`general.getEmailAttachments`

Email - Extract Attachments

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.getEmailAttachments({"body":{"fileContent":"AA==","fileName":"x","getInlineAttachments":false}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   getInlineAttachments: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

### getEmailInfo

`general.getEmailInfo`

Email - Extract Metadata

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.getEmailInfo({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `subject` | `string \| null` | No | — |
| `bodyText` | `string \| null` | No | — |
| `bodyHtml` | `string \| null` | No | — |
| `to` | `string \| null` | No | — |
| `toArray` | `string[] \| null` | No | — |
| `cc` | `string \| null` | No | — |
| `ccArray` | `string[] \| null` | No | — |
| `bcc` | `string \| null` | No | — |
| `bccArray` | `string[] \| null` | No | — |
| `from` | `string \| null` | No | — |
| `sent` | `string \| null` | No | — |
| `priority` | `string \| null` | No | — |
| `sensitivity` | `string \| null` | No | — |
| `hasAttachments` | `boolean \| null` | No | — |
| `fileSize` | `string \| null` | No | — |
| `messageId` | `string \| null` | No | — |
| `headers` | `string[] \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### getSubscriptionStatus

`general.getSubscriptionStatus`

Subscription – Flowr and Vertr Status

**Risk:** `read`

```ts theme={null}
await corsair.encodian.api.general.getSubscriptionStatus({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `never` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `availableActionsMonth` | `number \| null` | No | — |
| `availableActionsMonthDec` | `number \| null` | No | — |
| `subscriptionEnabled` | `boolean \| null` | No | — |
| `subscriptionLevel` | `string \| null` | No | — |
| `monthlyActions` | `number \| null` | No | — |
| `expiryDate` | `string \| null` | No | — |
| `billingInterval` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### searchAndReplaceText

`general.searchAndReplaceText`

File - Search and Replace Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.searchAndReplaceText({"body":{"Phrases":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileType?: PDF | DOCX,
>   FileName?: string,
>   FileContent?: string,
>   Phrases: {
>     SearchText: string,
>     IsExpression?: boolean,
>     ReplacementText?: string,
>     Font?: string,
>     FontSize?: number,
>     FontColour?: string,
>     BackgroundColour?: string,
>     Underline?: boolean,
>     WordSpacing?: number,
>     LineSpacing?: number
>   }[],
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### searchAndReplaceTextWithImage

`general.searchAndReplaceTextWithImage`

File - Replace Text with Image

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.general.searchAndReplaceTextWithImage({"body":{"imageFileContent":"AA==","imageFilename":"x","SearchText":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileType?: PDF | DOCX,
>   FileName?: string,
>   FileContent?: string,
>   SearchText: string,
>   imageFilename: string,
>   imageFileContent: string,
>   skipFirstPage?: boolean,
>   applyTo?: FirstPage | AllPages | LastPage | Specific,
>   pageNumbers?: number[],
>   ignorePageNumbers?: number[],
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

## Image

### addImageWatermarkToImage

`image.addImageWatermarkToImage`

Image - Add Image Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.addImageWatermarkToImage({"body":{"fileContent":"AA==","filename":"x","watermarkFileContent":"AA==","watermarkFilename":"x","watermarkPosition":"BottomLeft"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   filename: string,
>   fileContent: string,
>   watermarkFilename: string,
>   watermarkFileContent: string,
>   watermarkPosition: BottomLeft | TopLeft | BottomRight | TopRight | CentreHorizontal | CentreVertical | Diagonal | Custom,
>   imageYOffSet?: number,
>   imageXOffset?: number,
>   rotationAngle?: number,
>   opacity?: number,
>   alignImage?: boolean,
>   alignWatermark?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addTextWatermarkToImage

`image.addTextWatermarkToImage`

Image - Add Text Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.addTextWatermarkToImage({"body":{"FileName":"x","FinalOperation":false,"Text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   Text: string,
>   WatermarkPosition?: BottomLeft | TopLeft | BottomRight | TopRight | CentreHorizontal | CentreVertical | Diagonal,
>   Font?: string,
>   TextColour?: string,
>   TextSize?: number,
>   operationId?: string,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### compressImage

`image.compressImage`

Image - Compress

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.compressImage({"body":{"fileContent":"AA==","fileName":"x","imageType":"JPG"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   compressionLevel?: Default | Level1 | Level2 | Level3 | Level4 | Level5 | Level6 | Level7 | Level8 | Level9,
>   fileName: string,
>   imageType: JPG | PNG
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### cropImage

`image.cropImage`

Image - Crop

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.cropImage({"body":{"cropType":"Border","fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   cropType: Border | Rectangle,
>   fileContent: string,
>   leftBorder?: number,
>   rightBorder?: number,
>   topBorder?: number,
>   bottomBorder?: number,
>   upperLeftX?: number,
>   upperLeftY?: number,
>   width?: number,
>   height?: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   cropTypeParameter?: Border | Rectangle
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### flipImage

`image.flipImage`

Image - Flip

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.flipImage({"body":{"fileContent":"AA==","flipOrientation":"Horizontal"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   flipOrientation: Horizontal | Vertical | HorizontalAndVertical
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### getImageInfo

`image.getImageInfo`

Image - Extract Metadata

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.getImageInfo({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   simplifiedLatLongFormat?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `imageFormat` | `string \| null` | No | — |
| `fileSize` | `string \| null` | No | — |
| `width` | `number \| null` | No | — |
| `height` | `number \| null` | No | — |
| `orientation` | `string \| null` | No | — |
| `bitsPerPixel` | `number \| null` | No | — |
| `horizontalResolution` | `number \| null` | No | — |
| `verticalResolution` | `number \| null` | No | — |
| `hasExifData` | `boolean \| null` | No | — |
| `exifDataJson` | `string \| null` | No | — |
| `hasXmpData` | `boolean \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### imageCleanUpDocument

`image.imageCleanUpDocument`

Image - Clean Up (Document)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.imageCleanUpDocument({"body":{"AutoRotateConfidenceLevel":0,"FileName":"x","FinalOperation":false}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   cleanUpType?: Default | None | Specific,
>   AutoRotate?: boolean,
>   Deskew?: boolean,
>   Despeckle?: boolean,
>   AdjustBrightnessContrast?: boolean,
>   RemoveBorder?: boolean,
>   SmoothBackground?: boolean,
>   SmoothObjects?: boolean,
>   RemoveDotShading?: boolean,
>   ImageDetergent?: boolean,
>   ApplyAverageFilter?: boolean,
>   RemoveHolePunch?: boolean,
>   Binarize?: boolean,
>   FinalOperation: boolean,
>   AutoRotateConfidenceLevel: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### imageCleanUpPhoto

`image.imageCleanUpPhoto`

Image - Clean Up (Photo)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.imageCleanUpPhoto({"body":{"AutoRotateConfidenceLevel":0,"FileName":"x","FinalOperation":false}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   cleanUpType?: Default | None | Specific,
>   Deskew?: boolean,
>   Despeckle?: boolean,
>   ColorBalance?: boolean,
>   RemoveBorder?: boolean,
>   Contrast?: boolean,
>   RemoveRedeye?: boolean,
>   Blur?: boolean,
>   Diffuse?: boolean,
>   Binarize?: boolean,
>   AutoRotate?: boolean,
>   FinalOperation: boolean,
>   AutoRotateConfidenceLevel: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### imageConvertFormat

`image.imageConvertFormat`

Image - Convert Format

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.imageConvertFormat({"body":{"currentImageFormat":"BMP","fileContent":"AA==","fileName":"x","newImageFormat":"BMP"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   newImageFormat: BMP | GIF | JPG | PNG | TIF,
>   fileName: string,
>   currentImageFormat: BMP | GIF | JPG | PNG | TIF | HEIC
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### imageConvertToGrayscale

`image.imageConvertToGrayscale`

Image - Convert to Grayscale

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.imageConvertToGrayscale({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### imageExtractText

`image.imageExtractText`

Image - Extract Text (AI OCR)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.imageExtractText({"body":{"AutoRotateConfidenceLevel":0,"fileContent":"AA==","fileName":"x","imageType":"JPG"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   imageType: JPG | PNG | TIFF | BMP,
>   fileContent: string,
>   ocrLanguage?: Albanian | Arabic | Azerbaijani | Basque | Belarusian | Bengali | Bosnian | Bulgarian | Burmese | Catalan | ChineseSimplified | ChineseTraditional | Croatian | Czech | Danish | Dutch | English | Estonian | Finnish | French | Georgian | German | Greek | Gujarati | Hebrew | Hindi | Hungarian | Icelandic | Indonesian | Italian | Japanese | Kannada | Kazakh | Khmer | Korean | Kurdish | Kyrgyz | Laotian | Latin | Latvian | Lithuanian | Macedonian | Maharashtra | Malay | Malayalam | Maltese | Nepali | Norwegian | Oriya | Panjabi | Persian | Polish | Portuguese | Pushto | Romanian | Russian | Sanskrit | Serbian | Singhalese | Slovakian | Slovenian | Spanish | Swahili | Swedish | Syriac | Tamil | Telugu | Thai | Turkish | Ukrainian | Urdu | Uzbek | Vietnamese | Welsh | Yiddish,
>   cleanUpType?: Default | None | Specific,
>   AutoRotate?: boolean,
>   Deskew?: boolean,
>   Despeckle?: boolean,
>   AdjustBrightnessContrast?: boolean,
>   RemoveBorder?: boolean,
>   SmoothBackground?: boolean,
>   SmoothObjects?: boolean,
>   RemoveDotShading?: boolean,
>   ImageDetergent?: boolean,
>   ApplyAverageFilter?: boolean,
>   RemoveHolePunch?: boolean,
>   Binarize?: boolean,
>   AutoRotateConfidenceLevel: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Text` | `string` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### imageRemoveExifTags

`image.imageRemoveExifTags`

Image - Remove EXIF Tags

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.imageRemoveExifTags({"body":{"fileContent":"AA==","fileName":"x","imageType":"JPG"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   fileName: string,
>   imageType: JPG | PNG
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### resizeImage

`image.resizeImage`

Image - Resize

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.resizeImage({"body":{"FileContent":"AA==","FileName":"x","FinalOperation":false,"ImageResizeType":"Percentage"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent: string,
>   ImageResizeType: Percentage | Specific,
>   ResizePercentage?: number,
>   ImageWidth?: number,
>   ImageHeight?: number,
>   MaintainAspectRatio?: boolean,
>   aspectRatioDimension?: Width | Height | Largest,
>   ImageResolution?: number,
>   imageResizeResolutionMode?: Metadata | Resample,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### rotateImage

`image.rotateImage`

Image - Rotate

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.rotateImage({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   rotationAngle?: number,
>   presetRotationAngle?: None | Rotate90 | Rotate180 | Rotate270,
>   resizeProportionally?: boolean,
>   backgroundColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### rotateImageByExifData

`image.rotateImageByExifData`

Image - Rotate by EXIF Data

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.image.rotateImageByExifData({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

## Pdf

### addAttachmentsToPdf

`pdf.addAttachmentsToPdf`

PDF - Add Attachments

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.addAttachmentsToPdf({"body":{"attachments":[],"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   attachments: {
>     fileName?: string,
>     fileContent?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addHtmlHeaderFooter

`pdf.addHtmlHeaderFooter`

PDF - Add HTML Header or Footer

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.addHtmlHeaderFooter({"body":{"FileName":"x","htmlHeaderFooter":"x","htmlHeaderFooterLocation":"Header"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   htmlHeaderFooter: string,
>   htmlHeaderFooterLocation: Header | Footer | Both,
>   skipFirstPage?: boolean,
>   marginTop?: number,
>   marginBottom?: number,
>   marginRight?: number,
>   marginLeft?: number,
>   applyTo?: FirstPage | AllPages | LastPage | Specific,
>   pageNumbers?: number[],
>   ignorePageNumbers?: number[],
>   operationId?: string,
>   finalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addImageWatermark

`pdf.addImageWatermark`

PDF - Add Image Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.addImageWatermark({"body":{"FileName":"x","watermarkFileContent":"AA==","watermarkFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   watermarkFilename: string,
>   watermarkFileContent: string,
>   skipFirstPage?: boolean,
>   Orientation?: Vertical | Horizontal | Diagonal,
>   Opacity?: number,
>   watermarkId?: number,
>   alignImage?: boolean,
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `watermarkId` | `number \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addImageWatermarkAdvanced

`pdf.addImageWatermarkAdvanced`

PDF - Add Image Watermark (Advanced)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.addImageWatermarkAdvanced({"body":{"FileName":"x","watermarkFileContent":"AA==","watermarkFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   watermarkFilename: string,
>   watermarkFileContent: string,
>   skipFirstPage?: boolean,
>   applyTo?: FirstPage | AllPages | LastPage | Specific,
>   pageNumbers?: number[],
>   ignorePageNumbers?: number[],
>   opacity?: number,
>   rotationAngle?: number,
>   quality?: number,
>   imageXOffset?: number,
>   imageYOffSet?: number,
>   scale?: number,
>   addToBackground?: boolean,
>   watermarkId?: number,
>   alignImage?: boolean,
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `watermarkId` | `number \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addPageNumbers

`pdf.addPageNumbers`

PDF - Add Page Numbers

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.addPageNumbers({"body":{"FileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   StartPage?: number,
>   StartNumber?: number,
>   PageNumberFormat?: string,
>   HorizontalAlignment?: None | Left | Center | Right | Justify | FullJustify,
>   CustomNumberFormat?: string,
>   MarginTop?: number,
>   MarginRight?: number,
>   MarginBottom?: number,
>   MarginLeft?: number,
>   AddToBackground?: boolean,
>   Font?: string,
>   FontColour?: string,
>   FontSize?: number,
>   Opacity?: number,
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addTextWatermark

`pdf.addTextWatermark`

PDF - Add Text Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.addTextWatermark({"body":{"FileName":"x","Text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   Text: string,
>   skipFirstPage?: boolean,
>   Orientation?: Vertical | Horizontal | Diagonal,
>   horizontalAlignment?: Left | Center | Right | FullJustify | Justify | None,
>   verticalAlignment?: Top | Center | Bottom | None,
>   Font?: string,
>   TextColour?: string,
>   TextSize?: number,
>   Opacity?: number,
>   padding?: string,
>   watermarkId?: number,
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `watermarkId` | `number \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addTextWatermarkAdvanced

`pdf.addTextWatermarkAdvanced`

PDF - Add Text Watermark (Advanced)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.addTextWatermarkAdvanced({"body":{"FileName":"x","Text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   Text: string,
>   skipFirstPage?: boolean,
>   ApplyTo?: FirstPage | AllPages | LastPage | Specific,
>   pageNumbers?: number[],
>   ignorePageNumbers?: number[],
>   HorizontalAlignment?: Left | Center | Right | FullJustify | Justify | None,
>   VerticalAlignment?: Top | Center | Bottom | None,
>   TextAlignment?: None | Left | Center | Right | Justify | FullJustify,
>   watermarkApplyAsImage?: boolean,
>   AutoScale?: boolean,
>   AutoScaleWidth?: number,
>   AutoScaleHeight?: number,
>   EncodingType?: Identity_h | Identity_v | Cp1250 | Cp1252 | Cp1257 | Winansi | Macroman,
>   Font?: string,
>   TextColour?: string,
>   TextSize?: number,
>   Opacity?: number,
>   padding?: string,
>   RotationAngle?: number,
>   TextLayer?: boolean,
>   TextWrap?: boolean,
>   TextWrapRowWidth?: number,
>   YIndent?: number,
>   XIndent?: number,
>   watermarkId?: number,
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `watermarkId` | `number \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### aiOcrPdfDocument

`pdf.aiOcrPdfDocument`

PDF - Apply OCR (AI)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.aiOcrPdfDocument({"body":{"fileContent":"AA==","rotateConfidenceLevel":0}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   adjustBrightnessContrast?: boolean,
>   averageFilter?: boolean,
>   binarize?: boolean,
>   deskew?: boolean,
>   despeckle?: boolean,
>   imageDetergent?: boolean,
>   removeBorder?: boolean,
>   removeDotShading?: boolean,
>   removeHolePunch?: boolean,
>   rotate?: boolean,
>   smoothBackground?: boolean,
>   smoothObjects?: boolean,
>   highResolution?: boolean,
>   rotateConfidenceLevel: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### compressPdf

`pdf.compressPdf`

PDF - Compress

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.compressPdf({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   compressImages?: boolean,
>   imageQuality?: number,
>   maxResolution?: number,
>   resizeImages?: boolean,
>   removePrivateInfo?: boolean,
>   removeUnusedObjects?: boolean,
>   removeUnusedStreams?: boolean,
>   linkDuplicateStreams?: boolean,
>   allowReusePageContent?: boolean,
>   unembedFonts?: boolean,
>   flattenAnnotations?: boolean,
>   deleteAnnotations?: boolean,
>   flattenFields?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### deletePdfPages

`pdf.deletePdfPages`

PDF - Delete Pages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.deletePdfPages({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   StartPage?: number,
>   EndPage?: number,
>   pageNumbers?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### extractAttachmentsFromPdf

`pdf.extractAttachmentsFromPdf`

PDF - Extract Attachments

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.extractAttachmentsFromPdf({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string,
>   fileContent?: string
> }[]
> ```

***

### extractImages

`pdf.extractImages`

PDF - Extract Images from Regions

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.extractImages({"body":{"FileName":"x","ImageRegions":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   ImageRegions: {
>     Name?: string,
>     LowerLeftXCoordinate: number,
>     LowerLeftYCoordinate: number,
>     UpperRightXCoordinate: number,
>     UpperRightYCoordinate: number,
>     PageNumber: number,
>     ImageType: JPG | PNG | TIFF | BMP,
>     ExtractEntirePage: boolean,
>     Resolution: number
>   }[],
>   operationId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Images` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] Images full type
>
> ```ts theme={null}
> {
>   fileName?: string,
>   fileContent?: string
> }[]
> ```

***

### extractImagesAll

`pdf.extractImagesAll`

PDF - Extract Images

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.extractImagesAll({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   mode?: Document | Resources,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Images` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] Images full type
>
> ```ts theme={null}
> {
>   fileName?: string,
>   fileContent?: string
> }[]
> ```

***

### extractPdfPages

`pdf.extractPdfPages`

PDF - Extract Pages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.extractPdfPages({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   StartPage?: number,
>   EndPage?: number,
>   pageNumbers?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### extractPdfPagesByText

`pdf.extractPdfPagesByText`

PDF - Extract Pages by Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.extractPdfPagesByText({"body":{"fileContent":"AA==","searchValue":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   searchValue: string,
>   isExpression?: boolean,
>   pageNumbers?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### extractTextRegions

`pdf.extractTextRegions`

PDF - Extract Text from Regions

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.extractTextRegions({"body":{"FileName":"x","TextRegions":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   TextRegions: {
>     Name: string,
>     LowerLeftXCoordinate: number,
>     LowerLeftYCoordinate: number,
>     UpperRightXCoordinate: number,
>     UpperRightYCoordinate: number,
>     Page Number: number
>   }[],
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `TextRegionResultsSimple` | `string` | Yes | — |
| `TextRegionResults` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

> [accordion] TextRegionResults full type
>
> ```ts theme={null}
> {
>   Name?: string | null,
>   Text?: string | null,
>   PageNumber?: number | null
> }[]
> ```

***

### fillPdfForm

`pdf.fillPdfForm`

PDF - Fill Form

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.fillPdfForm({"body":{"FileName":"x","formData":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   formData: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### flattenPdf

`pdf.flattenPdf`

PDF - Flatten

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.flattenPdf({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### getPdfDocumentInfo

`pdf.getPdfDocumentInfo`

PDF - Extract Metadata

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.getPdfDocumentInfo({"body":{"fileContent":"AA==","FileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent: string,
>   operationId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `NumberOfPages` | `number \| null` | No | — |
| `FileSize` | `string \| null` | No | — |
| `Author` | `string \| null` | No | — |
| `Creator` | `string \| null` | No | — |
| `Producer` | `string \| null` | No | — |
| `Title` | `string \| null` | No | — |
| `Subject` | `string \| null` | No | — |
| `Keywords` | `string \| null` | No | — |
| `customProperties` | `string \| null` | No | — |
| `Orientation` | `string \| null` | No | — |
| `Width` | `number \| null` | No | — |
| `Height` | `number \| null` | No | — |
| `CreatedDate` | `string \| null` | No | — |
| `ModifiedDate` | `string \| null` | No | — |
| `PDFFormat` | `string \| null` | No | — |
| `IsPDFACompliant` | `boolean \| null` | No | — |
| `IsPDFUACompliant` | `boolean \| null` | No | — |
| `IsEncrypted` | `boolean \| null` | No | — |
| `HasTextLayer` | `boolean \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### getPdfFormData

`pdf.getPdfFormData`

PDF - Extract Form Data

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.getPdfFormData({"body":{"FileName":"x","FinalOperation":false}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   OperationId?: string,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Form Data` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### getPdfTextLayer

`pdf.getPdfTextLayer`

PDF - Extract Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.getPdfTextLayer({"body":{"FileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   StartPage?: number,
>   EndPage?: number,
>   removeControlCharacters?: boolean,
>   TextEncodingType?: Default | Latin1 | BigEndianUnicode | UTF16 | UTF8 | UTF7 | ASCII,
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `TextLayer` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### insertHtmlToPdf

`pdf.insertHtmlToPdf`

PDF - Insert HTML

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.insertHtmlToPdf({"body":{"FileName":"x","FinalOperation":false,"htmlData":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   htmlData: string,
>   htmlInsertLocation?: Append | Prepend | Specific,
>   htmlInsertLocationPage?: number,
>   pageOrientation?: Portrait | Landscape,
>   pageSize?: Default | A1 | A2 | A3 | A4 | A5 | A6 | B4 | B5 | EnvelopeDL | Executive | Folio | Ledger | Legal | Letter | Quarto | Statement | Tabloid | Custom,
>   viewPort?: Default | Mobile | Tablet | Laptop | LaptopL | FourK,
>   MarginTop?: number,
>   MarginBottom?: number,
>   MarginRight?: number,
>   MarginLeft?: number,
>   pageWidth?: number,
>   pageHeight?: number,
>   decodeHtmlData?: boolean,
>   operationId?: string,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### mergeArrayOfDocumentsToPdf

`pdf.mergeArrayOfDocumentsToPdf`

PDF - Merge Files

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.mergeArrayOfDocumentsToPdf({"body":{"documents":[],"FileName":"x","outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   FileName: string,
>   documents: {
>     fileName?: string,
>     fileContent?: string
>   }[],
>   generateBookmarks?: boolean,
>   pageNormalisation?: boolean,
>   preserveBookmarks?: boolean,
>   removeDocumentMarkup?: boolean,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### mergeDocumentsToPdf

`pdf.mergeDocumentsToPdf`

PDF - Merge Specific Files

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.mergeDocumentsToPdf({"body":{"fileContent":"AA==","fileContent2":"AA==","FileName":"x","fileName2":"x","outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   FileName: string,
>   fileContent: string,
>   fileName2: string,
>   fileContent2: string,
>   fileName3?: string,
>   fileContent3?: string,
>   fileName4?: string,
>   fileContent4?: string,
>   fileName5?: string,
>   fileContent5?: string,
>   fileName6?: string,
>   fileContent6?: string,
>   fileName7?: string,
>   fileContent7?: string,
>   fileName8?: string,
>   fileContent8?: string,
>   fileName9?: string,
>   fileContent9?: string,
>   fileName10?: string,
>   fileContent10?: string,
>   generateBookmarks?: boolean,
>   pageNormalisation?: boolean,
>   preserveBookmarks?: boolean,
>   removeDocumentMarkup?: boolean,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### ocrPdfDocument

`pdf.ocrPdfDocument`

PDF - Apply OCR (Standard)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.ocrPdfDocument({"body":{"AutoRotateConfidenceLevel":0,"FileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent?: string,
>   ocrLanguage?: Albanian | Arabic | Azerbaijani | Basque | Belarusian | Bengali | Bosnian | Bulgarian | Burmese | Catalan | ChineseSimplified | ChineseTraditional | Croatian | Czech | Danish | Dutch | English | Estonian | Finnish | French | Georgian | German | Greek | Gujarati | Hebrew | Hindi | Hungarian | Icelandic | Indonesian | Italian | Japanese | Kannada | Kazakh | Khmer | Korean | Kurdish | Kyrgyz | Laotian | Latin | Latvian | Lithuanian | Macedonian | Maharashtra | Malay | Malayalam | Maltese | Nepali | Norwegian | Oriya | Panjabi | Persian | Polish | Portuguese | Pushto | Romanian | Russian | Sanskrit | Serbian | Singhalese | Slovakian | Slovenian | Spanish | Swahili | Swedish | Syriac | Tamil | Telugu | Thai | Turkish | Ukrainian | Urdu | Uzbek | Vietnamese | Welsh | Yiddish,
>   ocrType?: Quality | Fast,
>   pdfaCompliance?: boolean,
>   pdfaComplianceLevel?: PDF_A_1A | PDF_A_1B | PDF_A_2A | PDF_A_3A | PDF_A_2B | PDF_A_2U | PDF_A_3B | PDF_A_3U | v_1_3 | v_1_4 | v_1_5 | v_1_6 | v_1_7 | PDF_X_1A | PDF_X_3,
>   cleanUpType?: Default | None | Specific,
>   AutoRotate?: boolean,
>   Deskew?: boolean,
>   Despeckle?: boolean,
>   AdjustBrightnessContrast?: boolean,
>   RemoveBorder?: boolean,
>   SmoothBackground?: boolean,
>   SmoothObjects?: boolean,
>   RemoveDotShading?: boolean,
>   ImageDetergent?: boolean,
>   ApplyAverageFilter?: boolean,
>   RemoveHolePunch?: boolean,
>   Binarize?: boolean,
>   RemoveBlankPages?: boolean,
>   operationId?: string,
>   FinalOperation?: boolean,
>   AutoRotateConfidenceLevel: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfCheckPassword

`pdf.pdfCheckPassword`

PDF - Check Password Protection

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfCheckPassword({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   viewPassword?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `viewPassword` | `boolean \| null` | No | — |
| `editPassword` | `boolean \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### pdfCreateZUGFeRDInvoice

`pdf.pdfCreateZUGFeRDInvoice`

PDF - Create ZUGFeRD Invoice

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfCreateZUGFeRDInvoice({"body":{"fileContent":"AA==","zUGFeRDFileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   zUGFeRDFileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfDeleteBlankPages

`pdf.pdfDeleteBlankPages`

PDF - Delete Blank Pages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfDeleteBlankPages({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfExtractHyperlinks

`pdf.pdfExtractHyperlinks`

PDF - Extract Hyperlinks

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfExtractHyperlinks({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   advancedData?: boolean,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### pdfExtractTableData

`pdf.pdfExtractTableData`

PDF - Extract Table Data

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfExtractTableData({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string,
>   extract?: First | Last | Custom,
>   startPage?: number,
>   endPage?: number,
>   tableIndex?: number,
>   hasHeaderRow?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### pdfExtractTextByPage

`pdf.pdfExtractTextByPage`

PDF - Extract Text by Page

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfExtractTextByPage({"body":{"FileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileContent: string,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   removeControlCharacters?: boolean,
>   textEncodingType?: Default | Latin1 | BigEndianUnicode | UTF16 | UTF8 | UTF7 | ASCII
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `pages` | `object[] \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] pages full type
>
> ```ts theme={null}
> {
>   Number?: number | null,
>   Text?: string | null
> }[] | null
> ```

***

### pdfFlattenFields

`pdf.pdfFlattenFields`

PDF - Flatten Fields

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfFlattenFields({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   fieldNames?: string,
>   pageNumbers?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfGenerateBookmarks

`pdf.pdfGenerateBookmarks`

PDF - Generate Bookmarks

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfGenerateBookmarks({"body":{"bookmarks":"x","fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   bookmarks: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfInsertPages

`pdf.pdfInsertPages`

PDF - Insert Pages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfInsertPages({"body":{"documents":[],"fileContent":"AA==","outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   fileContent: string,
>   documents: {
>     fileName: string,
>     fileContent: string,
>     targetPage?: number,
>     startPage?: number,
>     endPage?: number
>   }[],
>   preserveBookmarks?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfInsertToc

`pdf.pdfInsertToc`

PDF - Insert Table of Contents

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfInsertToc({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   title?: string,
>   destinationPage?: number,
>   jsonEntries?: string,
>   showPageNumbers?: boolean,
>   titleFont?: string,
>   titleFontColor?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   titleBackgroundColor?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   titleFontSize?: number,
>   titleFontStyle?: Bold | Italic | Regular,
>   titleHorizontalAlignment?: None | Left | Center | Right | Justify | FullJustify,
>   titleUnderline?: boolean,
>   itemFont?: string,
>   itemFontColor?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   itemBackgroundColor?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   itemFontSize?: number,
>   itemFontStyle?: Bold | Italic | Regular,
>   itemTopPadding?: number,
>   itemLevelPadding?: number,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfLinearize

`pdf.pdfLinearize`

PDF - Linearize

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfLinearize({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfRemoveDigitalSignature

`pdf.pdfRemoveDigitalSignature`

PDF - Remove Digital Signature

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfRemoveDigitalSignature({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfReplaceTextWithImage

`pdf.pdfReplaceTextWithImage`

PDF - Replace Text with Image

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfReplaceTextWithImage({"body":{"FileContent":"AA==","imageFileContent":"AA==","SearchText":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileContent: string,
>   SearchText: string,
>   imageFileContent: string,
>   skipFirstPage?: boolean,
>   applyTo?: First | All | Last | Specific,
>   pageNumbers?: string,
>   pageNumbersIgnore?: string,
>   alignImage?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfSearchAndReplaceText

`pdf.pdfSearchAndReplaceText`

PDF - Replace Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfSearchAndReplaceText({"body":{"phrases":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string,
>   phrases: {
>     searchText: string,
>     isExpression?: boolean,
>     replacementText?: string,
>     hideText?: boolean,
>     font?: string,
>     fontSize?: number,
>     fontColour?: string,
>     fontBackgroundColour?: string,
>     fontStyle?: Inherit | Regular | Bold | Italic,
>     styleCharacterSpacing?: number,
>     styleStrikeOut?: Inherit | Apply | Remove,
>     styleUnderline?: Inherit | Apply | Remove
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfSetMetadata

`pdf.pdfSetMetadata`

PDF - Set Metadata

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfSetMetadata({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   author?: string,
>   creationDate?: string,
>   keywords?: string,
>   modificationDate?: string,
>   subject?: string,
>   title?: string,
>   xmpMetadata?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### pdfUpdateHyperlinks

`pdf.pdfUpdateHyperlinks`

PDF - Update Hyperlinks

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.pdfUpdateHyperlinks({"body":{"fileContent":"AA==","hyperlinks":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   hyperlinks: {
>     searchOn: Text | URL,
>     searchValue: string,
>     isExpression?: boolean,
>     hyperlinkLabelValueCurrent?: string,
>     hyperlinkLabelValueNew?: string,
>     hyperlinkUrlValueCurrent?: string,
>     hyperlinkUrlValueNew?: string
>   }[],
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### redactPdf

`pdf.redactPdf`

PDF - Redact

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.redactPdf({"body":{"FileName":"x","Redactions":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   Redactions: {
>     SearchText?: string,
>     SearchExpression?: string,
>     RedactionColour?: string,
>     skipFirstPage?: boolean,
>     applyTo?: FirstPage | AllPages | LastPage | Specific,
>     pageNumbers?: number[],
>     ignorePageNumbers?: number[]
>   }[],
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### removeWatermarksFromPdf

`pdf.removeWatermarksFromPdf`

PDF - Remove Watermarks

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.removeWatermarksFromPdf({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   watermarkIds?: string,
>   removeWatermarkType?: All | Text | Image
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### repairPdf

`pdf.repairPdf`

PDF - Repair

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.repairPdf({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### resizePdf

`pdf.resizePdf`

PDF - Resize

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.resizePdf({"body":{"FileContent":"AA==","pageSize":"Default"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileContent: string,
>   pageSize: Default | A0 | A1 | A2 | A3 | A4 | A5 | A6 | B5 | P11x17 | Ledger | Legal | Letter | Custom,
>   startPage?: number,
>   EndPage?: number,
>   customWidth?: number,
>   customHeight?: number,
>   paddingBottom?: number,
>   paddingTop?: number,
>   paddingLeft?: number,
>   paddingRight?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### rotatePdfPages

`pdf.rotatePdfPages`

PDF - Rotate Pages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.rotatePdfPages({"body":{"fileContent":"AA==","pdfPageRotation":"Degrees90"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   pdfPageRotation: Degrees90 | Degrees180 | Degrees270 | Degrees360,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   pdfRotatePagesOrientation?: All | Portrait | Landscape
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### securePdfDocument

`pdf.securePdfDocument`

PDF - Secure

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.securePdfDocument({"body":{"FileName":"x","FinalOperation":false}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   userPassword?: string,
>   adminPassword?: string,
>   pdfPrivileges?: AllowAll | DenyAll | Specific,
>   cryptoAlgorithm?: RC4x40 | RC4x128 | AESx128 | AESx256 | Custom,
>   pdfPrivilegesAllowAssembly?: boolean,
>   pdfPrivilegesAllowCopy?: boolean,
>   pdfPrivilegesAllowFillIn?: boolean,
>   pdfPrivilegesAllowPrint?: boolean,
>   pdfPrivilegesAllowScreenReaders?: boolean,
>   pdfPrivilegesAllowModifyContents?: boolean,
>   pdfPrivilegesAllowModifyAnnotations?: boolean,
>   operationId?: string,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### setPdfPrivileges

`pdf.setPdfPrivileges`

PDF - Set Privileges

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.setPdfPrivileges({"body":{"FileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   pdfPrivileges?: AllowAll | DenyAll | Specific,
>   pdfPrivilegesAllowAssembly?: boolean,
>   pdfPrivilegesAllowCopy?: boolean,
>   pdfPrivilegesAllowFillIn?: boolean,
>   pdfPrivilegesAllowPrint?: boolean,
>   pdfPrivilegesAllowScreenReaders?: boolean,
>   pdfPrivilegesAllowModifyContents?: boolean,
>   pdfPrivilegesAllowModifyAnnotations?: boolean,
>   operationId?: string,
>   FinalOperation?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### signPdf

`pdf.signPdf`

PDF - Sign

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.signPdf({"body":{"certificateType":"Standard","fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   certificateType: Standard | Custom,
>   fileContent: string,
>   showSignatureStamp?: boolean,
>   signatureFileContent?: string,
>   signatureContact?: string,
>   signatureLocation?: string,
>   signatureReason?: string,
>   signatureSignedBy?: string,
>   signaturePlacement?: Coordinates | Placeholder,
>   placeholderText?: string,
>   signatureApplyTo?: FirstPage | LastPage | Specific,
>   signatureSpecificPage?: number,
>   stampBackgroundColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   stampForegroundColour?: AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>   stampFontSize?: number,
>   rectangleHeight?: number,
>   rectangleWidth?: number,
>   rectangleStartXSn?: number,
>   rectangleStartYSn?: number,
>   certificateFileContent?: string,
>   certificatePassword?: string,
>   rectangleStartXAp?: number,
>   rectangleStartYAp?: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   certificateTypeParameter?: Standard | Custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### splitDocument

`pdf.splitDocument`

PDF - Split

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.splitDocument({"body":{"fileName":"x","splitByType":"NumberOfPages","splitConfiguration":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent?: string,
>   splitByType: NumberOfPages | PageArray | BookmarkLevel,
>   splitConfiguration: string,
>   enableBookmarkFilenames?: boolean,
>   operationId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string,
>   fileContent?: string
> }[]
> ```

***

### splitPdfByBarcode

`pdf.splitPdfByBarcode`

PDF - Split by Barcode

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.splitPdfByBarcode({"body":{"fileName":"x","splitPdfByBarcodeAction":"SplitOn","splitPdfByBarcodeType":"AllInstances"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent?: string,
>   splitPdfByBarcodeValue?: string,
>   splitPdfByBarcodeType: AllInstances | FirstInstant | LastInstant,
>   splitPdfByBarcodeAction: SplitOn | SplitAfter | SplitBefore | Remove,
>   barcodeReadConfidence?: Low | Medium | High,
>   appendBarcodeValue?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[] \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   barcodeValue?: string | null
> }[] | null
> ```

***

### splitPdfByText

`pdf.splitPdfByText`

PDF - Split by Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.splitPdfByText({"body":{"fileName":"x","splitAction":"SplitOn","splitPdfByTextType":"AllInstances","splitValue":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent?: string,
>   splitValue: string,
>   isExpression?: boolean,
>   prefixFilename?: boolean,
>   splitPdfByTextType: AllInstances | FirstInstant | LastInstant,
>   splitAction: SplitOn | SplitAfter | SplitBefore | Remove
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string,
>   fileContent?: string
> }[]
> ```

***

### unlockPdfDocument

`pdf.unlockPdfDocument`

PDF - Unlock

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.unlockPdfDocument({"body":{"FileName":"x","FinalOperation":false,"password":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   fileContent?: string,
>   password: string,
>   operationId?: string,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### validatePdfTextLayer

`pdf.validatePdfTextLayer`

PDF - Validate Text Layer

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.pdf.validatePdfTextLayer({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   level?: Document | Page
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `valid` | `boolean \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

## Power Point

### compressPowerPoint

`powerPoint.compressPowerPoint`

PowerPoint - Compress

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.powerPoint.compressPowerPoint({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   compressionRate?: None | Low | Medium | High,
>   compressEmbeddedFonts?: boolean,
>   removeUnusedLayoutSlides?: boolean,
>   removeUnusedMasterSlides?: boolean,
>   resizeImagesToFrameSize?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### mergePresentations

`powerPoint.mergePresentations`

PowerPoint - Merge Files

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.powerPoint.mergePresentations({"body":{"documents":[],"mergePresentationOutputFormat":"FODP"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   mergePresentationOutputFormat: FODP | GIF | HTML | ODP | OTP | PDF | POT | POTM | POTX | PPS | PPSM | PPSX | PPT | PPTM | PPTX | SWF | TIFF | XPS,
>   outputFilename?: string,
>   documents: {
>     fileName: string,
>     fileContent: string,
>     sortPosition?: number,
>     slidesToMerge?: number[]
>   }[],
>   mergePresentationMasterStyle?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### populatePowerPoint

`powerPoint.populatePowerPoint`

PowerPoint - Populate

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.powerPoint.populatePowerPoint({"body":{"fileContent":"AA==","jsonData":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   jsonData: string,
>   jsonParseMode?: Standard | Strict,
>   allowMissingMembers?: boolean,
>   inlineErrorMessages?: boolean,
>   removeEmptyParagraphs?: boolean,
>   dateTimeFormat?: string,
>   multipleSlides?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### powerPointDeleteSlides

`powerPoint.powerPointDeleteSlides`

PowerPoint - Delete Slides

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.powerPoint.powerPointDeleteSlides({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   startSlide?: number,
>   endSlide?: number,
>   slideNumbers?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### powerPointSearchAndReplaceText

`powerPoint.powerPointSearchAndReplaceText`

PowerPoint - Replace Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.powerPoint.powerPointSearchAndReplaceText({"body":{"phrases":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string,
>   phrases: {
>     searchText: string,
>     isExpression?: boolean,
>     replacementText?: string,
>     findWholeWordsOnly?: boolean,
>     caseSensitive?: boolean,
>     font?: string,
>     fontColour?: Inherit | AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>     fontSize?: number,
>     styleBackgroundColour?: Inherit | AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>     styleBold?: Inherit | Apply | Remove,
>     styleItalic?: Inherit | Apply | Remove,
>     styleScriptPosition?: Inherit | Superscript | Subscript | Remove,
>     styleStrikethrough?: Inherit | Single | Double | Remove,
>     styleUnderline?: Inherit | Dashed | DotDash | DotDotDash | Dotted | Double | DoubleWavy | Heavy | HeavyDashed | HeavyDotDash | HeavyDotDotDash | HeavyDotted | HeavyLongDashed | HeavyWavy | LongDashed | None | Single | Wavy | Words,
>     wordSpacing?: number
>   }[],
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### powerPointSplit

`powerPoint.powerPointSplit`

PowerPoint - Split

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.powerPoint.powerPointSplit({"body":{"fileContent":"AA==","splitType":"All"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   splitType: All | NumberOfSlides | Array,
>   splitConfiguration?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

## Sign

### envelopeCreateMultiple

`sign.envelopeCreateMultiple`

Envelope - Sign Multiple Files

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.sign.envelopeCreateMultiple({"body":{"downloadAs":"Default","expiresIn":0,"files":[],"recipients":[],"sender":"x","title":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title: string,
>   message?: string,
>   sender: string,
>   files: {
>     inputFileId: string,
>     fileName: string,
>     file: string
>   }[],
>   deliveryMode?: Parallel | Sequential,
>   requirementMode?: AllRecipientsMustSign | OneRecipientMustSign,
>   recipients: {
>     type: Signer | Reviewer,
>     firstName?: string,
>     lastName?: string,
>     emailAddress: string,
>     order?: number,
>     language?: Default | EN | BG | CS | DA | DE | ES | FR | IT | JA | NL | NO | PL | PT | RO | RU | SV | TH | ZH_CN | ZH_TW,
>     fields: {
>       fieldType: Signature | TextBox | CheckBox | Name | Initials | DateSigned | Email | Title | Company | EditableDate | Image | Attachment | Label,
>       fieldName?: string,
>       placeholderText?: string,
>       defaultValue?: string,
>       isRequired?: boolean,
>       isReadOnly?: boolean,
>       inputFileId: string
>     }[]
>   }[],
>   expiresIn: number,
>   downloadAs: Default | Combined | Separate
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |
| `envelopeId` | `string \| null` | No | — |
| `created` | `string \| null` | No | — |
| `status` | `string \| null` | No | — |

***

### envelopeCreateMultipleWithStages

`sign.envelopeCreateMultipleWithStages`

Envelope - Sign Multiple Files with Stages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.sign.envelopeCreateMultipleWithStages({"body":{"downloadAs":"Default","expiresIn":0,"files":[],"sender":"x","stages":[],"title":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title: string,
>   message?: string,
>   sender: string,
>   files: {
>     inputFileId: string,
>     fileName: string,
>     file: string
>   }[],
>   stages: {
>     deliveryMode?: Parallel | Sequential,
>     requirementMode?: AllRecipientsMustSign | OneRecipientMustSign,
>     recipients: {
>       type: Signer | Reviewer,
>       firstName?: string,
>       lastName?: string,
>       emailAddress: string,
>       order?: number,
>       language?: Default | EN | BG | CS | DA | DE | ES | FR | IT | JA | NL | NO | PL | PT | RO | RU | SV | TH | ZH_CN | ZH_TW,
>       fields: {
>         fieldType: Signature | TextBox | CheckBox | Name | Initials | DateSigned | Email | Title | Company | EditableDate | Image | Attachment | Label,
>         fieldName?: string,
>         placeholderText?: string,
>         defaultValue?: string,
>         isRequired?: boolean,
>         isReadOnly?: boolean,
>         inputFileId: string
>       }[]
>     }[]
>   }[],
>   expiresIn: number,
>   downloadAs: Default | Combined | Separate
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |
| `envelopeId` | `string \| null` | No | — |
| `created` | `string \| null` | No | — |
| `status` | `string \| null` | No | — |

***

### envelopeCreateSingle

`sign.envelopeCreateSingle`

Envelope - Sign Single File

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.sign.envelopeCreateSingle({"body":{"downloadAs":"Default","expiresIn":0,"file":"AA==","sender":"x","title":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title: string,
>   message?: string,
>   sender: string,
>   fileName?: string,
>   file: string,
>   deliveryMode?: Parallel | Sequential,
>   requirementMode?: AllRecipientsMustSign | OneRecipientMustSign,
>   recipients?: {
>     type: Signer | Reviewer,
>     firstName?: string,
>     lastName?: string,
>     emailAddress: string,
>     order?: number,
>     language?: Default | EN | BG | CS | DA | DE | ES | FR | IT | JA | NL | NO | PL | PT | RO | RU | SV | TH | ZH_CN | ZH_TW,
>     fields?: {
>       fieldType: Signature | TextBox | CheckBox | Name | Initials | DateSigned | Email | Title | Company | EditableDate | Image | Attachment | Label,
>       fieldName?: string,
>       placeholderText?: string,
>       defaultValue?: string,
>       isRequired?: boolean,
>       isReadOnly?: boolean
>     }[]
>   }[],
>   expiresIn: number,
>   downloadAs: Default | Combined | Separate
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string \| null` | No | — |
| `created` | `string \| null` | No | — |
| `status` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### envelopeCreateSingleWithStages

`sign.envelopeCreateSingleWithStages`

Envelope - Sign Single File with Stages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.sign.envelopeCreateSingleWithStages({"body":{"downloadAs":"Default","expiresIn":0,"file":"AA==","sender":"x","stages":[],"title":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   title: string,
>   message?: string,
>   sender: string,
>   fileName?: string,
>   file: string,
>   stages: {
>     deliveryMode?: Parallel | Sequential,
>     requirementMode?: AllRecipientsMustSign | OneRecipientMustSign,
>     markAsGroup?: boolean,
>     groupName?: string,
>     recipients: {
>       type: Signer | Reviewer,
>       firstName?: string,
>       lastName?: string,
>       emailAddress: string,
>       order?: number,
>       language?: Default | EN | BG | CS | DA | DE | ES | FR | IT | JA | NL | NO | PL | PT | RO | RU | SV | TH | ZH_CN | ZH_TW,
>       fields?: {
>         fieldType: Signature | TextBox | CheckBox | Name | Initials | DateSigned | Email | Title | Company | EditableDate | Image | Attachment | Label,
>         fieldName?: string,
>         placeholderText?: string,
>         defaultValue?: string,
>         isRequired?: boolean,
>         isReadOnly?: boolean
>       }[]
>     }[]
>   }[],
>   expiresIn: number,
>   downloadAs: Default | Combined | Separate
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `envelopeId` | `string \| null` | No | — |
| `created` | `string \| null` | No | — |
| `status` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### envelopeDownloadAuditTrail

`sign.envelopeDownloadAuditTrail`

Deliverable - Download Audit Trail

**Risk:** `write`

```ts theme={null}
await corsair.encodian.api.sign.envelopeDownloadAuditTrail({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   envelopeId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `fileName` | `string \| null` | No | — |
| `file` | `string \| null` | No | — |
| `auditData` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### envelopeDownloadSignedDocuments

`sign.envelopeDownloadSignedDocuments`

Deliverable - Download Signed Documents

**Risk:** `write`

```ts theme={null}
await corsair.encodian.api.sign.envelopeDownloadSignedDocuments({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   envelopeId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[] \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   File?: string | null
> }[] | null
> ```

***

### envelopeGetStatus

`sign.envelopeGetStatus`

Envelope - Get Status

**Risk:** `write`

```ts theme={null}
await corsair.encodian.api.sign.envelopeGetStatus({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   envelopeId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### recipientCreateMultiple

`sign.recipientCreateMultiple`

Recipient - Add Multiple

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.sign.recipientCreateMultiple({"body":{"recipients":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   recipients: {
>     emailAddress: string,
>     firstName?: string,
>     lastName?: string,
>     company?: string,
>     jobTitle?: string,
>     phoneNumber?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `processed` | `string[] \| null` | No | — |
| `unprocessed` | `Record<string, string> \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### recipientCreateSingle

`sign.recipientCreateSingle`

Recipient - Add

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.sign.recipientCreateSingle({"body":{"emailAddress":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   emailAddress: string,
>   firstName?: string,
>   lastName?: string,
>   company?: string,
>   jobTitle?: string,
>   phoneNumber?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `recipientId` | `string \| null` | No | — |
| `created` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### recipientDeleteSingle

`sign.recipientDeleteSingle`

Recipient - Delete

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.sign.recipientDeleteSingle({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   emailAddress?: string,
>   recipientId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `deleted` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### recipientGetSingle

`sign.recipientGetSingle`

Recipient  - Get

**Risk:** `write`

```ts theme={null}
await corsair.encodian.api.sign.recipientGetSingle({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   emailAddress?: string,
>   recipientId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `recipientId` | `string \| null` | No | — |
| `emailAddress` | `string \| null` | No | — |
| `firstName` | `string \| null` | No | — |
| `lastName` | `string \| null` | No | — |
| `company` | `string \| null` | No | — |
| `jobTitle` | `string \| null` | No | — |
| `phoneNumber` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### recipientListAll

`sign.recipientListAll`

Recipient  - List All

**Risk:** `write`

```ts theme={null}
await corsair.encodian.api.sign.recipientListAll({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   limit?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `recipients` | `object[] \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

> [accordion] recipients full type
>
> ```ts theme={null}
> {
>   emailAddress: string,
>   firstName?: string,
>   lastName?: string,
>   company?: string,
>   jobTitle?: string,
>   phoneNumber?: string
> }[] | null
> ```

***

## Trigr

### getTrigrSubscriptionStatus

`trigr.getTrigrSubscriptionStatus`

Subscription - Trigr Status

**Risk:** `read`

```ts theme={null}
await corsair.encodian.api.trigr.getTrigrSubscriptionStatus({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `never` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `availableActionsMonth` | `number \| null` | No | — |
| `availableActionsMonthDec` | `number \| null` | No | — |
| `subscriptionEnabled` | `boolean \| null` | No | — |
| `subscriptionLevel` | `string \| null` | No | — |
| `monthlyActions` | `number \| null` | No | — |
| `expiryDate` | `string \| null` | No | — |
| `billingInterval` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

## Utilities

### aesDecryption

`utilities.aesDecryption`

Utility - AES Decryption

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.aesDecryption({"body":{"data":"x","inputDataEncodingMethod":"BASE64","key":"x","mode":"CBC"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   inputDataEncodingMethod: BASE64 | HEX,
>   key: string,
>   mode: CBC | ECB | CFB,
>   initializationVector?: string,
>   padding?: None | PKCS7 | Zeros | ANSIX923 | ISO10126
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### aesEncryption

`utilities.aesEncryption`

Utility - AES Encryption

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.aesEncryption({"body":{"data":"x","key":"x","mode":"CBC","outputDataEncodingMethod":"BASE64"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   outputDataEncodingMethod: BASE64 | HEX,
>   key: string,
>   mode: CBC | ECB | CFB,
>   initializationVector?: string,
>   padding?: None | PKCS7 | Zeros | ANSIX923 | ISO10126
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayAddItems

`utilities.arrayAddItems`

Utility - Array Add Items

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayAddItems({"body":{"data":"x","itemPosition":"First","items":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   items: string,
>   itemPosition: First | Last | Specific,
>   itemIndex?: number,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayCombine

`utilities.arrayCombine`

Utility - Array Combine

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayCombine({"body":{"data":"x","dataKey":"x","mergeData":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   mergeData: string,
>   dataKey: string,
>   mergeDataKey?: string,
>   path?: string,
>   mergeDataPath?: string,
>   fieldsToMerge?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayContainsValue

`utilities.arrayContainsValue`

Utility - Array Contains Value

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayContainsValue({"body":{"data":"x","value":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   value: string,
>   path?: string,
>   ignoreCase?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `boolean \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayConvertToJson

`utilities.arrayConvertToJson`

Utility - Array to JSON

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayConvertToJson({"body":{"data":"x","name":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   name: string,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayConvertToXml

`utilities.arrayConvertToXml`

Utility - Array to XML

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayConvertToXml({"body":{"data":"x","item":"x","root":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   root: string,
>   item: string,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayCountItems

`utilities.arrayCountItems`

Utility - Array Count Items

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayCountItems({"body":{"data":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `number \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayFilterItems

`utilities.arrayFilterItems`

Utility - Array Filter Items

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayFilterItems({"body":{"data":"x","keywords":"x","matchType":"All"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   keywords: string,
>   matchType: All | Any | None,
>   ignoreCase?: boolean,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayFilterItemsViaRegex

`utilities.arrayFilterItemsViaRegex`

Utility - Array Filter Items via Regex

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayFilterItemsViaRegex({"body":{"data":"x","matchType":"All","regex":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   regex: string,
>   matchType: All | Any | None,
>   ignoreCase?: boolean,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayGetItems

`utilities.arrayGetItems`

Utility - Array Get Item(s)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayGetItems({"body":{"data":"x","itemPosition":"First"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   itemPosition: First | Last | Specific,
>   itemIndex?: number,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayMerge

`utilities.arrayMerge`

Utility - Array Merge

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayMerge({"body":{"data":"x","mergeData":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   mergeData: string,
>   path?: string,
>   mergeDataPath?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayRemoveDuplicates

`utilities.arrayRemoveDuplicates`

Utility - Array Remove Duplicates

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayRemoveDuplicates({"body":{"data":"x","ignoreCase":false}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   ignoreCase: boolean,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayRemoveItems

`utilities.arrayRemoveItems`

Utility - Array Remove Items

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayRemoveItems({"body":{"data":"x","itemPosition":"First"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   itemPosition: First | Last | Specific,
>   itemIndex?: number,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayRemoveItemsRegex

`utilities.arrayRemoveItemsRegex`

Utility - Array Remove Items via Regex

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayRemoveItemsRegex({"body":{"data":"x","regex":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   regex: string,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayReplaceValues

`utilities.arrayReplaceValues`

Utility - Array Replace Values

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayReplaceValues({"body":{"data":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   searchValue?: string,
>   replacementValue?: string,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arrayReverseItems

`utilities.arrayReverseItems`

Utility - Array Reverse Items

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arrayReverseItems({"body":{"data":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arraySortItems

`utilities.arraySortItems`

Utility - Array Sort Items

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arraySortItems({"body":{"data":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   sortType?: Alphabetic | Numeric,
>   sortOrder?: Ascending | Descending,
>   path?: string,
>   attributeName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### arraySplitItems

`utilities.arraySplitItems`

Utility - Array Split Items

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.arraySplitItems({"body":{"data":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   splitValue?: string,
>   itemIndex?: number,
>   ignoreCase?: boolean,
>   path?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### calculateDate

`utilities.calculateDate`

Utility - Calculate Date

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.calculateDate({"body":{"date":"x","interval":0,"measurement":"Ticks","operation":"Add"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   date: string,
>   measurement: Ticks | Milliseconds | Seconds | Minutes | Hours | Days | Months | Years,
>   operation: Add | Subtract,
>   interval: number,
>   daysToExclude?: string,
>   datesToExclude?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### cleanString

`utilities.cleanString`

Utility - Clean Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.cleanString({"body":{"text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   removeCharacterSet?: string,
>   removeControlChars?: boolean,
>   removeInvalidFileNameChars?: boolean,
>   trimResult?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### compareText

`utilities.compareText`

Utility - Compare Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.compareText({"body":{"primaryText":"x","secondaryText":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   primaryText: string,
>   secondaryText: string,
>   ignoreCase?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `boolean \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### concatenateText

`utilities.concatenateText`

Utility - Concatenate Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.concatenateText({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   textList?: string[],
>   delimiter?: string,
>   trimResult?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### convertJsonToXml

`utilities.convertJsonToXml`

Utility - Convert JSON To XML

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.convertJsonToXml({"body":{"json":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   json: string,
>   rootName?: string,
>   includeArrayAttribute?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### convertTimeZoneEnc

`utilities.convertTimeZoneEnc`

Utility - Convert Time Zone

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.convertTimeZoneEnc({"body":{"date":"x","newTimeZone":"Default"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   date: string,
>   currentTimeZone?: Default | AUSCentralStandardTime | AUSEasternStandardTime | AfghanistanStandardTime | AlaskanStandardTime | AleutianStandardTime | AltaiStandardTime | ArabStandardTime | ArabianStandardTime | ArabicStandardTime | ArgentinaStandardTime | AstrakhanStandardTime | AtlanticStandardTime | AusCentralWStandardTime | AzerbaijanStandardTime | AzoresStandardTime | BahiaStandardTime | BangladeshStandardTime | BelarusStandardTime | BougainvilleStandardTime | CanadaCentralStandardTime | CapeVerdeStandardTime | CaucasusStandardTime | CenAustraliaStandardTime | CentralAmericaStandardTime | CentralAsiaStandardTime | CentralBrazilianStandardTime | CentralEuropeStandardTime | CentralEuropeanStandardTime | CentralPacificStandardTime | CentralStandardTime | CentralStandardTimeMexico | ChathamIslandsStandardTime | ChinaStandardTime | CubaStandardTime | DatelineStandardTime | EAfricaStandardTime | EAustraliaStandardTime | EEuropeStandardTime | ESouthAmericaStandardTime | EasterIslandStandardTime | EasternStandardTime | EasternStandardTimeMexico | EgyptStandardTime | EkaterinburgStandardTime | FLEStandardTime | FijiStandardTime | GMTStandardTime | GTBStandardTime | GeorgianStandardTime | GreenlandStandardTime | GreenwichStandardTime | HaitiStandardTime | HawaiianStandardTime | IndiaStandardTime | IranStandardTime | IsraelStandardTime | JordanStandardTime | KaliningradStandardTime | KamchatkaStandardTime | KoreaStandardTime | LibyaStandardTime | LineIslandsStandardTime | LordHoweStandardTime | MagadanStandardTime | MagallanesStandardTime | MarquesasStandardTime | MauritiusStandardTime | MidAtlanticStandardTime | MiddleEastStandardTime | MontevideoStandardTime | MoroccoStandardTime | MountainStandardTime | MountainStandardTimeMexico | MyanmarStandardTime | NCentralAsiaStandardTime | NamibiaStandardTime | NepalStandardTime | NewZealandStandardTime | NewfoundlandStandardTime | NorfolkStandardTime | NorthAsiaEastStandardTime | NorthAsiaStandardTime | NorthKoreaStandardTime | OmskStandardTime | PacificSAStandardTime | PacificStandardTime | PacificStandardTimeMexico | PakistanStandardTime | ParaguayStandardTime | QyzylordaStandardTime | RomanceStandardTime | RussiaTimeZone10 | RussiaTimeZone11 | RussiaTimeZone3 | RussianStandardTime | SAEasternStandardTime | SAPacificStandardTime | SAWesternStandardTime | SEAsiaStandardTime | SaintPierreStandardTime | SakhalinStandardTime | SamoaStandardTime | SaoTomeStandardTime | SaratovStandardTime | SingaporeStandardTime | SouthAfricaStandardTime | SouthSudanStandardTime | SriLankaStandardTime | SudanStandardTime | SyriaStandardTime | TaipeiStandardTime | TasmaniaStandardTime | TocantinsStandardTime | TokyoStandardTime | TomskStandardTime | TongaStandardTime | TransbaikalStandardTime | TurkeyStandardTime | TurksAndCaicosStandardTime | USEasternStandardTime | USMountainStandardTime | UTC | UTC02 | UTC08 | UTC09 | UTC11 | UTC12 | UTC13 | UlaanbaatarStandardTime | VenezuelaStandardTime | VladivostokStandardTime | VolgogradStandardTime | WAustraliaStandardTime | WCentralAfricaStandardTime | WEuropeStandardTime | WMongoliaStandardTime | WestAsiaStandardTime | WestBankStandardTime | WestPacificStandardTime | YakutskStandardTime | YukonStandardTime,
>   newTimeZone: Default | AUSCentralStandardTime | AUSEasternStandardTime | AfghanistanStandardTime | AlaskanStandardTime | AleutianStandardTime | AltaiStandardTime | ArabStandardTime | ArabianStandardTime | ArabicStandardTime | ArgentinaStandardTime | AstrakhanStandardTime | AtlanticStandardTime | AusCentralWStandardTime | AzerbaijanStandardTime | AzoresStandardTime | BahiaStandardTime | BangladeshStandardTime | BelarusStandardTime | BougainvilleStandardTime | CanadaCentralStandardTime | CapeVerdeStandardTime | CaucasusStandardTime | CenAustraliaStandardTime | CentralAmericaStandardTime | CentralAsiaStandardTime | CentralBrazilianStandardTime | CentralEuropeStandardTime | CentralEuropeanStandardTime | CentralPacificStandardTime | CentralStandardTime | CentralStandardTimeMexico | ChathamIslandsStandardTime | ChinaStandardTime | CubaStandardTime | DatelineStandardTime | EAfricaStandardTime | EAustraliaStandardTime | EEuropeStandardTime | ESouthAmericaStandardTime | EasterIslandStandardTime | EasternStandardTime | EasternStandardTimeMexico | EgyptStandardTime | EkaterinburgStandardTime | FLEStandardTime | FijiStandardTime | GMTStandardTime | GTBStandardTime | GeorgianStandardTime | GreenlandStandardTime | GreenwichStandardTime | HaitiStandardTime | HawaiianStandardTime | IndiaStandardTime | IranStandardTime | IsraelStandardTime | JordanStandardTime | KaliningradStandardTime | KamchatkaStandardTime | KoreaStandardTime | LibyaStandardTime | LineIslandsStandardTime | LordHoweStandardTime | MagadanStandardTime | MagallanesStandardTime | MarquesasStandardTime | MauritiusStandardTime | MidAtlanticStandardTime | MiddleEastStandardTime | MontevideoStandardTime | MoroccoStandardTime | MountainStandardTime | MountainStandardTimeMexico | MyanmarStandardTime | NCentralAsiaStandardTime | NamibiaStandardTime | NepalStandardTime | NewZealandStandardTime | NewfoundlandStandardTime | NorfolkStandardTime | NorthAsiaEastStandardTime | NorthAsiaStandardTime | NorthKoreaStandardTime | OmskStandardTime | PacificSAStandardTime | PacificStandardTime | PacificStandardTimeMexico | PakistanStandardTime | ParaguayStandardTime | QyzylordaStandardTime | RomanceStandardTime | RussiaTimeZone10 | RussiaTimeZone11 | RussiaTimeZone3 | RussianStandardTime | SAEasternStandardTime | SAPacificStandardTime | SAWesternStandardTime | SEAsiaStandardTime | SaintPierreStandardTime | SakhalinStandardTime | SamoaStandardTime | SaoTomeStandardTime | SaratovStandardTime | SingaporeStandardTime | SouthAfricaStandardTime | SouthSudanStandardTime | SriLankaStandardTime | SudanStandardTime | SyriaStandardTime | TaipeiStandardTime | TasmaniaStandardTime | TocantinsStandardTime | TokyoStandardTime | TomskStandardTime | TongaStandardTime | TransbaikalStandardTime | TurkeyStandardTime | TurksAndCaicosStandardTime | USEasternStandardTime | USMountainStandardTime | UTC | UTC02 | UTC08 | UTC09 | UTC11 | UTC12 | UTC13 | UlaanbaatarStandardTime | VenezuelaStandardTime | VladivostokStandardTime | VolgogradStandardTime | WAustraliaStandardTime | WCentralAfricaStandardTime | WEuropeStandardTime | WMongoliaStandardTime | WestAsiaStandardTime | WestBankStandardTime | WestPacificStandardTime | YakutskStandardTime | YukonStandardTime,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### convertXmlToJson

`utilities.convertXmlToJson`

Utility - Convert XML to JSON

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.convertXmlToJson({"body":{"xml":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   xml: string,
>   omitRootObject?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### createGuid

`utilities.createGuid`

Utility - Create GUID

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.createGuid({"body":{"case":"Lower"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   case: Lower | Upper
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### createHashCodeV2

`utilities.createHashCodeV2`

Utility - Create Hash Code

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.createHashCodeV2({"body":{"data":"x","digestAlgorithm":"SHA1"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   cryptoInputDataType?: TEXT | HEX | BASE64 | FILE,
>   digestAlgorithm: SHA1 | SHA256 | SHA384 | SHA512 | MD5 | RIPEMD160,
>   cryptoOutputDataType?: HASH | BASE64 | HEX,
>   case?: Lower | Upper,
>   encoding?: UTF8 | UTF7 | UTF32 | ASCII | Unicode | BigEndianUnicode | Default
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HashCode` | `string` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### createHMACV2

`utilities.createHMACV2`

Utility - Create HMAC

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.createHMACV2({"body":{"digestAlgorithm":"SHA1","key":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data?: string,
>   cryptoInputDataType?: TEXT | HEX | BASE64 | FILE,
>   key: string,
>   cryptoKeyDataType?: TEXT | HEX | BASE64 | FILE,
>   digestAlgorithm: SHA1 | SHA256 | SHA384 | SHA512 | MD5 | RIPEMD160,
>   cryptoOutputDataType?: HASH | BASE64 | HEX,
>   case?: Lower | Upper,
>   encoding?: UTF8 | UTF7 | UTF32 | ASCII | Unicode | BigEndianUnicode | Default
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `hmac` | `string` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### createJwt

`utilities.createJwt`

Utility - Create JWT

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.createJwt({"body":{"key":"x","securityAlgorithm":"HmacSha256Signature"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   claims?: string,
>   securityAlgorithm: HmacSha256Signature | HmacSha384Signature | HmacSha512Signature | HmacSha256 | HmacSha384 | HmacSha512 | RsaSha256Signature | RsaSha384Signature | RsaSha512Signature | RsaSha256 | RsaSha384 | RsaSha512 | Es256 | Es384 | Es512 | Es256Signature | Es384Signature | Es512Signature,
>   key: string,
>   audience?: string,
>   notBeforeTime?: number,
>   expirationTime?: number,
>   headers?: string,
>   issuedAtTime?: number,
>   issuer?: string,
>   subject?: string,
>   uniqueIdentifier?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### createRsaKeyPair

`utilities.createRsaKeyPair`

Utility - RSA Create Key Pair

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.createRsaKeyPair({"body":{"addHeaderAndFooter":false,"keySize":"Size2048","privateKeyFormat":"PKCS1"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   keySize: Size512 | Size1024 | Size2048 | Size3072 | Size4096,
>   privateKeyFormat: PKCS1 | PKCS8,
>   addHeaderAndFooter: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### escapeHtml

`utilities.escapeHtml`

Utility - Escape HTML

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.escapeHtml({"body":{"html":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   html: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### extractAllTextInstancesBetweenValues

`utilities.extractAllTextInstancesBetweenValues`

Utility - Extract Text Instances between Values

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.extractAllTextInstancesBetweenValues({"body":{"text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   startValue?: string,
>   endValue?: string,
>   ignoreCase?: boolean,
>   includeValues?: None | Start | End | Both,
>   trimResult?: boolean,
>   removeEmptyValues?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string[] \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### extractEmailAddressesFromText

`utilities.extractEmailAddressesFromText`

Utility - Extract Email Addresses from Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.extractEmailAddressesFromText({"body":{"regex":"x","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   regex: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string[] \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### extractTextBetweenValues

`utilities.extractTextBetweenValues`

Utility - Extract Text between Values

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.extractTextBetweenValues({"body":{"text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   startValue?: string,
>   endValue?: string,
>   ignoreCase?: boolean,
>   includeValues?: None | Start | End | Both,
>   trimResult?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### extractUrlsFromText

`utilities.extractUrlsFromText`

Utility - Extract URL's from Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.extractUrlsFromText({"body":{"regex":"x","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   regex: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string[] \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### formatDate

`utilities.formatDate`

Utility - Format Date

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.formatDate({"body":{"date":"x","format":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   date: string,
>   format: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### formatTextCase

`utilities.formatTextCase`

Utility - Format Text Case

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.formatTextCase({"body":{"action":"ToUpper","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   action: ToUpper | ToLower | ToUpperInvariant | ToLowerInvariant | ToTitleCase | ToSentenceCase | ToggleCase,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### generatePassword

`utilities.generatePassword`

Utility - Generate Password

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.generatePassword({"body":{"length":0}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   length: number,
>   includeLowerCase?: boolean,
>   includeUpperCase?: boolean,
>   includeNumbers?: boolean,
>   includeSymbols?: boolean,
>   excludeCharacters?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### generateRandomNumber

`utilities.generateRandomNumber`

Utility - Generate Random Number

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.generateRandomNumber({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   minValue?: number,
>   maxValue?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `number \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### getDateTimeDifference

`utilities.getDateTimeDifference`

Utility - Get Date and Time Difference

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.getDateTimeDifference({"body":{"endDateTime":"x","interval":"Year","startDateTime":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   startDateTime: string,
>   endDateTime: string,
>   interval: Year | Quarter | Month | Week | Day | Hour | Minute | Second | Millisecond,
>   daysToExclude?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `number \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### getFileExtension

`utilities.getFileExtension`

Utility - Get File Extension

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.getFileExtension({"body":{"fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   case?: Lower | Upper
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### getFileFormat

`utilities.getFileFormat`

Utility - Get File Format

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.getFileFormat({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   case?: Lower | Upper
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### parseHtmlTable

`utilities.parseHtmlTable`

Utility - Parse HTML Table

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.parseHtmlTable({"body":{}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent?: string,
>   html?: string,
>   tableIndex?: number,
>   tableId?: string,
>   quantityFilter?: number,
>   contentFilter?: All | DateTime | Integer | Currency | Decimal,
>   generateHeaders?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### regexSearchTextV2

`utilities.regexSearchTextV2`

Utility - Search Text (Regex)

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.regexSearchTextV2({"body":{"query":"x","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   query: string,
>   ecmaScript?: boolean,
>   explicitCapture?: boolean,
>   ignoreCase?: boolean,
>   ignoreWhitespace?: boolean,
>   multiline?: boolean,
>   rightToLeft?: boolean,
>   singleline?: boolean,
>   returnGroups?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `matches` | `string[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### removeDiacritics

`utilities.removeDiacritics`

Utility - Remove Diacritics

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.removeDiacritics({"body":{"text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   cultureName?: string,
>   trimResult?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### removeTextBetweenValues

`utilities.removeTextBetweenValues`

Utility - Remove Text between Values

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.removeTextBetweenValues({"body":{"endValue":"x","startValue":"x","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   startValue: string,
>   endValue: string,
>   ignoreCase?: boolean,
>   trimResult?: boolean,
>   replaceWith?: string,
>   includeValues?: None | Start | End | Both
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### removeWhitespaceFromText

`utilities.removeWhitespaceFromText`

Utility - Remove Whitespace from Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.removeWhitespaceFromText({"body":{"text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   removalType?: LeadingTrailing | RegularSpaces | All
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### replaceValueWithRegex

`utilities.replaceValueWithRegex`

Utility - Replace Value with Regex

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.replaceValueWithRegex({"body":{"regex":"x","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   regex: string,
>   replacementText?: string,
>   trimResult?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### replaceValueWithText

`utilities.replaceValueWithText`

Utility - Replace Value with Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.replaceValueWithText({"body":{"text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   searchText?: string,
>   replacementText?: string,
>   trimResult?: boolean,
>   ignoreCase?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### rsaDecryption

`utilities.rsaDecryption`

Utility - RSA Decryption

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.rsaDecryption({"body":{"data":"x","key":"x","keyType":"PUBLIC","mode":"RSA","rsaInputDataType":"BASE64"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   rsaInputDataType: BASE64 | HEX,
>   mode: RSA | RSA_PKCS1_PADDING | RSA_OAEP_PADDING,
>   keyType: PUBLIC | PRIVATE,
>   privateKeyFormat?: PKCS1 | PKCS8,
>   key: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### rsaEncryption

`utilities.rsaEncryption`

Utility - RSA Encryption

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.rsaEncryption({"body":{"data":"x","key":"x","keyType":"PUBLIC","mode":"RSA","rsaOutputDataType":"BASE64"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   data: string,
>   rsaOutputDataType: BASE64 | HEX,
>   mode: RSA | RSA_PKCS1_PADDING | RSA_OAEP_PADDING,
>   keyType: PUBLIC | PRIVATE,
>   privateKeyFormat?: PKCS1 | PKCS8,
>   key: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### splitText

`utilities.splitText`

Utility - Split Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.splitText({"body":{"text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   splitValue?: string,
>   splitOn?: All | First | Last,
>   trimResult?: boolean,
>   removeEmptyValues?: boolean,
>   preserveSplitValue?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string[] \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### splitTextViaRegex

`utilities.splitTextViaRegex`

Utility - Split Text via Regex

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.splitTextViaRegex({"body":{"regex":"x","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   regex: string,
>   splitOn?: All | First | Last,
>   trimResult?: boolean,
>   removeEmptyValues?: boolean,
>   preserveSplitValue?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string[] \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### textContainsValue

`utilities.textContainsValue`

Utility - Text Contains Value

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.textContainsValue({"body":{"text":"x","value":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   value: string,
>   ignoreCase?: boolean,
>   comparisonConfiguration?: CurrentCulture | InvariantCulture | Ordinal,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `boolean \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### trimText

`utilities.trimText`

Utility - Trim Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.trimText({"body":{"text":"x","textTrimPosition":"TrimStartAndEnd"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   text: string,
>   textTrimPosition: TrimStartAndEnd | TrimStart | TrimEnd,
>   trimCharacters?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### unescapeHtml

`utilities.unescapeHtml`

Utility - Unescape HTML

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.unescapeHtml({"body":{"html":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   html: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `string \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### validateEmailAddress

`utilities.validateEmailAddress`

Utility - Validate Email Address

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.validateEmailAddress({"body":{"emailAddress":"x","regex":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   emailAddress: string,
>   regex: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `boolean \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### validateGuid

`utilities.validateGuid`

Utility - Validate GUID

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.validateGuid({"body":{"guid":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   guid: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `boolean \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### validateJson

`utilities.validateJson`

Utility - Validate JSON

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.validateJson({"body":{"json":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   json: string,
>   schema?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `boolean \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### validateUrlAvailability

`utilities.validateUrlAvailability`

Utility - Validate URL Availability

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.validateUrlAvailability({"body":{"url":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   url: string,
>   validateURL?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `boolean \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

### validateUrlSyntax

`utilities.validateUrlSyntax`

Utility - Validate URL Syntax

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.utilities.validateUrlSyntax({"body":{"url":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   url: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `result` | `boolean \| null` | No | — |
| `httpStatusCode` | `number \| null` | No | — |
| `httpStatusMessage` | `string \| null` | No | — |
| `operationId` | `string \| null` | No | — |
| `errors` | `string[] \| null` | No | — |
| `operationStatus` | `string \| null` | No | — |

***

## Word

### addHtmlHeaderFooterWord

`word.addHtmlHeaderFooterWord`

Word - Add Headers and Footers

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.addHtmlHeaderFooterWord({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   allPagesHeaderHtml?: string,
>   allPagesFooterHtml?: string,
>   section?: All | First | Last,
>   insertMode?: Replace | Prepend,
>   firstPageHeaderHtml?: string,
>   evenPageHeaderHtml?: string,
>   oddPageHeaderHtml?: string,
>   firstPageFooterHtml?: string,
>   evenPageFooterHtml?: string,
>   oddPageFooterHtml?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addImageWatermarkWord

`word.addImageWatermarkWord`

Word - Add Image Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.addImageWatermarkWord({"body":{"fileContent":"AA==","fileName":"x","watermarkFileContent":"AA==","watermarkFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   watermarkFilename: string,
>   watermarkFileContent: string,
>   cultureName?: string,
>   scale?: number,
>   isSemiTransparent?: boolean,
>   alignImage?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### addTextWatermarkWord

`word.addTextWatermarkWord`

Word - Add Text Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.addTextWatermarkWord({"body":{"fileContent":"AA==","fileName":"x","text":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   text: string,
>   orientation?: Horizontal | Diagonal,
>   cultureName?: string,
>   font?: string,
>   textColour?: string,
>   textSize?: number,
>   isSemiTransparent?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### compareWordDocuments

`word.compareWordDocuments`

Word - Compare

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.compareWordDocuments({"body":{"fileContentOne":"AA==","fileContentTwo":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContentOne: string,
>   fileContentTwo: string,
>   author?: string,
>   ignoreFormatting?: boolean,
>   caseInsensitive?: boolean,
>   ignoreComments?: boolean,
>   ignoreTables?: boolean,
>   ignoreFields?: boolean,
>   ignoreFootnotes?: boolean,
>   ignoreTextboxes?: boolean,
>   ignoreHeadersAndFooters?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### deleteWordPages

`word.deleteWordPages`

Word - Delete Pages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.deleteWordPages({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### disableTrackedChanges

`word.disableTrackedChanges`

Word - Disable Tracked Changes

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.disableTrackedChanges({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### enableTrackedChanges

`word.enableTrackedChanges`

Word - Enable Tracked Changes

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.enableTrackedChanges({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### extractWordPages

`word.extractWordPages`

Word - Extract Pages

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.extractWordPages({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### getTextFromWord

`word.getTextFromWord`

Word - Extract Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.getTextFromWord({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   startPage?: number,
>   endPage?: number,
>   removeComments?: boolean,
>   acceptChanges?: boolean,
>   removeHeadersAndFooters?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `text` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### getTrackedChanges

`word.getTrackedChanges`

Word - Extract Tracked Changes

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.getTrackedChanges({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   includeComments?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `trackedChangesJson` | `string \| null` | No | — |
| `commentsJson` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### manageTrackedChanges

`word.manageTrackedChanges`

Word - Manage Tracked Changes

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.manageTrackedChanges({"body":{"FileContent":"AA==","FileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent: string,
>   acceptInsertions?: Accept | Reject | Ignore,
>   acceptDeletions?: Accept | Reject | Ignore,
>   acceptFormatChanges?: Accept | Reject | Ignore,
>   acceptMovements?: Accept | Reject | Ignore,
>   removeComments?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### mergeArrayOfDocumentsToWord

`word.mergeArrayOfDocumentsToWord`

Word - Merge Files

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.mergeArrayOfDocumentsToWord({"body":{"documents":[],"FinalOperation":false,"outputFilename":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   outputFilename: string,
>   documents: {
>     fileName: string,
>     fileContent: string,
>     sortPosition?: number,
>     wordInputFormatMode?: KeepSourceFormatting | KeepDifferentStyles | UseDestinationStyles
>   }[],
>   mergeContent?: boolean,
>   timezone?: Default | AUSCentralStandardTime | AUSEasternStandardTime | AfghanistanStandardTime | AlaskanStandardTime | AleutianStandardTime | AltaiStandardTime | ArabStandardTime | ArabianStandardTime | ArabicStandardTime | ArgentinaStandardTime | AstrakhanStandardTime | AtlanticStandardTime | AusCentralWStandardTime | AzerbaijanStandardTime | AzoresStandardTime | BahiaStandardTime | BangladeshStandardTime | BelarusStandardTime | BougainvilleStandardTime | CanadaCentralStandardTime | CapeVerdeStandardTime | CaucasusStandardTime | CenAustraliaStandardTime | CentralAmericaStandardTime | CentralAsiaStandardTime | CentralBrazilianStandardTime | CentralEuropeStandardTime | CentralEuropeanStandardTime | CentralPacificStandardTime | CentralStandardTime | CentralStandardTimeMexico | ChathamIslandsStandardTime | ChinaStandardTime | CubaStandardTime | DatelineStandardTime | EAfricaStandardTime | EAustraliaStandardTime | EEuropeStandardTime | ESouthAmericaStandardTime | EasterIslandStandardTime | EasternStandardTime | EasternStandardTimeMexico | EgyptStandardTime | EkaterinburgStandardTime | FLEStandardTime | FijiStandardTime | GMTStandardTime | GTBStandardTime | GeorgianStandardTime | GreenlandStandardTime | GreenwichStandardTime | HaitiStandardTime | HawaiianStandardTime | IndiaStandardTime | IranStandardTime | IsraelStandardTime | JordanStandardTime | KaliningradStandardTime | KamchatkaStandardTime | KoreaStandardTime | LibyaStandardTime | LineIslandsStandardTime | LordHoweStandardTime | MagadanStandardTime | MagallanesStandardTime | MarquesasStandardTime | MauritiusStandardTime | MidAtlanticStandardTime | MiddleEastStandardTime | MontevideoStandardTime | MoroccoStandardTime | MountainStandardTime | MountainStandardTimeMexico | MyanmarStandardTime | NCentralAsiaStandardTime | NamibiaStandardTime | NepalStandardTime | NewZealandStandardTime | NewfoundlandStandardTime | NorfolkStandardTime | NorthAsiaEastStandardTime | NorthAsiaStandardTime | NorthKoreaStandardTime | OmskStandardTime | PacificSAStandardTime | PacificStandardTime | PacificStandardTimeMexico | PakistanStandardTime | ParaguayStandardTime | QyzylordaStandardTime | RomanceStandardTime | RussiaTimeZone10 | RussiaTimeZone11 | RussiaTimeZone3 | RussianStandardTime | SAEasternStandardTime | SAPacificStandardTime | SAWesternStandardTime | SEAsiaStandardTime | SaintPierreStandardTime | SakhalinStandardTime | SamoaStandardTime | SaoTomeStandardTime | SaratovStandardTime | SingaporeStandardTime | SouthAfricaStandardTime | SouthSudanStandardTime | SriLankaStandardTime | SudanStandardTime | SyriaStandardTime | TaipeiStandardTime | TasmaniaStandardTime | TocantinsStandardTime | TokyoStandardTime | TomskStandardTime | TongaStandardTime | TransbaikalStandardTime | TurkeyStandardTime | TurksAndCaicosStandardTime | USEasternStandardTime | USMountainStandardTime | UTC | UTC02 | UTC08 | UTC09 | UTC11 | UTC12 | UTC13 | UlaanbaatarStandardTime | VenezuelaStandardTime | VladivostokStandardTime | VolgogradStandardTime | WAustraliaStandardTime | WCentralAfricaStandardTime | WEuropeStandardTime | WMongoliaStandardTime | WestAsiaStandardTime | WestBankStandardTime | WestPacificStandardTime | YakutskStandardTime | YukonStandardTime,
>   quickPartMapping?: First | Last | None,
>   WordComplianceLevel?: Ecma | Transitional | Strict,
>   FinalOperation: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### optimiseWordDocument

`word.optimiseWordDocument`

Word - Optimise

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.optimiseWordDocument({"body":{"fileContent":"AA==","fileName":"x","version":"Word2000"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   version: Word2000 | Word2002 | Word2003 | Word2007 | Word2010 | Word2013 | Word2016 | Word2019,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### populateWordDocument

`word.populateWordDocument`

Word - Populate

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.populateWordDocument({"body":{"documentData":"x","fileContent":"AA==","populationOptions":"Default"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   documentData: string,
>   jsonParseMode?: Standard | Strict,
>   allowMissingMembers?: boolean,
>   inlineErrorMessages?: boolean,
>   removeEmptyParagraphs?: boolean,
>   dateTimeFormat?: string,
>   cultureName?: string,
>   timezone?: Default | AUSCentralStandardTime | AUSEasternStandardTime | AfghanistanStandardTime | AlaskanStandardTime | AleutianStandardTime | AltaiStandardTime | ArabStandardTime | ArabianStandardTime | ArabicStandardTime | ArgentinaStandardTime | AstrakhanStandardTime | AtlanticStandardTime | AusCentralWStandardTime | AzerbaijanStandardTime | AzoresStandardTime | BahiaStandardTime | BangladeshStandardTime | BelarusStandardTime | BougainvilleStandardTime | CanadaCentralStandardTime | CapeVerdeStandardTime | CaucasusStandardTime | CenAustraliaStandardTime | CentralAmericaStandardTime | CentralAsiaStandardTime | CentralBrazilianStandardTime | CentralEuropeStandardTime | CentralEuropeanStandardTime | CentralPacificStandardTime | CentralStandardTime | CentralStandardTimeMexico | ChathamIslandsStandardTime | ChinaStandardTime | CubaStandardTime | DatelineStandardTime | EAfricaStandardTime | EAustraliaStandardTime | EEuropeStandardTime | ESouthAmericaStandardTime | EasterIslandStandardTime | EasternStandardTime | EasternStandardTimeMexico | EgyptStandardTime | EkaterinburgStandardTime | FLEStandardTime | FijiStandardTime | GMTStandardTime | GTBStandardTime | GeorgianStandardTime | GreenlandStandardTime | GreenwichStandardTime | HaitiStandardTime | HawaiianStandardTime | IndiaStandardTime | IranStandardTime | IsraelStandardTime | JordanStandardTime | KaliningradStandardTime | KamchatkaStandardTime | KoreaStandardTime | LibyaStandardTime | LineIslandsStandardTime | LordHoweStandardTime | MagadanStandardTime | MagallanesStandardTime | MarquesasStandardTime | MauritiusStandardTime | MidAtlanticStandardTime | MiddleEastStandardTime | MontevideoStandardTime | MoroccoStandardTime | MountainStandardTime | MountainStandardTimeMexico | MyanmarStandardTime | NCentralAsiaStandardTime | NamibiaStandardTime | NepalStandardTime | NewZealandStandardTime | NewfoundlandStandardTime | NorfolkStandardTime | NorthAsiaEastStandardTime | NorthAsiaStandardTime | NorthKoreaStandardTime | OmskStandardTime | PacificSAStandardTime | PacificStandardTime | PacificStandardTimeMexico | PakistanStandardTime | ParaguayStandardTime | QyzylordaStandardTime | RomanceStandardTime | RussiaTimeZone10 | RussiaTimeZone11 | RussiaTimeZone3 | RussianStandardTime | SAEasternStandardTime | SAPacificStandardTime | SAWesternStandardTime | SEAsiaStandardTime | SaintPierreStandardTime | SakhalinStandardTime | SamoaStandardTime | SaoTomeStandardTime | SaratovStandardTime | SingaporeStandardTime | SouthAfricaStandardTime | SouthSudanStandardTime | SriLankaStandardTime | SudanStandardTime | SyriaStandardTime | TaipeiStandardTime | TasmaniaStandardTime | TocantinsStandardTime | TokyoStandardTime | TomskStandardTime | TongaStandardTime | TransbaikalStandardTime | TurkeyStandardTime | TurksAndCaicosStandardTime | USEasternStandardTime | USMountainStandardTime | UTC | UTC02 | UTC08 | UTC09 | UTC11 | UTC12 | UTC13 | UlaanbaatarStandardTime | VenezuelaStandardTime | VladivostokStandardTime | VolgogradStandardTime | WAustraliaStandardTime | WCentralAfricaStandardTime | WEuropeStandardTime | WMongoliaStandardTime | WestAsiaStandardTime | WestBankStandardTime | WestPacificStandardTime | YakutskStandardTime | YukonStandardTime,
>   populationOptions: Default | AllowMissingMembers | ClearEmptyParagraphs | InlineErrors
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### removeHeaderFooterWord

`word.removeHeaderFooterWord`

Word - Remove Headers and Footers

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.removeHeaderFooterWord({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   removeAllHeaders?: boolean,
>   removeAllFooters?: boolean,
>   removeFirstPageHeader?: boolean,
>   removeEvenPageHeader?: boolean,
>   removeOddPageHeader?: boolean,
>   removeFirstPageFooter?: boolean,
>   removeEvenPageFooter?: boolean,
>   removeOddPageFooter?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### removeWatermarksFromWord

`word.removeWatermarksFromWord`

Word - Remove Watermark

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.removeWatermarksFromWord({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### removeWordTableOfContents

`word.removeWordTableOfContents`

Word - Remove Table of Contents

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.removeWordTableOfContents({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   cultureName?: string,
>   tableOfContentsIndexes?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### searchAndReplaceHyperlink

`word.searchAndReplaceHyperlink`

Word - Update Hyperlinks

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.searchAndReplaceHyperlink({"body":{"fileContent":"AA==","hyperlinks":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName?: string,
>   fileContent: string,
>   hyperlinks: {
>     searchOn: Text | URL,
>     searchValue: string,
>     isExpression?: boolean,
>     hyperlinkLabelValueCurrent?: string,
>     hyperlinkLabelValueNew?: string,
>     hyperlinkUrlValueCurrent?: string,
>     hyperlinkUrlValueNew?: string
>   }[],
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### secureWordDocument

`word.secureWordDocument`

Word - Secure

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.secureWordDocument({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   wordProtectionType?: AllowComments | AllowFormFields | AllowRevisions | ReadOnly | NoProtection,
>   password?: string,
>   secureOnOpen?: boolean,
>   secureOnOpenPassword?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### splitWordDocument

`word.splitWordDocument`

Word - Split

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.splitWordDocument({"body":{"fileContent":"AA==","fileName":"x","splitType":"AllPages"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   splitType: AllPages | Array | NumberOfPages | Section | Headings,
>   splitConfiguration?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

### updateWordTableOfContents

`word.updateWordTableOfContents`

Word - Update Table of Contents

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.updateWordTableOfContents({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   timezone?: Default | AUSCentralStandardTime | AUSEasternStandardTime | AfghanistanStandardTime | AlaskanStandardTime | AleutianStandardTime | AltaiStandardTime | ArabStandardTime | ArabianStandardTime | ArabicStandardTime | ArgentinaStandardTime | AstrakhanStandardTime | AtlanticStandardTime | AusCentralWStandardTime | AzerbaijanStandardTime | AzoresStandardTime | BahiaStandardTime | BangladeshStandardTime | BelarusStandardTime | BougainvilleStandardTime | CanadaCentralStandardTime | CapeVerdeStandardTime | CaucasusStandardTime | CenAustraliaStandardTime | CentralAmericaStandardTime | CentralAsiaStandardTime | CentralBrazilianStandardTime | CentralEuropeStandardTime | CentralEuropeanStandardTime | CentralPacificStandardTime | CentralStandardTime | CentralStandardTimeMexico | ChathamIslandsStandardTime | ChinaStandardTime | CubaStandardTime | DatelineStandardTime | EAfricaStandardTime | EAustraliaStandardTime | EEuropeStandardTime | ESouthAmericaStandardTime | EasterIslandStandardTime | EasternStandardTime | EasternStandardTimeMexico | EgyptStandardTime | EkaterinburgStandardTime | FLEStandardTime | FijiStandardTime | GMTStandardTime | GTBStandardTime | GeorgianStandardTime | GreenlandStandardTime | GreenwichStandardTime | HaitiStandardTime | HawaiianStandardTime | IndiaStandardTime | IranStandardTime | IsraelStandardTime | JordanStandardTime | KaliningradStandardTime | KamchatkaStandardTime | KoreaStandardTime | LibyaStandardTime | LineIslandsStandardTime | LordHoweStandardTime | MagadanStandardTime | MagallanesStandardTime | MarquesasStandardTime | MauritiusStandardTime | MidAtlanticStandardTime | MiddleEastStandardTime | MontevideoStandardTime | MoroccoStandardTime | MountainStandardTime | MountainStandardTimeMexico | MyanmarStandardTime | NCentralAsiaStandardTime | NamibiaStandardTime | NepalStandardTime | NewZealandStandardTime | NewfoundlandStandardTime | NorfolkStandardTime | NorthAsiaEastStandardTime | NorthAsiaStandardTime | NorthKoreaStandardTime | OmskStandardTime | PacificSAStandardTime | PacificStandardTime | PacificStandardTimeMexico | PakistanStandardTime | ParaguayStandardTime | QyzylordaStandardTime | RomanceStandardTime | RussiaTimeZone10 | RussiaTimeZone11 | RussiaTimeZone3 | RussianStandardTime | SAEasternStandardTime | SAPacificStandardTime | SAWesternStandardTime | SEAsiaStandardTime | SaintPierreStandardTime | SakhalinStandardTime | SamoaStandardTime | SaoTomeStandardTime | SaratovStandardTime | SingaporeStandardTime | SouthAfricaStandardTime | SouthSudanStandardTime | SriLankaStandardTime | SudanStandardTime | SyriaStandardTime | TaipeiStandardTime | TasmaniaStandardTime | TocantinsStandardTime | TokyoStandardTime | TomskStandardTime | TongaStandardTime | TransbaikalStandardTime | TurkeyStandardTime | TurksAndCaicosStandardTime | USEasternStandardTime | USMountainStandardTime | UTC | UTC02 | UTC08 | UTC09 | UTC11 | UTC12 | UTC13 | UlaanbaatarStandardTime | VenezuelaStandardTime | VladivostokStandardTime | VolgogradStandardTime | WAustraliaStandardTime | WCentralAfricaStandardTime | WEuropeStandardTime | WMongoliaStandardTime | WestAsiaStandardTime | WestBankStandardTime | WestPacificStandardTime | YakutskStandardTime | YukonStandardTime,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### wordAddPageNumbers

`word.wordAddPageNumbers`

Word - Add Page Numbers

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordAddPageNumbers({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   pageNumberFormat?: string,
>   location?: Header | Footer,
>   alignment?: Center | Left | Right,
>   fontColor?: string,
>   fontName?: string,
>   fontSize?: number,
>   pageNumberStyle?: Arabic | UppercaseRoman | LowercaseRoman | UppercaseLetter | LowercaseLetter | Ordinal | Number | OrdinalText | Hex | ChicagoManual | Kanji | KanjiDigit | AiueoHalfWidth | IrohaHalfWidth | ArabicFullWidth | ArabicHalfWidth | KanjiTraditional | KanjiTraditional2 | NumberInCircle | DecimalFullWidth | Aiueo | Iroha | LeadingZero | Bullet | Ganada | Chosung | GB1 | GB2 | GB3 | GB4 | Zodiac1 | Zodiac2 | Zodiac3 | TradChinNum1 | TradChinNum2 | TradChinNum3 | TradChinNum4 | SimpChinNum1 | SimpChinNum2 | SimpChinNum3 | SimpChinNum4 | HanjaRead | HanjaReadDigit | Hangul | Hanja | Hebrew1 | Arabic1 | Hebrew2 | Arabic2 | HindiLetter1 | HindiLetter2 | HindiArabic | HindiCardinalText | ThaiLetter | ThaiArabic | ThaiCardinalText | VietCardinalText | NumberInDash | LowercaseRussian | UppercaseRussian | None,
>   skipFirstPage?: boolean,
>   sectionIndex?: number,
>   startingPageNumber?: number,
>   sectionNumbering?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### wordExtractFieldData

`word.wordExtractFieldData`

Word - Extract Field Data

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordExtractFieldData({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   resultBehaviour?: ThrowError | ReturnEmptyObject,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `wordFieldData` | `string \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### wordExtractFiles

`word.wordExtractFiles`

Word - Extract Files

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordExtractFiles({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

### wordExtractImages

`word.wordExtractImages`

Word - Extract Images

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordExtractImages({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   imageIndexes?: string,
>   includeBodyImages?: boolean,
>   includeHeaderImages?: boolean,
>   includeFooterImages?: boolean,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `Images` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] Images full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

### wordExtractMetadata

`word.wordExtractMetadata`

Word - Extract Metadata

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordExtractMetadata({"body":{"fileContent":"AA=="}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileContent: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `author` | `string \| null` | No | — |
| `category` | `string \| null` | No | — |
| `characters` | `number \| null` | No | — |
| `charactersWithSpaces` | `number \| null` | No | — |
| `comments` | `string \| null` | No | — |
| `company` | `string \| null` | No | — |
| `contentType` | `string \| null` | No | — |
| `created` | `string \| null` | No | — |
| `customProperties` | `string \| null` | No | — |
| `fileSize` | `string \| null` | No | — |
| `keywords` | `string \| null` | No | — |
| `lastModified` | `string \| null` | No | — |
| `lastModifiedBy` | `string \| null` | No | — |
| `lastPrinted` | `string \| null` | No | — |
| `lines` | `number \| null` | No | — |
| `manager` | `string \| null` | No | — |
| `pages` | `number \| null` | No | — |
| `paragraphs` | `number \| null` | No | — |
| `revisionNumber` | `number \| null` | No | — |
| `status` | `string \| null` | No | — |
| `subject` | `string \| null` | No | — |
| `template` | `string \| null` | No | — |
| `title` | `string \| null` | No | — |
| `totalEditingTime` | `number \| null` | No | — |
| `words` | `number \| null` | No | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

***

### wordInsertText

`word.wordInsertText`

Word - Insert Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordInsertText({"body":{"elementType":"Any","fileContent":"AA==","fileName":"x","insertAs":"New","instance":0,"instances":"All","searchBy":"Element","text":"x","textPlacement":"Append"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   searchBy: Element | Text,
>   fileName: string,
>   fileContent: string,
>   text: string,
>   textPlacement: Append | Prepend,
>   insertAs: New | Existing,
>   searchText?: string,
>   isExpression?: boolean,
>   elementType: Any | Paragraph | Heading | Subheading | Title | Subtitle | Bookmark | StructuredDocumentTag | ActiveXControl | Image | Table | Field | Header | Footer | Footnote | Endnote | Comment | Section | Text,
>   instances: All | First | Last | Specific,
>   instance: number,
>   startPage?: number,
>   endPage?: number,
>   pageNumbers?: string,
>   insertTextStyle?: {
>     font?: string,
>     fontColour?: Inherit | None | AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>     fontSize?: number,
>     styleBackgroundColour?: Inherit | None | AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>     styleBold?: Inherit | Apply | Remove,
>     styleItalic?: Inherit | Apply | Remove,
>     styleDoubleStrikethrough?: Inherit | Apply | Remove,
>     styleStrikethrough?: Inherit | Apply | Remove,
>     styleSubscript?: Inherit | Apply | Remove,
>     styleSuperscript?: Inherit | Apply | Remove,
>     styleUnderline?: Inherit | None | Dash | DashHeavy | DashLong | DashLongHeavy | DotDash | DotDashHeavy | DotDotDash | DotDotDashHeavy | Dotted | DottedHeavy | Double | Single | Thick | Wavy | WavyDouble | WavyHeavy | Words,
>     wordSpacing?: number
>   }
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   searchElementType?: Element | Text
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### wordReplaceTextWithImage

`word.wordReplaceTextWithImage`

Word - Replace Text With Image

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordReplaceTextWithImage({"body":{"FileContent":"AA==","FileName":"x","imageFileContent":"AA==","SearchText":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   FileName: string,
>   FileContent: string,
>   SearchText: string,
>   imageFileContent: string,
>   skipFirstPage?: boolean,
>   applyTo?: First | All | Last | Specific,
>   pageNumbers?: string,
>   pageNumbersIgnore?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### wordSearchAndReplaceText

`word.wordSearchAndReplaceText`

Word - Replace Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordSearchAndReplaceText({"body":{"fileName":"x","phrases":[]}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent?: string,
>   phrases: {
>     searchText: string,
>     isExpression?: boolean,
>     replacementText?: string,
>     findWholeWordsOnly?: boolean,
>     caseSensitive?: boolean,
>     font?: string,
>     fontColour?: Inherit | AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>     fontSize?: number,
>     styleBackgroundColour?: Inherit | AliceBlue | AntiqueWhite | Aqua | Aquamarine | Azure | Beige | Bisque | Black | BlanchedAlmond | Blue | BlueViolet | Brown | BurlyWood | CadetBlue | Chartreuse | Chocolate | Coral | CornflowerBlue | Cornsilk | Crimson | Cyan | DarkBlue | DarkCyan | DarkGoldenrod | DarkGray | DarkGreen | DarkKhaki | DarkMagenta | DarkOliveGreen | DarkOrange | DarkOrchid | DarkRed | DarkSalmon | DarkSeaGreen | DarkSlateBlue | DarkSlateGray | DarkTurquoise | DarkViolet | DeepPink | DeepSkyBlue | DimGray | DodgerBlue | Firebrick | FloralWhite | ForestGreen | Fuchsia | Gainsboro | GhostWhite | Gold | Goldenrod | Gray | Green | GreenYellow | Honeydew | HotPink | IndianRed | Indigo | Ivory | Khaki | Lavender | LavenderBlush | LawnGreen | LemonChiffon | LightBlue | LightCoral | LightCyan | LightGoldenrodYellow | LightGray | LightGreen | LightPink | LightSalmon | LightSeaGreen | LightSkyBlue | LightSlateGray | LightSteelBlue | LightYellow | Lime | LimeGreen | Linen | Magenta | Maroon | MediumAquamarine | MediumBlue | MediumOrchid | MediumPurple | MediumSeaGreen | MediumSlateBlue | MediumSpringGreen | MediumTurquoise | MediumVioletRed | MidnightBlue | MintCream | MistyRose | Moccasin | NavajoWhite | Navy | OldLace | Olive | OliveDrab | Orange | OrangeRed | Orchid | PaleGoldenrod | PaleGreen | PaleTurquoise | PaleVioletRed | PapayaWhip | PeachPuff | Peru | Pink | Plum | PowderBlue | Purple | Red | RosyBrown | RoyalBlue | SaddleBrown | Salmon | SandyBrown | SeaGreen | SeaShell | Sienna | Silver | SkyBlue | SlateBlue | SlateGray | Snow | SpringGreen | SteelBlue | Tan | Teal | Thistle | Tomato | Transparent | Turquoise | Violet | Wheat | White | WhiteSmoke | Yellow | YellowGreen,
>     styleBold?: Inherit | Apply | Remove,
>     styleItalic?: Inherit | Apply | Remove,
>     styleStrikethrough?: Inherit | Apply | Remove,
>     styleDoubleStrikethrough?: Inherit | Apply | Remove,
>     styleSubscript?: Inherit | Apply | Remove,
>     styleSuperscript?: Inherit | Apply | Remove,
>     styleUnderline?: Inherit | None | Dash | DashHeavy | DashLong | DashLongHeavy | DotDash | DotDashHeavy | DotDotDash | DotDotDashHeavy | Dotted | DottedHeavy | Double | Single | Thick | Wavy | WavyDouble | WavyHeavy | Words,
>     wordSpacing?: number
>   }[],
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### wordSetMetadata

`word.wordSetMetadata`

Word - Set Metadata

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordSetMetadata({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   author?: string,
>   category?: string,
>   comments?: string,
>   company?: string,
>   created?: string,
>   hyperlinkBase?: string,
>   keywords?: string,
>   lastModified?: string,
>   lastModifiedBy?: string,
>   lastPrinted?: string,
>   manager?: string,
>   revisionNumber?: number,
>   status?: string,
>   subject?: string,
>   title?: string,
>   totalEditingTime?: number,
>   customProperties?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***

### wordSplitByText

`word.wordSplitByText`

Word - Split by Text

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordSplitByText({"body":{"fileContent":"AA==","fileName":"x","splitAction":"SplitOn","splitValue":"x","wordSplitByTextType":"All"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   splitValue: string,
>   isExpression?: boolean,
>   prefixFilename?: boolean,
>   wordSplitByTextType: All | First | Last,
>   splitAction: SplitOn | SplitAfter | SplitBefore | Remove,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `documents` | `object[]` | Yes | — |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   fileName?: string | null,
>   fileContent?: string | null
> }[]
> ```

***

### wordUnlock

`word.wordUnlock`

Word - Unlock

**Risk:** `destructive`

```ts theme={null}
await corsair.encodian.api.word.wordUnlock({"body":{"fileContent":"AA==","fileName":"x"}});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `object` | Yes | — |

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileName: string,
>   fileContent: string,
>   password?: string,
>   secureOnOpenPassword?: string,
>   cultureName?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `HttpStatusCode` | `number \| null` | No | — |
| `HttpStatusMessage` | `string \| null` | No | — |
| `OperationId` | `string \| null` | No | — |
| `Errors` | `string[] \| null` | No | — |
| `OperationStatus` | `string \| null` | No | — |
| `Filename` | `string \| null` | No | — |
| `FileContent` | `string \| null` | No | — |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.