Skip to content

Hive.cookbook.login

Login

Bases: ApiManager

Class that handles all the XAutomata login APIs

Source code in hive/cookbook/login.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
class Login(ApiManager):
    """Class that handles all the XAutomata login APIs"""

    def login_access_token_create(self, params: dict = False,
        kwargs: dict = None, **payload) -> list:
        """Login Access Token Oauth2

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

        Keyword Args:
            value_refresh_token (None optional): additional filter - parameter
            refresh (string optional): additional filter - parameter
            grant_type (string optional): additional filter - payload
            username (string required): additional filter - payload
            password (string required): additional filter - payload
            scope (string optional): additional filter - payload
            client_id (string optional): additional filter - payload
            client_secret (string optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['grant_type', 'username', 'password',
            'scope', 'client_id', 'client_secret']
        payload.get('grant_type'), payload.get('username'), payload.get(
            'password'), payload.get('scope'), payload.get('client_id'
            ), payload.get('client_secret')
        if not self._silence_warning:
            warning_wrong_parameters(self.login_access_token_create.
                __name__, payload, official_payload_list)
        response = self.execute('POST', path=f'/login/access-token', params
            =params, payload=payload, **kwargs)
        return response

    def login_refresh_create(self, kwargs: dict = None, **params) -> list:
        """Refresh Token

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

        Keyword Args:
            refresh (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['refresh']
        params.get('refresh')
        if not self._silence_warning:
            warning_wrong_parameters(self.login_refresh_create.__name__,
                params, official_params_list)
        response = self.execute('POST', path=f'/login/refresh', params=
            params, **kwargs)
        return response

    def login_refresh_invalidate_create(self, kwargs: dict = None, **params
        ) -> list:
        """Invalidate Token

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

        Keyword Args:
            refresh (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['refresh']
        params.get('refresh')
        if not self._silence_warning:
            warning_wrong_parameters(self.login_refresh_invalidate_create.
                __name__, params, official_params_list)
        response = self.execute('POST', path=f'/login/refresh/invalidate',
            params=params, **kwargs)
        return response

    def login_refresh_invalidate_user_create(self, kwargs: dict = None, **
        params) -> list:
        """Invalidate User Tokens

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

        Keyword Args:
            username (string required): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['username']
        params.get('username')
        if not self._silence_warning:
            warning_wrong_parameters(self.
                login_refresh_invalidate_user_create.__name__, params,
                official_params_list)
        response = self.execute('POST', path=
            f'/login/refresh/invalidate_user', params=params, **kwargs)
        return response

    def login_refresh_invalidate_tokens_create(self, kwargs: dict = None
        ) -> list:
        """Invalidate User Tokens

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

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('POST', path=
            f'/login/refresh/invalidate_tokens', **kwargs)
        return response

    def login_current_user(self, warm_start: bool = False, kwargs: dict = None
        ) -> list:
        """Get Current User

        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.
            kwargs (dict, optional): additional parameters for execute. Default to None.

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

    def login_current_user_put(self, kwargs: dict = None, **payload) -> list:
        """Update User

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

        Keyword Args:
            phone (string optional): additional filter - payload
            verified_email (boolean optional): additional filter - payload
            profile (string optional): additional filter - payload
            password (string optional): additional filter - payload
            email (string optional): additional filter - payload
            stage (string optional): additional filter - payload
            active (boolean optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['phone', 'verified_email', 'profile',
            'password', 'email', 'stage', 'active']
        payload.get('phone'), payload.get('verified_email'), payload.get(
            'profile'), payload.get('password'), payload.get('email'
            ), payload.get('stage'), payload.get('active')
        if not self._silence_warning:
            warning_wrong_parameters(self.login_current_user_put.__name__,
                payload, official_payload_list)
        response = self.execute('PUT', path=f'/login/current_user', payload
            =payload, **kwargs)
        return response

    def login_current_user_image(self, warm_start: bool = False,
        kwargs: dict = None) -> list:
        """Get Image

        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.
            kwargs (dict, optional): additional parameters for execute. Default to None.

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        response = self.execute('GET', path=f'/login/current_user/image',
            warm_start=warm_start, **kwargs)
        return response

    def login_current_user_image_put(self, kwargs: dict = None, **payload
        ) -> list:
        """Update Image

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

        Keyword Args:
            image (string required): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['image']
        payload.get('image')
        if not self._silence_warning:
            warning_wrong_parameters(self.login_current_user_image_put.
                __name__, payload, official_payload_list)
        response = self.execute('PUT', path=f'/login/current_user/image',
            payload=payload, **kwargs)
        return response

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

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

    def login_current_user_push_tokens_create(self, kwargs: dict = None, **
        payload) -> list:
        """Create Or Update Token

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

        Keyword Args:
            token (string required): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['token']
        payload.get('token')
        if not self._silence_warning:
            warning_wrong_parameters(self.
                login_current_user_push_tokens_create.__name__, payload,
                official_payload_list)
        response = self.execute('POST', path=
            f'/login/current_user/push_tokens', payload=payload, **kwargs)
        return response

    def login_current_user_push_tokens_delete(self, token: str,
        kwargs: dict = None) -> list:
        """Delete Downtime

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

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

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

        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
            title (string optional): additional filter - parameter
            body (string optional): additional filter - parameter
            read (boolean optional): additional filter - parameter
            sent (boolean 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', 'title', 'body',
            'read', 'sent', 'skip', 'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get('title'
            ), params.get('body'), params.get('read'), params.get('sent'
            ), params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.login_current_user_notifications.
                __name__, params, official_params_list)
        response = self.execute('GET', path=
            f'/login/current_user/notifications', single_page=single_page,
            page_size=page_size, warm_start=warm_start, params=params, **kwargs
            )
        return response

    def login_current_user_notifications_put(self, uuid: str,
        kwargs: dict = None) -> list:
        """Update Notification

        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('PUT', path=
            f'/login/current_user/notifications/{uuid}', **kwargs)
        return response

    def login_current_user_notifications_delete(self, uuid: str,
        kwargs: dict = None) -> list:
        """Delete Notification

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

    def login_current_user_notifications_put_bulk(self, payload: list,
        single_page: bool = False, page_size: int = 50, kwargs: dict = None
        ) -> list:
        """Bulk Set Read

        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'/login/current_user/notifications/bulk/update', single_page=
            single_page, page_size=page_size, payload=payload, **kwargs)
        return response

    def login_current_user_terms_and_conditions(self,
        warm_start: bool = False, single_page: bool = False,
        page_size: int = 5000, kwargs: dict = None, **params) -> list:
        """Check If User Approved Tc

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

    def login_current_user_terms_and_conditions_create(self,
        kwargs: dict = None, **payload) -> list:
        """User Approved Or Declined Tc

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

        Keyword Args:
            tc_version (integer required): additional filter - payload
            accepted (boolean required): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['tc_version', 'accepted']
        payload.get('tc_version'), payload.get('accepted')
        if not self._silence_warning:
            warning_wrong_parameters(self.
                login_current_user_terms_and_conditions_create.__name__,
                payload, official_payload_list)
        response = self.execute('POST', path=
            f'/login/current_user/terms_and_conditions', payload=payload,
            **kwargs)
        return response

login_access_token_create(params=False, kwargs=None, **payload)

Login Access Token Oauth2

Parameters:

Name Type Description Default
params dict

additional parameters for the API.

 False
kwargs dict

additional parameters for execute. Default to None.

 None
**payload

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
value_refresh_token None optional

additional filter - parameter
refresh string optional

additional filter - parameter
grant_type string optional

additional filter - payload
username string required

additional filter - payload
password string required

additional filter - payload
scope string optional

additional filter - payload
client_id string optional

additional filter - payload
client_secret string optional

additional filter - payload

Returns: list

Source code in hive/cookbook/login.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
def login_access_token_create(self, params: dict = False,
    kwargs: dict = None, **payload) -> list:
    """Login Access Token Oauth2

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

    Keyword Args:
        value_refresh_token (None optional): additional filter - parameter
        refresh (string optional): additional filter - parameter
        grant_type (string optional): additional filter - payload
        username (string required): additional filter - payload
        password (string required): additional filter - payload
        scope (string optional): additional filter - payload
        client_id (string optional): additional filter - payload
        client_secret (string optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['grant_type', 'username', 'password',
        'scope', 'client_id', 'client_secret']
    payload.get('grant_type'), payload.get('username'), payload.get(
        'password'), payload.get('scope'), payload.get('client_id'
        ), payload.get('client_secret')
    if not self._silence_warning:
        warning_wrong_parameters(self.login_access_token_create.
            __name__, payload, official_payload_list)
    response = self.execute('POST', path=f'/login/access-token', params
        =params, payload=payload, **kwargs)
    return response

login_current_user(warm_start=False, kwargs=None)

Get Current User

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
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/login.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def login_current_user(self, warm_start: bool = False, kwargs: dict = None
    ) -> list:
    """Get Current User

    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.
        kwargs (dict, optional): additional parameters for execute. Default to None.

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

login_current_user_image(warm_start=False, kwargs=None)

Get Image

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
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/login.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
def login_current_user_image(self, warm_start: bool = False,
    kwargs: dict = None) -> list:
    """Get Image

    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.
        kwargs (dict, optional): additional parameters for execute. Default to None.

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('GET', path=f'/login/current_user/image',
        warm_start=warm_start, **kwargs)
    return response

login_current_user_image_put(kwargs=None, **payload)

Update Image

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

additional filter - payload

Returns: list

Source code in hive/cookbook/login.py 
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
def login_current_user_image_put(self, kwargs: dict = None, **payload
    ) -> list:
    """Update Image

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

    Keyword Args:
        image (string required): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['image']
    payload.get('image')
    if not self._silence_warning:
        warning_wrong_parameters(self.login_current_user_image_put.
            __name__, payload, official_payload_list)
    response = self.execute('PUT', path=f'/login/current_user/image',
        payload=payload, **kwargs)
    return response

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

Read Notifications

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

additional filter - parameter
body string optional

additional filter - parameter
read boolean optional

additional filter - parameter
sent boolean 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/login.py 
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
def login_current_user_notifications(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Read Notifications

    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
        title (string optional): additional filter - parameter
        body (string optional): additional filter - parameter
        read (boolean optional): additional filter - parameter
        sent (boolean 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', 'title', 'body',
        'read', 'sent', 'skip', 'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get('title'
        ), params.get('body'), params.get('read'), params.get('sent'
        ), params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.login_current_user_notifications.
            __name__, params, official_params_list)
    response = self.execute('GET', path=
        f'/login/current_user/notifications', single_page=single_page,
        page_size=page_size, warm_start=warm_start, params=params, **kwargs
        )
    return response

login_current_user_notifications_delete(uuid, kwargs=None)

Delete Notification

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/login.py 
343
344
345
346
347
348
349
350
351
352
353
354
355
356
def login_current_user_notifications_delete(self, uuid: str,
    kwargs: dict = None) -> list:
    """Delete Notification

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

login_current_user_notifications_put(uuid, kwargs=None)

Update Notification

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/login.py 
328
329
330
331
332
333
334
335
336
337
338
339
340
341
def login_current_user_notifications_put(self, uuid: str,
    kwargs: dict = None) -> list:
    """Update Notification

    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('PUT', path=
        f'/login/current_user/notifications/{uuid}', **kwargs)
    return response

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

Bulk Set Read

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/login.py 
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
def login_current_user_notifications_put_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None
    ) -> list:
    """Bulk Set Read

    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'/login/current_user/notifications/bulk/update', single_page=
        single_page, page_size=page_size, payload=payload, **kwargs)
    return response

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

Read Tokens

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

additional filter - parameter
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
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/login.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
def login_current_user_push_tokens(self, warm_start: bool = False,
    single_page: bool = False, page_size: int = 5000,
    kwargs: dict = None, **params) -> list:
    """Read Tokens

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

login_current_user_push_tokens_create(kwargs=None, **payload)

Create Or Update Token

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

additional filter - payload

Returns: list

Source code in hive/cookbook/login.py 
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
def login_current_user_push_tokens_create(self, kwargs: dict = None, **
    payload) -> list:
    """Create Or Update Token

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

    Keyword Args:
        token (string required): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['token']
    payload.get('token')
    if not self._silence_warning:
        warning_wrong_parameters(self.
            login_current_user_push_tokens_create.__name__, payload,
            official_payload_list)
    response = self.execute('POST', path=
        f'/login/current_user/push_tokens', payload=payload, **kwargs)
    return response

login_current_user_push_tokens_delete(token, kwargs=None)

Delete Downtime

Parameters:

Name Type Description Default
token (str, required)

token

 required
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/login.py 
270
271
272
273
274
275
276
277
278
279
280
281
282
283
def login_current_user_push_tokens_delete(self, token: str,
    kwargs: dict = None) -> list:
    """Delete Downtime

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

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

login_current_user_put(kwargs=None, **payload)

Update User

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

additional filter - payload
verified_email boolean optional

additional filter - payload
profile string optional

additional filter - payload
password string optional

additional filter - payload
email string optional

additional filter - payload
stage string optional

additional filter - payload
active boolean optional

additional filter - payload

Returns: list

Source code in hive/cookbook/login.py 
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
def login_current_user_put(self, kwargs: dict = None, **payload) -> list:
    """Update User

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

    Keyword Args:
        phone (string optional): additional filter - payload
        verified_email (boolean optional): additional filter - payload
        profile (string optional): additional filter - payload
        password (string optional): additional filter - payload
        email (string optional): additional filter - payload
        stage (string optional): additional filter - payload
        active (boolean optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['phone', 'verified_email', 'profile',
        'password', 'email', 'stage', 'active']
    payload.get('phone'), payload.get('verified_email'), payload.get(
        'profile'), payload.get('password'), payload.get('email'
        ), payload.get('stage'), payload.get('active')
    if not self._silence_warning:
        warning_wrong_parameters(self.login_current_user_put.__name__,
            payload, official_payload_list)
    response = self.execute('PUT', path=f'/login/current_user', payload
        =payload, **kwargs)
    return response

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

Check If User Approved Tc

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
tc_version integer optional

additional filter - parameter
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
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/login.py 
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
def login_current_user_terms_and_conditions(self,
    warm_start: bool = False, single_page: bool = False,
    page_size: int = 5000, kwargs: dict = None, **params) -> list:
    """Check If User Approved Tc

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

login_current_user_terms_and_conditions_create(kwargs=None, **payload)

User Approved Or Declined Tc

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
tc_version integer required

additional filter - payload
accepted boolean required

additional filter - payload

Returns: list

Source code in hive/cookbook/login.py 
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
def login_current_user_terms_and_conditions_create(self,
    kwargs: dict = None, **payload) -> list:
    """User Approved Or Declined Tc

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

    Keyword Args:
        tc_version (integer required): additional filter - payload
        accepted (boolean required): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['tc_version', 'accepted']
    payload.get('tc_version'), payload.get('accepted')
    if not self._silence_warning:
        warning_wrong_parameters(self.
            login_current_user_terms_and_conditions_create.__name__,
            payload, official_payload_list)
    response = self.execute('POST', path=
        f'/login/current_user/terms_and_conditions', payload=payload,
        **kwargs)
    return response

login_refresh_create(kwargs=None, **params)

Refresh Token

Parameters:

Name Type Description Default
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
refresh string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/login.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def login_refresh_create(self, kwargs: dict = None, **params) -> list:
    """Refresh Token

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

    Keyword Args:
        refresh (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['refresh']
    params.get('refresh')
    if not self._silence_warning:
        warning_wrong_parameters(self.login_refresh_create.__name__,
            params, official_params_list)
    response = self.execute('POST', path=f'/login/refresh', params=
        params, **kwargs)
    return response

login_refresh_invalidate_create(kwargs=None, **params)

Invalidate Token

Parameters:

Name Type Description Default
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
refresh string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/login.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def login_refresh_invalidate_create(self, kwargs: dict = None, **params
    ) -> list:
    """Invalidate Token

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

    Keyword Args:
        refresh (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['refresh']
    params.get('refresh')
    if not self._silence_warning:
        warning_wrong_parameters(self.login_refresh_invalidate_create.
            __name__, params, official_params_list)
    response = self.execute('POST', path=f'/login/refresh/invalidate',
        params=params, **kwargs)
    return response

login_refresh_invalidate_tokens_create(kwargs=None)

Invalidate User Tokens

Parameters:

Name Type Description Default
kwargs dict

additional parameters for execute. Default to None.

 None

Returns: list

Source code in hive/cookbook/login.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
def login_refresh_invalidate_tokens_create(self, kwargs: dict = None
    ) -> list:
    """Invalidate User Tokens

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

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    response = self.execute('POST', path=
        f'/login/refresh/invalidate_tokens', **kwargs)
    return response

login_refresh_invalidate_user_create(kwargs=None, **params)

Invalidate User Tokens

Parameters:

Name Type Description Default
kwargs dict

additional parameters for execute. Default to None.

 None
**params

additional parameters for the API.

 {}

Other Parameters:

Name Type Description
username string required

additional filter - parameter

Returns: list

Source code in hive/cookbook/login.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def login_refresh_invalidate_user_create(self, kwargs: dict = None, **
    params) -> list:
    """Invalidate User Tokens

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

    Keyword Args:
        username (string required): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['username']
    params.get('username')
    if not self._silence_warning:
        warning_wrong_parameters(self.
            login_refresh_invalidate_user_create.__name__, params,
            official_params_list)
    response = self.execute('POST', path=
        f'/login/refresh/invalidate_user', params=params, **kwargs)
    return response