Skip to content

Hive.cookbook.calendars

Calendars

Bases: ApiManager

Class that handles all the XAutomata calendars APIs

Source code in hive/cookbook/calendars.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
class Calendars(ApiManager):
    """Class that handles all the XAutomata calendars APIs"""

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

        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
            name (string optional): additional filter - parameter
            local_public_holidays (boolean optional): additional filter - parameter
            timezone (string optional): additional filter - parameter
            mon_int1_start (string optional): additional filter - parameter
            mon_int1_end (string optional): additional filter - parameter
            mon_int2_start (string optional): additional filter - parameter
            mon_int2_end (string optional): additional filter - parameter
            tue_int1_start (string optional): additional filter - parameter
            tue_int1_end (string optional): additional filter - parameter
            tue_int2_start (string optional): additional filter - parameter
            tue_int2_end (string optional): additional filter - parameter
            wed_int1_start (string optional): additional filter - parameter
            wed_int1_end (string optional): additional filter - parameter
            wed_int2_start (string optional): additional filter - parameter
            wed_int2_end (string optional): additional filter - parameter
            thu_int1_start (string optional): additional filter - parameter
            thu_int1_end (string optional): additional filter - parameter
            thu_int2_start (string optional): additional filter - parameter
            thu_int2_end (string optional): additional filter - parameter
            fri_int1_start (string optional): additional filter - parameter
            fri_int1_end (string optional): additional filter - parameter
            fri_int2_start (string optional): additional filter - parameter
            fri_int2_end (string optional): additional filter - parameter
            sat_int1_start (string optional): additional filter - parameter
            sat_int1_end (string optional): additional filter - parameter
            sat_int2_start (string optional): additional filter - parameter
            sat_int2_end (string optional): additional filter - parameter
            sun_int1_start (string optional): additional filter - parameter
            sun_int1_end (string optional): additional filter - parameter
            sun_int2_start (string optional): additional filter - parameter
            sun_int2_end (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', 'name',
            'local_public_holidays', 'timezone', 'mon_int1_start',
            'mon_int1_end', 'mon_int2_start', 'mon_int2_end',
            'tue_int1_start', 'tue_int1_end', 'tue_int2_start',
            'tue_int2_end', 'wed_int1_start', 'wed_int1_end',
            'wed_int2_start', 'wed_int2_end', 'thu_int1_start',
            'thu_int1_end', 'thu_int2_start', 'thu_int2_end',
            'fri_int1_start', 'fri_int1_end', 'fri_int2_start',
            'fri_int2_end', 'sat_int1_start', 'sat_int1_end',
            'sat_int2_start', 'sat_int2_end', 'sun_int1_start',
            'sun_int1_end', 'sun_int2_start', 'sun_int2_end', 'skip',
            'limit', 'like', 'join', 'count']
        params.get('sort_by'), params.get('null_fields'), params.get('name'
            ), params.get('local_public_holidays'), params.get('timezone'
            ), params.get('mon_int1_start'), params.get('mon_int1_end'
            ), params.get('mon_int2_start'), params.get('mon_int2_end'
            ), params.get('tue_int1_start'), params.get('tue_int1_end'
            ), params.get('tue_int2_start'), params.get('tue_int2_end'
            ), params.get('wed_int1_start'), params.get('wed_int1_end'
            ), params.get('wed_int2_start'), params.get('wed_int2_end'
            ), params.get('thu_int1_start'), params.get('thu_int1_end'
            ), params.get('thu_int2_start'), params.get('thu_int2_end'
            ), params.get('fri_int1_start'), params.get('fri_int1_end'
            ), params.get('fri_int2_start'), params.get('fri_int2_end'
            ), params.get('sat_int1_start'), params.get('sat_int1_end'
            ), params.get('sat_int2_start'), params.get('sat_int2_end'
            ), params.get('sun_int1_start'), params.get('sun_int1_end'
            ), params.get('sun_int2_start'), params.get('sun_int2_end'
            ), params.get('skip'), params.get('limit'), params.get('like'
            ), params.get('join'), params.get('count')
        if not self._silence_warning:
            warning_wrong_parameters(self.calendars.__name__, params,
                official_params_list)
        response = self.execute('GET', path=f'/calendars/', single_page=
            single_page, page_size=page_size, warm_start=warm_start, params
            =params, **kwargs)
        return response

    def calendars_create(self, kwargs: dict = None, **payload) -> list:
        """Create Calendar

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

        Keyword Args:
            name (string required): additional filter - payload
            timezone (string required): additional filter - payload
            local_public_holidays (boolean required): additional filter - payload
            mon_int1_start (string optional): additional filter - payload
            mon_int1_end (string optional): additional filter - payload
            mon_int2_start (string optional): additional filter - payload
            mon_int2_end (string optional): additional filter - payload
            tue_int1_start (string optional): additional filter - payload
            tue_int1_end (string optional): additional filter - payload
            tue_int2_start (string optional): additional filter - payload
            tue_int2_end (string optional): additional filter - payload
            wed_int1_start (string optional): additional filter - payload
            wed_int1_end (string optional): additional filter - payload
            wed_int2_start (string optional): additional filter - payload
            wed_int2_end (string optional): additional filter - payload
            thu_int1_start (string optional): additional filter - payload
            thu_int1_end (string optional): additional filter - payload
            thu_int2_start (string optional): additional filter - payload
            thu_int2_end (string optional): additional filter - payload
            fri_int1_start (string optional): additional filter - payload
            fri_int1_end (string optional): additional filter - payload
            fri_int2_start (string optional): additional filter - payload
            fri_int2_end (string optional): additional filter - payload
            sat_int1_start (string optional): additional filter - payload
            sat_int1_end (string optional): additional filter - payload
            sat_int2_start (string optional): additional filter - payload
            sat_int2_end (string optional): additional filter - payload
            sun_int1_start (string optional): additional filter - payload
            sun_int1_end (string optional): additional filter - payload
            sun_int2_start (string optional): additional filter - payload
            sun_int2_end (string optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['name', 'timezone',
            'local_public_holidays', 'mon_int1_start', 'mon_int1_end',
            'mon_int2_start', 'mon_int2_end', 'tue_int1_start',
            'tue_int1_end', 'tue_int2_start', 'tue_int2_end',
            'wed_int1_start', 'wed_int1_end', 'wed_int2_start',
            'wed_int2_end', 'thu_int1_start', 'thu_int1_end',
            'thu_int2_start', 'thu_int2_end', 'fri_int1_start',
            'fri_int1_end', 'fri_int2_start', 'fri_int2_end',
            'sat_int1_start', 'sat_int1_end', 'sat_int2_start',
            'sat_int2_end', 'sun_int1_start', 'sun_int1_end',
            'sun_int2_start', 'sun_int2_end']
        payload.get('name'), payload.get('timezone'), payload.get(
            'local_public_holidays'), payload.get('mon_int1_start'
            ), payload.get('mon_int1_end'), payload.get('mon_int2_start'
            ), payload.get('mon_int2_end'), payload.get('tue_int1_start'
            ), payload.get('tue_int1_end'), payload.get('tue_int2_start'
            ), payload.get('tue_int2_end'), payload.get('wed_int1_start'
            ), payload.get('wed_int1_end'), payload.get('wed_int2_start'
            ), payload.get('wed_int2_end'), payload.get('thu_int1_start'
            ), payload.get('thu_int1_end'), payload.get('thu_int2_start'
            ), payload.get('thu_int2_end'), payload.get('fri_int1_start'
            ), payload.get('fri_int1_end'), payload.get('fri_int2_start'
            ), payload.get('fri_int2_end'), payload.get('sat_int1_start'
            ), payload.get('sat_int1_end'), payload.get('sat_int2_start'
            ), payload.get('sat_int2_end'), payload.get('sun_int1_start'
            ), payload.get('sun_int1_end'), payload.get('sun_int2_start'
            ), payload.get('sun_int2_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.calendars_create.__name__,
                payload, official_payload_list)
        response = self.execute('POST', path=f'/calendars/', payload=
            payload, **kwargs)
        return response

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

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

    def calendars_put(self, uuid: str, kwargs: dict = None, **payload) -> list:
        """Update Calendar

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

        Keyword Args:
            name (string optional): additional filter - payload
            timezone (string optional): additional filter - payload
            local_public_holidays (boolean optional): additional filter - payload
            mon_int1_start (string optional): additional filter - payload
            mon_int1_end (string optional): additional filter - payload
            mon_int2_start (string optional): additional filter - payload
            mon_int2_end (string optional): additional filter - payload
            tue_int1_start (string optional): additional filter - payload
            tue_int1_end (string optional): additional filter - payload
            tue_int2_start (string optional): additional filter - payload
            tue_int2_end (string optional): additional filter - payload
            wed_int1_start (string optional): additional filter - payload
            wed_int1_end (string optional): additional filter - payload
            wed_int2_start (string optional): additional filter - payload
            wed_int2_end (string optional): additional filter - payload
            thu_int1_start (string optional): additional filter - payload
            thu_int1_end (string optional): additional filter - payload
            thu_int2_start (string optional): additional filter - payload
            thu_int2_end (string optional): additional filter - payload
            fri_int1_start (string optional): additional filter - payload
            fri_int1_end (string optional): additional filter - payload
            fri_int2_start (string optional): additional filter - payload
            fri_int2_end (string optional): additional filter - payload
            sat_int1_start (string optional): additional filter - payload
            sat_int1_end (string optional): additional filter - payload
            sat_int2_start (string optional): additional filter - payload
            sat_int2_end (string optional): additional filter - payload
            sun_int1_start (string optional): additional filter - payload
            sun_int1_end (string optional): additional filter - payload
            sun_int2_start (string optional): additional filter - payload
            sun_int2_end (string optional): additional filter - payload

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_payload_list = ['name', 'timezone',
            'local_public_holidays', 'mon_int1_start', 'mon_int1_end',
            'mon_int2_start', 'mon_int2_end', 'tue_int1_start',
            'tue_int1_end', 'tue_int2_start', 'tue_int2_end',
            'wed_int1_start', 'wed_int1_end', 'wed_int2_start',
            'wed_int2_end', 'thu_int1_start', 'thu_int1_end',
            'thu_int2_start', 'thu_int2_end', 'fri_int1_start',
            'fri_int1_end', 'fri_int2_start', 'fri_int2_end',
            'sat_int1_start', 'sat_int1_end', 'sat_int2_start',
            'sat_int2_end', 'sun_int1_start', 'sun_int1_end',
            'sun_int2_start', 'sun_int2_end']
        payload.get('name'), payload.get('timezone'), payload.get(
            'local_public_holidays'), payload.get('mon_int1_start'
            ), payload.get('mon_int1_end'), payload.get('mon_int2_start'
            ), payload.get('mon_int2_end'), payload.get('tue_int1_start'
            ), payload.get('tue_int1_end'), payload.get('tue_int2_start'
            ), payload.get('tue_int2_end'), payload.get('wed_int1_start'
            ), payload.get('wed_int1_end'), payload.get('wed_int2_start'
            ), payload.get('wed_int2_end'), payload.get('thu_int1_start'
            ), payload.get('thu_int1_end'), payload.get('thu_int2_start'
            ), payload.get('thu_int2_end'), payload.get('fri_int1_start'
            ), payload.get('fri_int1_end'), payload.get('fri_int2_start'
            ), payload.get('fri_int2_end'), payload.get('sat_int1_start'
            ), payload.get('sat_int1_end'), payload.get('sat_int2_start'
            ), payload.get('sat_int2_end'), payload.get('sun_int1_start'
            ), payload.get('sun_int1_end'), payload.get('sun_int2_start'
            ), payload.get('sun_int2_end')
        if not self._silence_warning:
            warning_wrong_parameters(self.calendars_put.__name__, payload,
                official_payload_list)
        response = self.execute('PUT', path=f'/calendars/{uuid}', payload=
            payload, **kwargs)
        return response

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

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

    def calendars_is_local_holiday_create(self, kwargs: dict = None, **params
        ) -> list:
        """Is Local Holiday

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

        Keyword Args:
            country (string required): additional filter - parameter
            ts (string required): additional filter - parameter
            timezone (string required): additional filter - parameter
            state_province (string optional): additional filter - parameter

        Returns: list"""
        if kwargs is None:
            kwargs = dict()
        official_params_list = ['country', 'ts', 'timezone', 'state_province']
        params.get('country'), params.get('ts'), params.get('timezone'
            ), params.get('state_province')
        if not self._silence_warning:
            warning_wrong_parameters(self.calendars_is_local_holiday_create
                .__name__, params, official_params_list)
        response = self.execute('POST', path=f'/calendars/is_local_holiday',
            params=params, **kwargs)
        return response

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

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

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

        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 = 
          [
           {
            "name": "string", required
            "timezone": "string", required
            "local_public_holidays": "boolean", required
            "mon_int1_start": "string", optional
            "mon_int1_end": "string", optional
            "mon_int2_start": "string", optional
            "mon_int2_end": "string", optional
            "tue_int1_start": "string", optional
            "tue_int1_end": "string", optional
            "tue_int2_start": "string", optional
            "tue_int2_end": "string", optional
            "wed_int1_start": "string", optional
            "wed_int1_end": "string", optional
            "wed_int2_start": "string", optional
            "wed_int2_end": "string", optional
            "thu_int1_start": "string", optional
            "thu_int1_end": "string", optional
            "thu_int2_start": "string", optional
            "thu_int2_end": "string", optional
            "fri_int1_start": "string", optional
            "fri_int1_end": "string", optional
            "fri_int2_start": "string", optional
            "fri_int2_end": "string", optional
            "sat_int1_start": "string", optional
            "sat_int1_end": "string", optional
            "sat_int2_start": "string", optional
            "sat_int2_end": "string", optional
            "sun_int1_start": "string", optional
            "sun_int1_end": "string", optional
            "sun_int2_start": "string", optional
            "sun_int2_end": "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.calendars_create_bulk.__name__,
                params, official_params_list)
        response = self.execute('POST', path=f'/calendars/bulk/create/',
            single_page=single_page, page_size=page_size, params=params,
            payload=payload, **kwargs)
        return response

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

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

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

Read Calendar

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/calendars.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
def calendar(self, uuid: str, warm_start: bool = False, kwargs: dict = None
    ) -> list:
    """Read Calendar

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

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

Read Calendars

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

additional filter - parameter
local_public_holidays boolean optional

additional filter - parameter
timezone string optional

additional filter - parameter
mon_int1_start string optional

additional filter - parameter
mon_int1_end string optional

additional filter - parameter
mon_int2_start string optional

additional filter - parameter
mon_int2_end string optional

additional filter - parameter
tue_int1_start string optional

additional filter - parameter
tue_int1_end string optional

additional filter - parameter
tue_int2_start string optional

additional filter - parameter
tue_int2_end string optional

additional filter - parameter
wed_int1_start string optional

additional filter - parameter
wed_int1_end string optional

additional filter - parameter
wed_int2_start string optional

additional filter - parameter
wed_int2_end string optional

additional filter - parameter
thu_int1_start string optional

additional filter - parameter
thu_int1_end string optional

additional filter - parameter
thu_int2_start string optional

additional filter - parameter
thu_int2_end string optional

additional filter - parameter
fri_int1_start string optional

additional filter - parameter
fri_int1_end string optional

additional filter - parameter
fri_int2_start string optional

additional filter - parameter
fri_int2_end string optional

additional filter - parameter
sat_int1_start string optional

additional filter - parameter
sat_int1_end string optional

additional filter - parameter
sat_int2_start string optional

additional filter - parameter
sat_int2_end string optional

additional filter - parameter
sun_int1_start string optional

additional filter - parameter
sun_int1_end string optional

additional filter - parameter
sun_int2_start string optional

additional filter - parameter
sun_int2_end 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/calendars.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
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
def calendars(self, warm_start: bool = False, single_page: bool = False,
    page_size: int = 5000, kwargs: dict = None, **params) -> list:
    """Read Calendars

    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
        name (string optional): additional filter - parameter
        local_public_holidays (boolean optional): additional filter - parameter
        timezone (string optional): additional filter - parameter
        mon_int1_start (string optional): additional filter - parameter
        mon_int1_end (string optional): additional filter - parameter
        mon_int2_start (string optional): additional filter - parameter
        mon_int2_end (string optional): additional filter - parameter
        tue_int1_start (string optional): additional filter - parameter
        tue_int1_end (string optional): additional filter - parameter
        tue_int2_start (string optional): additional filter - parameter
        tue_int2_end (string optional): additional filter - parameter
        wed_int1_start (string optional): additional filter - parameter
        wed_int1_end (string optional): additional filter - parameter
        wed_int2_start (string optional): additional filter - parameter
        wed_int2_end (string optional): additional filter - parameter
        thu_int1_start (string optional): additional filter - parameter
        thu_int1_end (string optional): additional filter - parameter
        thu_int2_start (string optional): additional filter - parameter
        thu_int2_end (string optional): additional filter - parameter
        fri_int1_start (string optional): additional filter - parameter
        fri_int1_end (string optional): additional filter - parameter
        fri_int2_start (string optional): additional filter - parameter
        fri_int2_end (string optional): additional filter - parameter
        sat_int1_start (string optional): additional filter - parameter
        sat_int1_end (string optional): additional filter - parameter
        sat_int2_start (string optional): additional filter - parameter
        sat_int2_end (string optional): additional filter - parameter
        sun_int1_start (string optional): additional filter - parameter
        sun_int1_end (string optional): additional filter - parameter
        sun_int2_start (string optional): additional filter - parameter
        sun_int2_end (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', 'name',
        'local_public_holidays', 'timezone', 'mon_int1_start',
        'mon_int1_end', 'mon_int2_start', 'mon_int2_end',
        'tue_int1_start', 'tue_int1_end', 'tue_int2_start',
        'tue_int2_end', 'wed_int1_start', 'wed_int1_end',
        'wed_int2_start', 'wed_int2_end', 'thu_int1_start',
        'thu_int1_end', 'thu_int2_start', 'thu_int2_end',
        'fri_int1_start', 'fri_int1_end', 'fri_int2_start',
        'fri_int2_end', 'sat_int1_start', 'sat_int1_end',
        'sat_int2_start', 'sat_int2_end', 'sun_int1_start',
        'sun_int1_end', 'sun_int2_start', 'sun_int2_end', 'skip',
        'limit', 'like', 'join', 'count']
    params.get('sort_by'), params.get('null_fields'), params.get('name'
        ), params.get('local_public_holidays'), params.get('timezone'
        ), params.get('mon_int1_start'), params.get('mon_int1_end'
        ), params.get('mon_int2_start'), params.get('mon_int2_end'
        ), params.get('tue_int1_start'), params.get('tue_int1_end'
        ), params.get('tue_int2_start'), params.get('tue_int2_end'
        ), params.get('wed_int1_start'), params.get('wed_int1_end'
        ), params.get('wed_int2_start'), params.get('wed_int2_end'
        ), params.get('thu_int1_start'), params.get('thu_int1_end'
        ), params.get('thu_int2_start'), params.get('thu_int2_end'
        ), params.get('fri_int1_start'), params.get('fri_int1_end'
        ), params.get('fri_int2_start'), params.get('fri_int2_end'
        ), params.get('sat_int1_start'), params.get('sat_int1_end'
        ), params.get('sat_int2_start'), params.get('sat_int2_end'
        ), params.get('sun_int1_start'), params.get('sun_int1_end'
        ), params.get('sun_int2_start'), params.get('sun_int2_end'
        ), params.get('skip'), params.get('limit'), params.get('like'
        ), params.get('join'), params.get('count')
    if not self._silence_warning:
        warning_wrong_parameters(self.calendars.__name__, params,
            official_params_list)
    response = self.execute('GET', path=f'/calendars/', single_page=
        single_page, page_size=page_size, warm_start=warm_start, params
        =params, **kwargs)
    return response

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

Bulk Read Calendars

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/calendars.py 
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
def calendars_bulk(self, payload: list, warm_start: bool = False,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Read Calendars

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

calendars_create(kwargs=None, **payload)

Create Calendar

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

additional filter - payload
timezone string required

additional filter - payload
local_public_holidays boolean required

additional filter - payload
mon_int1_start string optional

additional filter - payload
mon_int1_end string optional

additional filter - payload
mon_int2_start string optional

additional filter - payload
mon_int2_end string optional

additional filter - payload
tue_int1_start string optional

additional filter - payload
tue_int1_end string optional

additional filter - payload
tue_int2_start string optional

additional filter - payload
tue_int2_end string optional

additional filter - payload
wed_int1_start string optional

additional filter - payload
wed_int1_end string optional

additional filter - payload
wed_int2_start string optional

additional filter - payload
wed_int2_end string optional

additional filter - payload
thu_int1_start string optional

additional filter - payload
thu_int1_end string optional

additional filter - payload
thu_int2_start string optional

additional filter - payload
thu_int2_end string optional

additional filter - payload
fri_int1_start string optional

additional filter - payload
fri_int1_end string optional

additional filter - payload
fri_int2_start string optional

additional filter - payload
fri_int2_end string optional

additional filter - payload
sat_int1_start string optional

additional filter - payload
sat_int1_end string optional

additional filter - payload
sat_int2_start string optional

additional filter - payload
sat_int2_end string optional

additional filter - payload
sun_int1_start string optional

additional filter - payload
sun_int1_end string optional

additional filter - payload
sun_int2_start string optional

additional filter - payload
sun_int2_end string optional

additional filter - payload

Returns: list

Source code in hive/cookbook/calendars.py 
 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
def calendars_create(self, kwargs: dict = None, **payload) -> list:
    """Create Calendar

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

    Keyword Args:
        name (string required): additional filter - payload
        timezone (string required): additional filter - payload
        local_public_holidays (boolean required): additional filter - payload
        mon_int1_start (string optional): additional filter - payload
        mon_int1_end (string optional): additional filter - payload
        mon_int2_start (string optional): additional filter - payload
        mon_int2_end (string optional): additional filter - payload
        tue_int1_start (string optional): additional filter - payload
        tue_int1_end (string optional): additional filter - payload
        tue_int2_start (string optional): additional filter - payload
        tue_int2_end (string optional): additional filter - payload
        wed_int1_start (string optional): additional filter - payload
        wed_int1_end (string optional): additional filter - payload
        wed_int2_start (string optional): additional filter - payload
        wed_int2_end (string optional): additional filter - payload
        thu_int1_start (string optional): additional filter - payload
        thu_int1_end (string optional): additional filter - payload
        thu_int2_start (string optional): additional filter - payload
        thu_int2_end (string optional): additional filter - payload
        fri_int1_start (string optional): additional filter - payload
        fri_int1_end (string optional): additional filter - payload
        fri_int2_start (string optional): additional filter - payload
        fri_int2_end (string optional): additional filter - payload
        sat_int1_start (string optional): additional filter - payload
        sat_int1_end (string optional): additional filter - payload
        sat_int2_start (string optional): additional filter - payload
        sat_int2_end (string optional): additional filter - payload
        sun_int1_start (string optional): additional filter - payload
        sun_int1_end (string optional): additional filter - payload
        sun_int2_start (string optional): additional filter - payload
        sun_int2_end (string optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['name', 'timezone',
        'local_public_holidays', 'mon_int1_start', 'mon_int1_end',
        'mon_int2_start', 'mon_int2_end', 'tue_int1_start',
        'tue_int1_end', 'tue_int2_start', 'tue_int2_end',
        'wed_int1_start', 'wed_int1_end', 'wed_int2_start',
        'wed_int2_end', 'thu_int1_start', 'thu_int1_end',
        'thu_int2_start', 'thu_int2_end', 'fri_int1_start',
        'fri_int1_end', 'fri_int2_start', 'fri_int2_end',
        'sat_int1_start', 'sat_int1_end', 'sat_int2_start',
        'sat_int2_end', 'sun_int1_start', 'sun_int1_end',
        'sun_int2_start', 'sun_int2_end']
    payload.get('name'), payload.get('timezone'), payload.get(
        'local_public_holidays'), payload.get('mon_int1_start'
        ), payload.get('mon_int1_end'), payload.get('mon_int2_start'
        ), payload.get('mon_int2_end'), payload.get('tue_int1_start'
        ), payload.get('tue_int1_end'), payload.get('tue_int2_start'
        ), payload.get('tue_int2_end'), payload.get('wed_int1_start'
        ), payload.get('wed_int1_end'), payload.get('wed_int2_start'
        ), payload.get('wed_int2_end'), payload.get('thu_int1_start'
        ), payload.get('thu_int1_end'), payload.get('thu_int2_start'
        ), payload.get('thu_int2_end'), payload.get('fri_int1_start'
        ), payload.get('fri_int1_end'), payload.get('fri_int2_start'
        ), payload.get('fri_int2_end'), payload.get('sat_int1_start'
        ), payload.get('sat_int1_end'), payload.get('sat_int2_start'
        ), payload.get('sat_int2_end'), payload.get('sun_int1_start'
        ), payload.get('sun_int1_end'), payload.get('sun_int2_start'
        ), payload.get('sun_int2_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.calendars_create.__name__,
            payload, official_payload_list)
    response = self.execute('POST', path=f'/calendars/', payload=
        payload, **kwargs)
    return response

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

Bulk Create Calendars

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 =

[ { "name": "string", required "timezone": "string", required "local_public_holidays": "boolean", required "mon_int1_start": "string", optional "mon_int1_end": "string", optional "mon_int2_start": "string", optional "mon_int2_end": "string", optional "tue_int1_start": "string", optional "tue_int1_end": "string", optional "tue_int2_start": "string", optional "tue_int2_end": "string", optional "wed_int1_start": "string", optional "wed_int1_end": "string", optional "wed_int2_start": "string", optional "wed_int2_end": "string", optional "thu_int1_start": "string", optional "thu_int1_end": "string", optional "thu_int2_start": "string", optional "thu_int2_end": "string", optional "fri_int1_start": "string", optional "fri_int1_end": "string", optional "fri_int2_start": "string", optional "fri_int2_end": "string", optional "sat_int1_start": "string", optional "sat_int1_end": "string", optional "sat_int2_start": "string", optional "sat_int2_end": "string", optional "sun_int1_start": "string", optional "sun_int1_end": "string", optional "sun_int2_start": "string", optional "sun_int2_end": "string", optional } ]

Returns: list

Source code in hive/cookbook/calendars.py 
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
def calendars_create_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None,
    **params) -> list:
    """Bulk Create Calendars

    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 = 
      [
       {
        "name": "string", required
        "timezone": "string", required
        "local_public_holidays": "boolean", required
        "mon_int1_start": "string", optional
        "mon_int1_end": "string", optional
        "mon_int2_start": "string", optional
        "mon_int2_end": "string", optional
        "tue_int1_start": "string", optional
        "tue_int1_end": "string", optional
        "tue_int2_start": "string", optional
        "tue_int2_end": "string", optional
        "wed_int1_start": "string", optional
        "wed_int1_end": "string", optional
        "wed_int2_start": "string", optional
        "wed_int2_end": "string", optional
        "thu_int1_start": "string", optional
        "thu_int1_end": "string", optional
        "thu_int2_start": "string", optional
        "thu_int2_end": "string", optional
        "fri_int1_start": "string", optional
        "fri_int1_end": "string", optional
        "fri_int2_start": "string", optional
        "fri_int2_end": "string", optional
        "sat_int1_start": "string", optional
        "sat_int1_end": "string", optional
        "sat_int2_start": "string", optional
        "sat_int2_end": "string", optional
        "sun_int1_start": "string", optional
        "sun_int1_end": "string", optional
        "sun_int2_start": "string", optional
        "sun_int2_end": "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.calendars_create_bulk.__name__,
            params, official_params_list)
    response = self.execute('POST', path=f'/calendars/bulk/create/',
        single_page=single_page, page_size=page_size, params=params,
        payload=payload, **kwargs)
    return response

calendars_delete(uuid, kwargs=None)

Delete Calendar

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/calendars.py 
270
271
272
273
274
275
276
277
278
279
280
281
def calendars_delete(self, uuid: str, kwargs: dict = None) -> list:
    """Delete Calendar

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

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

Bulk Delete Calendars

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/calendars.py 
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
def calendars_delete_bulk(self, payload: list,
    single_page: bool = False, page_size: int = 50, kwargs: dict = None
    ) -> list:
    """Bulk Delete Calendars

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

calendars_is_local_holiday_create(kwargs=None, **params)

Is Local Holiday

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

additional filter - parameter
ts string required

additional filter - parameter
timezone string required

additional filter - parameter
state_province string optional

additional filter - parameter

Returns: list

Source code in hive/cookbook/calendars.py 
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
def calendars_is_local_holiday_create(self, kwargs: dict = None, **params
    ) -> list:
    """Is Local Holiday

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

    Keyword Args:
        country (string required): additional filter - parameter
        ts (string required): additional filter - parameter
        timezone (string required): additional filter - parameter
        state_province (string optional): additional filter - parameter

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_params_list = ['country', 'ts', 'timezone', 'state_province']
    params.get('country'), params.get('ts'), params.get('timezone'
        ), params.get('state_province')
    if not self._silence_warning:
        warning_wrong_parameters(self.calendars_is_local_holiday_create
            .__name__, params, official_params_list)
    response = self.execute('POST', path=f'/calendars/is_local_holiday',
        params=params, **kwargs)
    return response

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

Update Calendar

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

additional filter - payload
timezone string optional

additional filter - payload
local_public_holidays boolean optional

additional filter - payload
mon_int1_start string optional

additional filter - payload
mon_int1_end string optional

additional filter - payload
mon_int2_start string optional

additional filter - payload
mon_int2_end string optional

additional filter - payload
tue_int1_start string optional

additional filter - payload
tue_int1_end string optional

additional filter - payload
tue_int2_start string optional

additional filter - payload
tue_int2_end string optional

additional filter - payload
wed_int1_start string optional

additional filter - payload
wed_int1_end string optional

additional filter - payload
wed_int2_start string optional

additional filter - payload
wed_int2_end string optional

additional filter - payload
thu_int1_start string optional

additional filter - payload
thu_int1_end string optional

additional filter - payload
thu_int2_start string optional

additional filter - payload
thu_int2_end string optional

additional filter - payload
fri_int1_start string optional

additional filter - payload
fri_int1_end string optional

additional filter - payload
fri_int2_start string optional

additional filter - payload
fri_int2_end string optional

additional filter - payload
sat_int1_start string optional

additional filter - payload
sat_int1_end string optional

additional filter - payload
sat_int2_start string optional

additional filter - payload
sat_int2_end string optional

additional filter - payload
sun_int1_start string optional

additional filter - payload
sun_int1_end string optional

additional filter - payload
sun_int2_start string optional

additional filter - payload
sun_int2_end string optional

additional filter - payload

Returns: list

Source code in hive/cookbook/calendars.py 
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
def calendars_put(self, uuid: str, kwargs: dict = None, **payload) -> list:
    """Update Calendar

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

    Keyword Args:
        name (string optional): additional filter - payload
        timezone (string optional): additional filter - payload
        local_public_holidays (boolean optional): additional filter - payload
        mon_int1_start (string optional): additional filter - payload
        mon_int1_end (string optional): additional filter - payload
        mon_int2_start (string optional): additional filter - payload
        mon_int2_end (string optional): additional filter - payload
        tue_int1_start (string optional): additional filter - payload
        tue_int1_end (string optional): additional filter - payload
        tue_int2_start (string optional): additional filter - payload
        tue_int2_end (string optional): additional filter - payload
        wed_int1_start (string optional): additional filter - payload
        wed_int1_end (string optional): additional filter - payload
        wed_int2_start (string optional): additional filter - payload
        wed_int2_end (string optional): additional filter - payload
        thu_int1_start (string optional): additional filter - payload
        thu_int1_end (string optional): additional filter - payload
        thu_int2_start (string optional): additional filter - payload
        thu_int2_end (string optional): additional filter - payload
        fri_int1_start (string optional): additional filter - payload
        fri_int1_end (string optional): additional filter - payload
        fri_int2_start (string optional): additional filter - payload
        fri_int2_end (string optional): additional filter - payload
        sat_int1_start (string optional): additional filter - payload
        sat_int1_end (string optional): additional filter - payload
        sat_int2_start (string optional): additional filter - payload
        sat_int2_end (string optional): additional filter - payload
        sun_int1_start (string optional): additional filter - payload
        sun_int1_end (string optional): additional filter - payload
        sun_int2_start (string optional): additional filter - payload
        sun_int2_end (string optional): additional filter - payload

    Returns: list"""
    if kwargs is None:
        kwargs = dict()
    official_payload_list = ['name', 'timezone',
        'local_public_holidays', 'mon_int1_start', 'mon_int1_end',
        'mon_int2_start', 'mon_int2_end', 'tue_int1_start',
        'tue_int1_end', 'tue_int2_start', 'tue_int2_end',
        'wed_int1_start', 'wed_int1_end', 'wed_int2_start',
        'wed_int2_end', 'thu_int1_start', 'thu_int1_end',
        'thu_int2_start', 'thu_int2_end', 'fri_int1_start',
        'fri_int1_end', 'fri_int2_start', 'fri_int2_end',
        'sat_int1_start', 'sat_int1_end', 'sat_int2_start',
        'sat_int2_end', 'sun_int1_start', 'sun_int1_end',
        'sun_int2_start', 'sun_int2_end']
    payload.get('name'), payload.get('timezone'), payload.get(
        'local_public_holidays'), payload.get('mon_int1_start'
        ), payload.get('mon_int1_end'), payload.get('mon_int2_start'
        ), payload.get('mon_int2_end'), payload.get('tue_int1_start'
        ), payload.get('tue_int1_end'), payload.get('tue_int2_start'
        ), payload.get('tue_int2_end'), payload.get('wed_int1_start'
        ), payload.get('wed_int1_end'), payload.get('wed_int2_start'
        ), payload.get('wed_int2_end'), payload.get('thu_int1_start'
        ), payload.get('thu_int1_end'), payload.get('thu_int2_start'
        ), payload.get('thu_int2_end'), payload.get('fri_int1_start'
        ), payload.get('fri_int1_end'), payload.get('fri_int2_start'
        ), payload.get('fri_int2_end'), payload.get('sat_int1_start'
        ), payload.get('sat_int1_end'), payload.get('sat_int2_start'
        ), payload.get('sat_int2_end'), payload.get('sun_int1_start'
        ), payload.get('sun_int1_end'), payload.get('sun_int2_start'
        ), payload.get('sun_int2_end')
    if not self._silence_warning:
        warning_wrong_parameters(self.calendars_put.__name__, payload,
            official_payload_list)
    response = self.execute('PUT', path=f'/calendars/{uuid}', payload=
        payload, **kwargs)
    return response