Skip to content

Hive.cookbook.reason for closure

ReasonForClosure

Bases: ApiManager

Class that handles all the XAutomata reason_for_closure APIs

Source code in hive/cookbook/reason_for_closure.py
class ReasonForClosure(ApiManager):
    """Class that handles all the XAutomata reason_for_closure APIs"""

    def reason_for_closure(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Read Reason For Closure

        Args:
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
            null_fields (string optional): additional filter - parameter
            code (string optional): additional filter - parameter
            description (string optional): additional filter - parameter
            jurisdiction (string optional): additional filter - parameter
            skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
            limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
            like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
            count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['sort_by', 'null_fields', 'code',
            'description', 'jurisdiction', 'skip', 'limit', 'like', 'join',
            'count']
        params.get('sort_by'), params.get('null_fields'), params.get('code'
            ), params.get('description'), params.get('jurisdiction'
            ), params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.reason_for_closure.__name__,
                params, official_params_list)
        response = self.execute('GET', path=f'/reason_for_closure/',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def reason_for_closure_create(self, kwargs: dict = None, **payload
        ) -> list:
        """Create Reason For Closure

        Args:
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **payload: additional parameters for the API.

        Keyword Args:
            code (string required): additional filter - payload
            description (string optional): additional filter - payload
            jurisdiction (string optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['code', 'description', 'jurisdiction']
        payload.get('code'), payload.get('description'), payload.get(
            'jurisdiction')
        if not self._silence_warning:
            warning_wrong_parameters(self.reason_for_closure_create.
                __name__, payload, official_payload_list)
        response = self.execute('POST', path=f'/reason_for_closure/',
            payload=payload, **kwargs)
        return response

    def reason_for_closure_uuid(self, uuid: str, warm_start: bool = False,
        kwargs: dict = None) -> list:
        """Read Reason For Closure

        Args:
            uuid (str, required): uuid
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('GET', path=f'/reason_for_closure/{uuid}',
            warm_start=warm_start, **kwargs)
        return response

    def reason_for_closure_put(self, uuid: str, kwargs: dict = None, **payload
        ) -> list:
        """Update Reason For Closure

        Args:
            uuid (str, required): uuid
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **payload: additional parameters for the API.

        Keyword Args:
            code (string required): additional filter - payload
            description (string optional): additional filter - payload
            jurisdiction (string optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['code', 'description', 'jurisdiction']
        payload.get('code'), payload.get('description'), payload.get(
            'jurisdiction')
        if not self._silence_warning:
            warning_wrong_parameters(self.reason_for_closure_put.__name__,
                payload, official_payload_list)
        response = self.execute('PUT', path=f'/reason_for_closure/{uuid}',
            payload=payload, **kwargs)
        return response

    def reason_for_closure_delete(self, uuid: str, kwargs: dict = None
        ) -> list:
        """Delete Reason For Closure

        Args:
            uuid (str, required): uuid
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('DELETE', path=
            f'/reason_for_closure/{uuid}', **kwargs)
        return response

    def reason_for_closure_bulk(self, payload: list,
        warm_start: bool = False, single_page: bool = False,
        page_size: int = 50, kwargs: dict = None, **params) -> list:
        """Bulk Read Reasons For Closure

        Args:
            payload (list[dict], optional): List dict to create.
            warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

        Examples:
            payload = 
          [
            "uuid": "str", required
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['join']
        params.get('join')
        if not self._silence_warning:
            warning_wrong_parameters(self.reason_for_closure_bulk.__name__,
                params, official_params_list)
        response = self.execute('POST', path=
            f'/reason_for_closure/bulk/read/', single_page=single_page,
            page_size=page_size, warm_start=warm_start, params=params,
            payload=payload, **kwargs)
        return response

    def reason_for_closure_create_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None,
        **params) -> list:
        """Bulk Create Reasons For Closure

        Args:
            payload (list[dict], optional): List dict to create.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
            kwargs (dict, optional): additional parameters for execute. Default to None.
            **params: additional parameters for the API.

        Keyword Args:
            best_effort (boolean optional): additional filter - parameter

        Examples:
            payload = 
          [
           {
            "code": "string", required
            "description": "string", optional
            "jurisdiction": "string", optional
           }
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['best_effort']
        params.get('best_effort')
        if not self._silence_warning:
            warning_wrong_parameters(self.reason_for_closure_create_bulk.
                __name__, params, official_params_list)
        response = self.execute('POST', path=
            f'/reason_for_closure/bulk/create/', single_page=single_page,
            page_size=page_size, params=params, payload=payload, **kwargs)
        return response

    def reason_for_closure_delete_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None
        ) -> list:
        """Bulk Delete Reasons For Closure

        Args:
            payload (list[dict], optional): List dict to create.
            single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
            page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Examples:
            payload = 
          [
            "uuid": "str", required
          ]

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('POST', path=
            f'/reason_for_closure/bulk/delete/', single_page=single_page,
            page_size=page_size, payload=payload, **kwargs)
        return response

reason_for_closure(warm_start=False, single_page=False, page_size=5000, kwargs=None, **params)

Read Reason For Closure

Parameters:

Name Type Description Default
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 5000.

5000
kwargs dict

additional parameters for execute. Default to None.

None
**params

additional parameters for the API.

{}

Other Parameters:

Name Type Description
sort_by string optional

Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter

null_fields string optional

additional filter - parameter

code string optional

additional filter - parameter

description string optional

additional filter - parameter

jurisdiction string optional

additional filter - parameter

skip integer optional

numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter

limit integer optional

numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter

like boolean optional

Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter

join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

count boolean optional

Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

Returns: list

Source code in hive/cookbook/reason_for_closure.py
def reason_for_closure(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Read Reason For Closure

    Args:
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 5000.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        sort_by (string optional): Stringa separata da virgole di campi su cui ordinare. Si indica uno o piu campi della risposta e si puo chiedere di ottenere i valori di quei campi in ordine ascendente o discendente. Esempio "Customer:Desc". Default to "". - parameter
        null_fields (string optional): additional filter - parameter
        code (string optional): additional filter - parameter
        description (string optional): additional filter - parameter
        jurisdiction (string optional): additional filter - parameter
        skip (integer optional): numero di oggetti che si vogliono saltare nella risposta. Default to 0. - parameter
        limit (integer optional): numero di oggetti massimi che si vogliono ottenere. Default to 1_000_000. - parameter
        like (boolean optional): Se True, eventuali filtri richiesti dalla API vengono presi come porzioni di testo, se False il matching sul campo dei filtri deve essere esatto. Default to True. - parameter
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter
        count (boolean optional): Se True nel header della risposta e' presente la dimensione massima a db della chiamata fatta, sconsigliabile perche raddoppia il tempo per chiamata. Default to False. - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['sort_by', 'null_fields', 'code',
        'description', 'jurisdiction', 'skip', 'limit', 'like', 'join',
        'count']
    params.get('sort_by'), params.get('null_fields'), params.get('code'
        ), params.get('description'), params.get('jurisdiction'
        ), params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.reason_for_closure.__name__,
            params, official_params_list)
    response = self.execute('GET', path=f'/reason_for_closure/',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

reason_for_closure_bulk(payload, warm_start=False, single_page=False, page_size=50, kwargs=None, **params)

Bulk Read Reasons For Closure

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

required
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

False
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 50.

50
kwargs dict

additional parameters for execute. Default to None.

None
**params

additional parameters for the API.

{}

Other Parameters:

Name Type Description
join boolean optional

Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

Examples:

payload =

[ "uuid": "str", required ]

Returns: list

Source code in hive/cookbook/reason_for_closure.py
def reason_for_closure_bulk(self, payload: list,
    warm_start: bool = False, single_page: bool = False,
    page_size: int = 50, kwargs: dict = None, **params) -> list:
    """Bulk Read Reasons For Closure

    Args:
        payload (list[dict], optional): List dict to create.
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        join (boolean optional): Se join = true, ogni riga restituita conterra' chiavi aggiuntive che fanno riferimento ad altre entita', con cui la riga ha relazioni 1:1. Default to False - parameter

    Examples:
        payload = 
      [
        "uuid": "str", required
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['join']
    params.get('join')
    if not self._silence_warning:
        warning_wrong_parameters(self.reason_for_closure_bulk.__name__,
            params, official_params_list)
    response = self.execute('POST', path=
        f'/reason_for_closure/bulk/read/', single_page=single_page,
        page_size=page_size, warm_start=warm_start, params=params,
        payload=payload, **kwargs)
    return response

reason_for_closure_create(kwargs=None, **payload)

Create Reason For Closure

Parameters:

Name Type Description Default
kwargs dict

additional parameters for execute. Default to None.

None
**payload

additional parameters for the API.

{}

Other Parameters:

Name Type Description
code string required

additional filter - payload

description string optional

additional filter - payload

jurisdiction string optional

additional filter - payload

Returns: list

Source code in hive/cookbook/reason_for_closure.py
def reason_for_closure_create(self, kwargs: dict = None, **payload
    ) -> list:
    """Create Reason For Closure

    Args:
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **payload: additional parameters for the API.

    Keyword Args:
        code (string required): additional filter - payload
        description (string optional): additional filter - payload
        jurisdiction (string optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['code', 'description', 'jurisdiction']
    payload.get('code'), payload.get('description'), payload.get(
        'jurisdiction')
    if not self._silence_warning:
        warning_wrong_parameters(self.reason_for_closure_create.
            __name__, payload, official_payload_list)
    response = self.execute('POST', path=f'/reason_for_closure/',
        payload=payload, **kwargs)
    return response

reason_for_closure_create_bulk(payload, single_page=False, page_size=50, kwargs=None, **params)

Bulk Create Reasons For Closure

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

required
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 50.

50
kwargs dict

additional parameters for execute. Default to None.

None
**params

additional parameters for the API.

{}

Other Parameters:

Name Type Description
best_effort boolean optional

additional filter - parameter

Examples:

payload =

[ { "code": "string", required "description": "string", optional "jurisdiction": "string", optional } ]

Returns: list

Source code in hive/cookbook/reason_for_closure.py
def reason_for_closure_create_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Create Reasons For Closure

    Args:
        payload (list[dict], optional): List dict to create.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **params: additional parameters for the API.

    Keyword Args:
        best_effort (boolean optional): additional filter - parameter

    Examples:
        payload = 
      [
       {
        "code": "string", required
        "description": "string", optional
        "jurisdiction": "string", optional
       }
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['best_effort']
    params.get('best_effort')
    if not self._silence_warning:
        warning_wrong_parameters(self.reason_for_closure_create_bulk.
            __name__, params, official_params_list)
    response = self.execute('POST', path=
        f'/reason_for_closure/bulk/create/', single_page=single_page,
        page_size=page_size, params=params, payload=payload, **kwargs)
    return response

reason_for_closure_delete(uuid, kwargs=None)

Delete Reason For Closure

Parameters:

Name Type Description Default
uuid (str, required)

uuid

required
kwargs dict

additional parameters for execute. Default to None.

None

Returns: list

Source code in hive/cookbook/reason_for_closure.py
def reason_for_closure_delete(self, uuid: str, kwargs: dict = None
    ) -> list:
    """Delete Reason For Closure

    Args:
        uuid (str, required): uuid
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('DELETE', path=
        f'/reason_for_closure/{uuid}', **kwargs)
    return response

reason_for_closure_delete_bulk(payload, single_page=False, page_size=50, kwargs=None)

Bulk Delete Reasons For Closure

Parameters:

Name Type Description Default
payload list[dict]

List dict to create.

required
single_page bool

se False la risposta viene ottenuta a step per non appesantire le API. Default to False.

False
page_size int

Numero di oggetti per pagina se single_page == False. Default to 50.

50
kwargs dict

additional parameters for execute. Default to None.

None

Examples:

payload =

[ "uuid": "str", required ]

Returns: list

Source code in hive/cookbook/reason_for_closure.py
def reason_for_closure_delete_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None
    ) -> list:
    """Bulk Delete Reasons For Closure

    Args:
        payload (list[dict], optional): List dict to create.
        single_page (bool, optional): se False la risposta viene ottenuta a step per non appesantire le API. Default to False.
        page_size (int, optional): Numero di oggetti per pagina se single_page == False. Default to 50.
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Examples:
        payload = 
      [
        "uuid": "str", required
      ]

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('POST', path=
        f'/reason_for_closure/bulk/delete/', single_page=single_page,
        page_size=page_size, payload=payload, **kwargs)
    return response

reason_for_closure_put(uuid, kwargs=None, **payload)

Update Reason For Closure

Parameters:

Name Type Description Default
uuid (str, required)

uuid

required
kwargs dict

additional parameters for execute. Default to None.

None
**payload

additional parameters for the API.

{}

Other Parameters:

Name Type Description
code string required

additional filter - payload

description string optional

additional filter - payload

jurisdiction string optional

additional filter - payload

Returns: list

Source code in hive/cookbook/reason_for_closure.py
def reason_for_closure_put(self, uuid: str, kwargs: dict = None, **payload
    ) -> list:
    """Update Reason For Closure

    Args:
        uuid (str, required): uuid
        kwargs (dict, optional): additional parameters for execute. Default to None.
        **payload: additional parameters for the API.

    Keyword Args:
        code (string required): additional filter - payload
        description (string optional): additional filter - payload
        jurisdiction (string optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['code', 'description', 'jurisdiction']
    payload.get('code'), payload.get('description'), payload.get(
        'jurisdiction')
    if not self._silence_warning:
        warning_wrong_parameters(self.reason_for_closure_put.__name__,
            payload, official_payload_list)
    response = self.execute('PUT', path=f'/reason_for_closure/{uuid}',
        payload=payload, **kwargs)
    return response

reason_for_closure_uuid(uuid, warm_start=False, kwargs=None)

Read Reason For Closure

Parameters:

Name Type Description Default
uuid (str, required)

uuid

required
warm_start bool

salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.

False
kwargs dict

additional parameters for execute. Default to None.

None

Returns: list

Source code in hive/cookbook/reason_for_closure.py
def reason_for_closure_uuid(self, uuid: str, warm_start: bool = False,
    kwargs: dict = None) -> list:
    """Read Reason For Closure

    Args:
        uuid (str, required): uuid
        warm_start (bool, optional): salva la risposta in un file e se viene richiamata la stessa funzione con gli stessi argomenti restituisce il contenuto del file. Default to False.
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('GET', path=f'/reason_for_closure/{uuid}',
        warm_start=warm_start, **kwargs)
    return response