Skip to content

WrapOptions

Source code in docs_src/capo_b2bi/types/wrap_options.py 
15
16
17
18
19
20
21
class WrapOptions(TypedDict, closed=True):
    wrap_by: "capo_b2bi.types.wrap_format.WrapFormat"
    """<p>Specifies the method used for wrapping lines in the EDI output. Valid values:</p> <ul> <li> <p> <code>SEGMENT</code>: Wraps by segment.</p> </li> <li> <p> <code>ONE_LINE</code>: Indicates that the entire content is on a single line.</p> <note> <p>When you specify <code>ONE_LINE</code>, do not provide either the line length nor the line terminator value.</p> </note> </li> <li> <p> <code>LINE_LENGTH</code>: Wraps by character count, as specified by <code>lineLength</code> value.</p> </li> </ul>"""
    line_terminator: NotRequired["capo_b2bi.types.line_terminator.LineTerminator"]
    """<p>Specifies the character sequence used to terminate lines when wrapping. Valid values:</p> <ul> <li> <p> <code>CRLF</code>: carriage return and line feed</p> </li> <li> <p> <code>LF</code>: line feed)</p> </li> <li> <p> <code>CR</code>: carriage return</p> </li> </ul>"""
    line_length: NotRequired["capo_b2bi.types.line_length.LineLength"]
    """<p>Specifies the maximum length of a line before wrapping occurs. This value is used when <code>wrapBy</code> is set to <code>LINE_LENGTH</code>.</p>"""

line_length instance-attribute 

line_length: NotRequired[LineLength]

Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

line_terminator instance-attribute 

line_terminator: NotRequired[LineTerminator]

Specifies the character sequence used to terminate lines when wrapping. Valid values:

  • CRLF: carriage return and line feed

  • LF: line feed)

  • CR: carriage return

wrap_by instance-attribute 

wrap_by: WrapFormat

Specifies the method used for wrapping lines in the EDI output. Valid values:

  • SEGMENT: Wraps by segment.

  • ONE_LINE: Indicates that the entire content is on a single line.

    When you specify ONE_LINE, do not provide either the line length nor the line terminator value.

  • LINE_LENGTH: Wraps by character count, as specified by lineLength value.