Skip to content

Hive.cookbook.profile topics

ProfileTopics

Bases: ApiManager

Class that handles all the XAutomata profile_topics APIs

Source code in hive/cookbook/profile_topics.py 
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
class ProfileTopics(ApiManager):
    """Class that handles all the XAutomata profile_topics APIs"""

    def profile_topics(self, warm_start: bool = False,
        single_page: bool = False, page_size: int = 5000,
        kwargs: dict = None, **params) -> list:
        """Read Profile Topic

        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
            profile (string optional): additional filter - parameter
            topic (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', 'profile', 'topic', 'skip',
            'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('profile'), params.get('topic'
            ), params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.profile_topics.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/profile_topics/',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, **kwargs)
        return response

    def profile_topics_create(self, kwargs: dict = None, **payload) -> list:
        """Create Profile Topic

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

        Keyword Args:
            profile (string required): additional filter - payload
            topic (string required): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['profile', 'topic']
        payload.get('profile'), payload.get('topic')
        if not self._silence_warning:
            warning_wrong_parameters(self.profile_topics_create.__name__,
                payload, official_payload_list)
        response = self.execute('POST', path=f'/profile_topics/', payload=
            payload, **kwargs)
        return response

    def profile_topic(self, uuid: str, warm_start: bool = False,
        kwargs: dict = None) -> list:
        """Read Profile Topic

        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'/profile_topics/{uuid}',
            warm_start=warm_start, **kwargs)
        return response

    def profile_topics_put(self, uuid: str, kwargs: dict = None, **payload
        ) -> list:
        """Update Profile Topic

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

        Keyword Args:
            profile (string optional): additional filter - payload
            topic (string optional): additional filter - payload

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

    def profile_topics_delete(self, uuid: str, kwargs: dict = None) -> list:
        """Delete Profile Topic

        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'/profile_topics/{uuid}',
            **kwargs)
        return response

    def profile_topics_bulk(self, payload: list, warm_start: bool = False,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None,
        **params) -> list:
        """Bulk Read Main Profile Topic

        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.profile_topics_bulk.__name__,
                params, official_params_list)
        response = self.execute('POST', path=f'/profile_topics/bulk/read/',
            single_page=single_page, page_size=page_size, warm_start=
            warm_start, params=params, payload=payload, **kwargs)
        return response

    def profile_topics_create_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None,
        **params) -> list:
        """Bulk Create Profile Topics

        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 = 
          [
           {
            "profile": "string", required
            "topic": "string", required
           }
          ]

        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.profile_topics_create_bulk.
                __name__, params, official_params_list)
        response = self.execute('POST', path=
            f'/profile_topics/bulk/create/', single_page=single_page,
            page_size=page_size, params=params, payload=payload, **kwargs)
        return response

    def profile_topics_delete_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None
        ) -> list:
        """Bulk Delete Profile Topics

        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'/profile_topics/bulk/delete/', single_page=single_page,
            page_size=page_size, payload=payload, **kwargs)
        return response

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

Read Profile Topic

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/profile_topics.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def profile_topic(self, uuid: str, warm_start: bool = False,
    kwargs: dict = None) -> list:
    """Read Profile Topic

    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'/profile_topics/{uuid}',
        warm_start=warm_start, **kwargs)
    return response

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

Read Profile Topic

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
profile string optional

additional filter - parameter
topic 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/profile_topics.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def profile_topics(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Read Profile Topic

    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
        profile (string optional): additional filter - parameter
        topic (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', 'profile', 'topic', 'skip',
        'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('profile'), params.get('topic'
        ), params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.profile_topics.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/profile_topics/',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, **kwargs)
    return response

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

Bulk Read Main Profile Topic

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/profile_topics.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def profile_topics_bulk(self, payload: list, warm_start: bool = False,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Read Main Profile Topic

    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.profile_topics_bulk.__name__,
            params, official_params_list)
    response = self.execute('POST', path=f'/profile_topics/bulk/read/',
        single_page=single_page, page_size=page_size, warm_start=
        warm_start, params=params, payload=payload, **kwargs)
    return response

profile_topics_create(kwargs=None, **payload)

Create Profile Topic

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
profile string required

additional filter - payload
topic string required

additional filter - payload

Returns: list

Source code in hive/cookbook/profile_topics.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def profile_topics_create(self, kwargs: dict = None, **payload) -> list:
    """Create Profile Topic

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

    Keyword Args:
        profile (string required): additional filter - payload
        topic (string required): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['profile', 'topic']
    payload.get('profile'), payload.get('topic')
    if not self._silence_warning:
        warning_wrong_parameters(self.profile_topics_create.__name__,
            payload, official_payload_list)
    response = self.execute('POST', path=f'/profile_topics/', payload=
        payload, **kwargs)
    return response

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

Bulk Create Profile Topics

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 =

[ { "profile": "string", required "topic": "string", required } ]

Returns: list

Source code in hive/cookbook/profile_topics.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def profile_topics_create_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Create Profile Topics

    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 = 
      [
       {
        "profile": "string", required
        "topic": "string", required
       }
      ]

    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.profile_topics_create_bulk.
            __name__, params, official_params_list)
    response = self.execute('POST', path=
        f'/profile_topics/bulk/create/', single_page=single_page,
        page_size=page_size, params=params, payload=payload, **kwargs)
    return response

profile_topics_delete(uuid, kwargs=None)

Delete Profile Topic

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/profile_topics.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
def profile_topics_delete(self, uuid: str, kwargs: dict = None) -> list:
    """Delete Profile Topic

    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'/profile_topics/{uuid}',
        **kwargs)
    return response

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

Bulk Delete Profile Topics

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/profile_topics.py 
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
def profile_topics_delete_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None
    ) -> list:
    """Bulk Delete Profile Topics

    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'/profile_topics/bulk/delete/', single_page=single_page,
        page_size=page_size, payload=payload, **kwargs)
    return response

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

Update Profile Topic

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
profile string optional

additional filter - payload
topic string optional

additional filter - payload

Returns: list

Source code in hive/cookbook/profile_topics.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def profile_topics_put(self, uuid: str, kwargs: dict = None, **payload
    ) -> list:
    """Update Profile Topic

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

    Keyword Args:
        profile (string optional): additional filter - payload
        topic (string optional): additional filter - payload

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