:py:mod:`vendor_fabric.base`
============================

.. py:module:: vendor_fabric.base

.. autodoc2-docstring:: vendor_fabric.base
   :parser: myst
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ConnectorBase <vendor_fabric.base.ConnectorBase>`
     - .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase
          :parser: myst
          :summary:

API
~~~

.. py:exception:: RateLimitError()
   :canonical: vendor_fabric.base.RateLimitError

   Bases: :py:obj:`Exception`

   .. autodoc2-docstring:: vendor_fabric.base.RateLimitError
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.base.RateLimitError.__init__
      :parser: myst

   .. py:method:: add_note()
      :canonical: vendor_fabric.base.RateLimitError.add_note

   .. py:class:: args
      :canonical: vendor_fabric.base.RateLimitError.args

   .. py:method:: with_traceback()
      :canonical: vendor_fabric.base.RateLimitError.with_traceback

.. py:exception:: ConnectorAPIError(message: str, status_code: int | None = None)
   :canonical: vendor_fabric.base.ConnectorAPIError

   Bases: :py:obj:`Exception`

   .. autodoc2-docstring:: vendor_fabric.base.ConnectorAPIError
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.base.ConnectorAPIError.__init__
      :parser: myst

   .. py:method:: add_note()
      :canonical: vendor_fabric.base.ConnectorAPIError.add_note

   .. py:class:: args
      :canonical: vendor_fabric.base.ConnectorAPIError.args

   .. py:method:: with_traceback()
      :canonical: vendor_fabric.base.ConnectorAPIError.with_traceback

.. py:class:: ConnectorBase(api_key: str | None = None, base_url: str | None = None, timeout: float | None = None, logger: extended_data.logging.Logging | None = None, **kwargs: typing.Any)
   :canonical: vendor_fabric.base.ConnectorBase

   Bases: :py:obj:`vendor_fabric.capabilities.CapabilityProviderMixin`, :py:obj:`extended_data.inputs.InputProvider`, :py:obj:`abc.ABC`

   .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.__init__
      :parser: myst

   .. py:attribute:: BASE_URL
      :canonical: vendor_fabric.base.ConnectorBase.BASE_URL
      :type: typing.ClassVar[str]
      :value: <Multiline-String>

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.BASE_URL
         :parser: myst

   .. py:attribute:: API_KEY_ENV
      :canonical: vendor_fabric.base.ConnectorBase.API_KEY_ENV
      :type: typing.ClassVar[str]
      :value: <Multiline-String>

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.API_KEY_ENV
         :parser: myst

   .. py:attribute:: CONNECTOR_CATEGORY
      :canonical: vendor_fabric.base.ConnectorBase.CONNECTOR_CATEGORY
      :type: typing.ClassVar[str]
      :value: 'external'

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.CONNECTOR_CATEGORY
         :parser: myst

   .. py:attribute:: CONNECTOR_CAPABILITIES
      :canonical: vendor_fabric.base.ConnectorBase.CONNECTOR_CAPABILITIES
      :type: typing.ClassVar[tuple[str, ...]]
      :value: ()

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.CONNECTOR_CAPABILITIES
         :parser: myst

   .. py:attribute:: TIMEOUT
      :canonical: vendor_fabric.base.ConnectorBase.TIMEOUT
      :type: typing.ClassVar[float]
      :value: 300.0

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.TIMEOUT
         :parser: myst

   .. py:attribute:: MIN_REQUEST_INTERVAL
      :canonical: vendor_fabric.base.ConnectorBase.MIN_REQUEST_INTERVAL
      :type: typing.ClassVar[float]
      :value: 0.0

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.MIN_REQUEST_INTERVAL
         :parser: myst

   .. py:attribute:: MAX_RETRIES
      :canonical: vendor_fabric.base.ConnectorBase.MAX_RETRIES
      :type: typing.ClassVar[int]
      :value: 5

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.MAX_RETRIES
         :parser: myst

   .. py:property:: api_key
      :canonical: vendor_fabric.base.ConnectorBase.api_key
      :type: str

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.api_key
         :parser: myst

   .. py:property:: client
      :canonical: vendor_fabric.base.ConnectorBase.client
      :type: httpx.Client

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.client
         :parser: myst

   .. py:method:: close() -> None
      :canonical: vendor_fabric.base.ConnectorBase.close

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.close
         :parser: myst

   .. py:method:: request(method: str, endpoint: str, *, headers: dict[str, str] | None = None, **kwargs: typing.Any) -> httpx.Response
      :canonical: vendor_fabric.base.ConnectorBase.request

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.request
         :parser: myst

   .. py:method:: decode_response(response: httpx.Response, *, suffix: str | None = None, as_extended: bool = True) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.decode_response

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.decode_response
         :parser: myst

   .. py:method:: decode_response_file(response: httpx.Response, *, source: str | None = None, suffix: str | None = None, as_extended: bool = True, metadata: collections.abc.Mapping[str, typing.Any] | None = None) -> extended_data.io.DataFile
      :canonical: vendor_fabric.base.ConnectorBase.decode_response_file

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.decode_response_file
         :parser: myst

   .. py:method:: extend_result(value: typing.Any) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.extend_result

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.extend_result
         :parser: myst

   .. py:method:: request_data(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.request_data

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.request_data
         :parser: myst

   .. py:method:: request_data_file(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.io.DataFile
      :canonical: vendor_fabric.base.ConnectorBase.request_data_file

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.request_data_file
         :parser: myst

   .. py:method:: request_workflow(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow
      :canonical: vendor_fabric.base.ConnectorBase.request_workflow

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.request_workflow
         :parser: myst

   .. py:method:: get(endpoint: str, **kwargs: typing.Any) -> httpx.Response
      :canonical: vendor_fabric.base.ConnectorBase.get

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.get
         :parser: myst

   .. py:method:: get_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.get_data

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.get_data
         :parser: myst

   .. py:method:: get_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow
      :canonical: vendor_fabric.base.ConnectorBase.get_workflow

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.get_workflow
         :parser: myst

   .. py:method:: post(endpoint: str, **kwargs: typing.Any) -> httpx.Response
      :canonical: vendor_fabric.base.ConnectorBase.post

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.post
         :parser: myst

   .. py:method:: post_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.post_data

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.post_data
         :parser: myst

   .. py:method:: post_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow
      :canonical: vendor_fabric.base.ConnectorBase.post_workflow

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.post_workflow
         :parser: myst

   .. py:method:: put(endpoint: str, **kwargs: typing.Any) -> httpx.Response
      :canonical: vendor_fabric.base.ConnectorBase.put

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.put
         :parser: myst

   .. py:method:: put_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.put_data

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.put_data
         :parser: myst

   .. py:method:: put_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow
      :canonical: vendor_fabric.base.ConnectorBase.put_workflow

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.put_workflow
         :parser: myst

   .. py:method:: delete(endpoint: str, **kwargs: typing.Any) -> httpx.Response
      :canonical: vendor_fabric.base.ConnectorBase.delete

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.delete
         :parser: myst

   .. py:method:: delete_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.delete_data

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.delete_data
         :parser: myst

   .. py:method:: delete_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow
      :canonical: vendor_fabric.base.ConnectorBase.delete_workflow

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.delete_workflow
         :parser: myst

   .. py:method:: patch(endpoint: str, **kwargs: typing.Any) -> httpx.Response
      :canonical: vendor_fabric.base.ConnectorBase.patch

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.patch
         :parser: myst

   .. py:method:: patch_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.patch_data

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.patch_data
         :parser: myst

   .. py:method:: patch_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow
      :canonical: vendor_fabric.base.ConnectorBase.patch_workflow

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.patch_workflow
         :parser: myst

   .. py:method:: download(url: str, output_path: str) -> int
      :canonical: vendor_fabric.base.ConnectorBase.download

      .. autodoc2-docstring:: vendor_fabric.base.ConnectorBase.download
         :parser: myst

   .. py:attribute:: vendor_capabilities
      :canonical: vendor_fabric.base.ConnectorBase.vendor_capabilities
      :type: typing.ClassVar[dict[str, vendor_fabric.capabilities.CapabilitySpec]]
      :value: None

   .. py:attribute:: vendor_capability_methods
      :canonical: vendor_fabric.base.ConnectorBase.vendor_capability_methods
      :type: typing.ClassVar[dict[str, str]]
      :value: None

   .. py:method:: get_input(k: str, default: typing.Any | None = None, required: bool = False, is_bool: bool = False, is_integer: bool = False, is_float: bool = False, is_path: bool = False, is_datetime: bool = False, as_extended: bool = False) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.get_input

   .. py:method:: decode_input(k: str, default: typing.Any | None = None, required: bool = False, decode_from_json: bool = False, decode_from_yaml: bool = False, decode_from_base64: bool = False, allow_none: bool = True, as_extended: bool = False) -> typing.Any
      :canonical: vendor_fabric.base.ConnectorBase.decode_input

   .. py:method:: freeze_inputs() -> extended_data.containers.mappings.ExtendedDict
      :canonical: vendor_fabric.base.ConnectorBase.freeze_inputs

   .. py:method:: thaw_inputs() -> extended_data.containers.mappings.ExtendedDict
      :canonical: vendor_fabric.base.ConnectorBase.thaw_inputs

   .. py:method:: snapshot_inputs(*, frozen: bool = False) -> extended_data.containers.mappings.ExtendedDict
      :canonical: vendor_fabric.base.ConnectorBase.snapshot_inputs

   .. py:method:: replace_inputs(new_inputs: collections.abc.Mapping[str, typing.Any] | None, *, clear_frozen: bool = True) -> extended_data.containers.mappings.ExtendedDict
      :canonical: vendor_fabric.base.ConnectorBase.replace_inputs

   .. py:method:: merge_inputs(new_inputs: collections.abc.Mapping[str, typing.Any] | None) -> extended_data.containers.mappings.ExtendedDict
      :canonical: vendor_fabric.base.ConnectorBase.merge_inputs

   .. py:method:: shift_inputs() -> extended_data.containers.mappings.ExtendedDict
      :canonical: vendor_fabric.base.ConnectorBase.shift_inputs