diff --git a/.oas-version b/.oas-version index 18b3114..1cac385 100644 --- a/.oas-version +++ b/.oas-version @@ -1 +1 @@ -1.10.4 +1.11.0 diff --git a/shotstack_sdk/__init__.py b/shotstack_sdk/__init__.py index 21a63c1..1ebe737 100644 --- a/shotstack_sdk/__init__.py +++ b/shotstack_sdk/__init__.py @@ -11,7 +11,7 @@ """ -__version__ = "1.10.4" +__version__ = "1.11.0" # import ApiClient from shotstack_sdk.api_client import ApiClient diff --git a/shotstack_sdk/api_client.py b/shotstack_sdk/api_client.py index 952fdb0..5bf6462 100644 --- a/shotstack_sdk/api_client.py +++ b/shotstack_sdk/api_client.py @@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/1.10.4/python' + self.user_agent = 'OpenAPI-Generator/1.11.0/python' def __enter__(self): return self diff --git a/shotstack_sdk/configuration.py b/shotstack_sdk/configuration.py index 120b8b3..c8953c1 100644 --- a/shotstack_sdk/configuration.py +++ b/shotstack_sdk/configuration.py @@ -410,7 +410,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: v1\n"\ - "SDK Package Version: 1.10.4".\ + "SDK Package Version: 1.11.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/shotstack_sdk/model/asset.py b/shotstack_sdk/model/asset.py index 13eb10b..132f2db 100644 --- a/shotstack_sdk/model/asset.py +++ b/shotstack_sdk/model/asset.py @@ -38,6 +38,7 @@ def lazy_import(): CaptionMargin ChromaKey Crop + Html5Asset HtmlAsset ImageAsset ImageToVideoAsset @@ -101,6 +102,7 @@ class Asset(ModelComposed): ''caption'': 'caption', ''rich-caption'': 'rich-caption', ''html'': 'html', + ''html5'': 'html5', ''title'': 'title', ''shape'': 'shape', ''svg'': 'svg', @@ -226,6 +228,7 @@ def openapi_types(): 'active': (RichCaptionActive,), # noqa: E501 'css': (str,), # noqa: E501 'position': (str,), # noqa: E501 + 'js': (str,), # noqa: E501 'color': (str,), # noqa: E501 'size': (str,), # noqa: E501 'offset': (Offset,), # noqa: E501 @@ -245,6 +248,7 @@ def discriminator(): 'audio': AudioAsset, 'caption': CaptionAsset, 'html': HtmlAsset, + 'html5': Html5Asset, 'image': ImageAsset, 'image-to-video': ImageToVideoAsset, 'luma': LumaAsset, @@ -259,6 +263,7 @@ def discriminator(): 'video': VideoAsset, 'AudioAsset': AudioAsset, 'CaptionAsset': CaptionAsset, + 'Html5Asset': Html5Asset, 'HtmlAsset': HtmlAsset, 'ImageAsset': ImageAsset, 'ImageToVideoAsset': ImageToVideoAsset, @@ -310,6 +315,7 @@ def discriminator(): 'active': 'active', # noqa: E501 'css': 'css', # noqa: E501 'position': 'position', # noqa: E501 + 'js': 'js', # noqa: E501 'color': 'color', # noqa: E501 'size': 'size', # noqa: E501 'offset': 'offset', # noqa: E501 @@ -331,10 +337,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """Asset - a model defined in OpenAPI Keyword Args: - type (str): The type of asset - set to `video` for videos.. defaults to 'video', must be one of ['video', 'image', 'text', 'rich-text', 'audio', 'luma', 'caption', 'rich-caption', 'html', 'title', 'shape', 'svg', 'text-to-image', 'image-to-video', 'text-to-speech', ] # noqa: E501 + type (str): The type of asset - set to `video` for videos.. defaults to 'video', must be one of ['video', 'image', 'text', 'rich-text', 'audio', 'luma', 'caption', 'rich-caption', 'html', 'html5', 'title', 'shape', 'svg', 'text-to-image', 'image-to-video', 'text-to-speech', ] # noqa: E501 src (str): The image source URL. The URL must be publicly accessible or include credentials. text (str): The text to convert to speech. - html (str): The HTML text string. See list of [supported HTML tags](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-html-tags). + html (str): The HTML markup for the asset. shape (str): The shape to display. prompt (str): The instructions for modifying the image into a video sequence. voice (str): The voice to use for the text-to-speech conversion. @@ -391,8 +397,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 effect (str): The effect to apply to the audio asset . [optional] # noqa: E501 margin (CaptionMargin): [optional] # noqa: E501 active (RichCaptionActive): [optional] # noqa: E501 - css (str): The CSS text string to apply styling to the HTML. See list of [support CSS properties](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-css-properties).. [optional] # noqa: E501 + css (str): The CSS string applied to the HTML.. [optional] # noqa: E501 position (str): Place the title in one of nine predefined positions of the viewport. . [optional] # noqa: E501 + js (str): Optional JavaScript. Use for chart libraries, animations, or DOM manipulation. `gsap`, `d3`, `anime` and `lottie` are always available. CSS animations, transitions, and `Element.animate()` are also captured automatically. . [optional] # noqa: E501 color (str): Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.. [optional] # noqa: E501 size (str): Set the relative size of the text using predefined sizes from xx-small to xx-large. . [optional] # noqa: E501 offset (Offset): [optional] # noqa: E501 @@ -473,10 +480,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 """Asset - a model defined in OpenAPI Keyword Args: - type (str): The type of asset - set to `video` for videos.. defaults to 'video', must be one of ['video', 'image', 'text', 'rich-text', 'audio', 'luma', 'caption', 'rich-caption', 'html', 'title', 'shape', 'svg', 'text-to-image', 'image-to-video', 'text-to-speech', ] # noqa: E501 + type (str): The type of asset - set to `video` for videos.. defaults to 'video', must be one of ['video', 'image', 'text', 'rich-text', 'audio', 'luma', 'caption', 'rich-caption', 'html', 'html5', 'title', 'shape', 'svg', 'text-to-image', 'image-to-video', 'text-to-speech', ] # noqa: E501 src (str): The image source URL. The URL must be publicly accessible or include credentials. text (str): The text to convert to speech. - html (str): The HTML text string. See list of [supported HTML tags](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-html-tags). + html (str): The HTML markup for the asset. shape (str): The shape to display. prompt (str): The instructions for modifying the image into a video sequence. voice (str): The voice to use for the text-to-speech conversion. @@ -533,8 +540,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 effect (str): The effect to apply to the audio asset . [optional] # noqa: E501 margin (CaptionMargin): [optional] # noqa: E501 active (RichCaptionActive): [optional] # noqa: E501 - css (str): The CSS text string to apply styling to the HTML. See list of [support CSS properties](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-css-properties).. [optional] # noqa: E501 + css (str): The CSS string applied to the HTML.. [optional] # noqa: E501 position (str): Place the title in one of nine predefined positions of the viewport. . [optional] # noqa: E501 + js (str): Optional JavaScript. Use for chart libraries, animations, or DOM manipulation. `gsap`, `d3`, `anime` and `lottie` are always available. CSS animations, transitions, and `Element.animate()` are also captured automatically. . [optional] # noqa: E501 color (str): Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.. [optional] # noqa: E501 size (str): Set the relative size of the text using predefined sizes from xx-small to xx-large. . [optional] # noqa: E501 offset (Offset): [optional] # noqa: E501 @@ -615,6 +623,7 @@ def _composed_schemas(): 'oneOf': [ AudioAsset, CaptionAsset, + Html5Asset, HtmlAsset, ImageAsset, ImageToVideoAsset, diff --git a/shotstack_sdk/model/html5_asset.py b/shotstack_sdk/model/html5_asset.py new file mode 100644 index 0000000..ee29361 --- /dev/null +++ b/shotstack_sdk/model/html5_asset.py @@ -0,0 +1,275 @@ +""" + Shotstack + + Official Python SDK for the Shotstack Cloud Video Editing API + + The version of the OpenAPI document: v1 + Contact: pypi@shotstack.io + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from shotstack_sdk.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from shotstack_sdk.exceptions import ApiAttributeError + + + +class Html5Asset(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + ''html5'': 'html5', + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'type': (str,), # noqa: E501 + 'html': (str,), # noqa: E501 + 'css': (str,), # noqa: E501 + 'js': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'html': 'html', # noqa: E501 + 'css': 'css', # noqa: E501 + 'js': 'js', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, html, *args, **kwargs): # noqa: E501 + """Html5Asset - a model defined in OpenAPI + + Args: + html (str): The HTML markup for the asset. + + Keyword Args: + type (str): The type of asset - set to `html5` for HTML5/CSS3/JS.. defaults to 'html5', must be one of ['html5', ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + css (str): The CSS string applied to the HTML.. [optional] # noqa: E501 + js (str): Optional JavaScript. Use for chart libraries, animations, or DOM manipulation. `gsap`, `d3`, `anime` and `lottie` are always available. CSS animations, transitions, and `Element.animate()` are also captured automatically. . [optional] # noqa: E501 + """ + + type = kwargs.get('type', 'html5') + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + self.html = html + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, html, *args, **kwargs): # noqa: E501 + """Html5Asset - a model defined in OpenAPI + + Args: + html (str): The HTML markup for the asset. + + Keyword Args: + type (str): The type of asset - set to `html5` for HTML5/CSS3/JS.. defaults to 'html5', must be one of ['html5', ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + css (str): The CSS string applied to the HTML.. [optional] # noqa: E501 + js (str): Optional JavaScript. Use for chart libraries, animations, or DOM manipulation. `gsap`, `d3`, `anime` and `lottie` are always available. CSS animations, transitions, and `Element.animate()` are also captured automatically. . [optional] # noqa: E501 + """ + + type = kwargs.get('type', 'html5') + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + self.html = html + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/shotstack_sdk/model/rich_caption_asset.py b/shotstack_sdk/model/rich_caption_asset.py index 40fe07e..ff41834 100644 --- a/shotstack_sdk/model/rich_caption_asset.py +++ b/shotstack_sdk/model/rich_caption_asset.py @@ -140,7 +140,7 @@ def _from_openapi_data(cls, src, *args, **kwargs): # noqa: E501 """RichCaptionAsset - a model defined in OpenAPI Args: - src (str): The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip. + src (str): Source for the caption words. Accepts three formats: (1) the URL to a subtitle file (`.srt`, `.vtt`, `.ttml`, or `.dfxp`) which is parsed directly; (2) the URL to an audio or video media file (`.mp4`, `.mov`, `.webm`, `.mp3`, `.wav`, `.m4a`, `.flac`, `.aac`, `.ogg`, and related formats) which is auto-transcribed; (3) an alias reference in the form `alias://clip-name` where `clip-name` is the alias of another audio, video, or text-to-speech clip in the same timeline — the referenced clip's source is auto-transcribed. For file URLs, the URL must be publicly accessible or include credentials. Content is classified at runtime and unsupported content types (HTML, PDF, images, archives) are rejected with a structured error. Keyword Args: type (str): The type of asset - set to `rich-caption` for rich captions.. defaults to 'rich-caption', must be one of ['rich-caption', ] # noqa: E501 @@ -238,7 +238,7 @@ def __init__(self, src, *args, **kwargs): # noqa: E501 """RichCaptionAsset - a model defined in OpenAPI Args: - src (str): The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip. + src (str): Source for the caption words. Accepts three formats: (1) the URL to a subtitle file (`.srt`, `.vtt`, `.ttml`, or `.dfxp`) which is parsed directly; (2) the URL to an audio or video media file (`.mp4`, `.mov`, `.webm`, `.mp3`, `.wav`, `.m4a`, `.flac`, `.aac`, `.ogg`, and related formats) which is auto-transcribed; (3) an alias reference in the form `alias://clip-name` where `clip-name` is the alias of another audio, video, or text-to-speech clip in the same timeline — the referenced clip's source is auto-transcribed. For file URLs, the URL must be publicly accessible or include credentials. Content is classified at runtime and unsupported content types (HTML, PDF, images, archives) are rejected with a structured error. Keyword Args: type (str): The type of asset - set to `rich-caption` for rich captions.. defaults to 'rich-caption', must be one of ['rich-caption', ] # noqa: E501 diff --git a/shotstack_sdk/model/rich_text_background.py b/shotstack_sdk/model/rich_text_background.py index 8c650bd..75ab1da 100644 --- a/shotstack_sdk/model/rich_text_background.py +++ b/shotstack_sdk/model/rich_text_background.py @@ -91,6 +91,7 @@ def openapi_types(): 'color': (str,), # noqa: E501 'opacity': (float,), # noqa: E501 'border_radius': (float,), # noqa: E501 + 'wrap': (bool,), # noqa: E501 } @cached_property @@ -102,6 +103,7 @@ def discriminator(): 'color': 'color', # noqa: E501 'opacity': 'opacity', # noqa: E501 'border_radius': 'borderRadius', # noqa: E501 + 'wrap': 'wrap', # noqa: E501 } read_only_vars = { @@ -148,6 +150,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 color (str): The background color using hexadecimal color notation.. [optional] # noqa: E501 opacity (float): The opacity of the background where 1 is opaque and 0 is transparent.. [optional] if omitted the server will use the default value of 1 # noqa: E501 border_radius (float): The border radius of the background box in pixels. Must be 0 or greater.. [optional] if omitted the server will use the default value of 0 # noqa: E501 + wrap (bool): When true, the background pill shrinks to fit the rendered text bounding box plus the asset's padding (and stroke width, if present), producing a pill or badge effect. When false (default), the background fills the full asset content area. Available on rich-text and rich-caption assets only; not supported on legacy `type: text`. . [optional] if omitted the server will use the default value of False # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -232,6 +235,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 color (str): The background color using hexadecimal color notation.. [optional] # noqa: E501 opacity (float): The opacity of the background where 1 is opaque and 0 is transparent.. [optional] if omitted the server will use the default value of 1 # noqa: E501 border_radius (float): The border radius of the background box in pixels. Must be 0 or greater.. [optional] if omitted the server will use the default value of 0 # noqa: E501 + wrap (bool): When true, the background pill shrinks to fit the rendered text bounding box plus the asset's padding (and stroke width, if present), producing a pill or badge effect. When false (default), the background fills the full asset content area. Available on rich-text and rich-caption assets only; not supported on legacy `type: text`. . [optional] if omitted the server will use the default value of False # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/shotstack_sdk/model/text_background.py b/shotstack_sdk/model/text_background.py index 28cfae0..9d3d35f 100644 --- a/shotstack_sdk/model/text_background.py +++ b/shotstack_sdk/model/text_background.py @@ -96,6 +96,7 @@ def openapi_types(): 'opacity': (float,), # noqa: E501 'padding': (float,), # noqa: E501 'border_radius': (float,), # noqa: E501 + 'wrap': (bool,), # noqa: E501 } @cached_property @@ -108,6 +109,7 @@ def discriminator(): 'opacity': 'opacity', # noqa: E501 'padding': 'padding', # noqa: E501 'border_radius': 'borderRadius', # noqa: E501 + 'wrap': 'wrap', # noqa: E501 } read_only_vars = { @@ -155,6 +157,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 opacity (float): The opacity of the background where 1 is opaque and 0 is transparent.. [optional] # noqa: E501 padding (float): Padding inside the background box in pixels.. [optional] # noqa: E501 border_radius (float): The border radius of the background box in pixels for rounded corners.. [optional] # noqa: E501 + wrap (bool): Not supported on legacy `text` assets. Accepted here only so validators can emit a clear migration error pointing users to `rich-text` or `rich-caption`, which support background wrapping natively.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -240,6 +243,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 opacity (float): The opacity of the background where 1 is opaque and 0 is transparent.. [optional] # noqa: E501 padding (float): Padding inside the background box in pixels.. [optional] # noqa: E501 border_radius (float): The border radius of the background box in pixels for rounded corners.. [optional] # noqa: E501 + wrap (bool): Not supported on legacy `text` assets. Accepted here only so validators can emit a clear migration error pointing users to `rich-text` or `rich-caption`, which support background wrapping natively.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True)