scc-firewall-manager-sdk 1.15.222__py3-none-any.whl → 1.15.224__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of scc-firewall-manager-sdk might be problematic. Click here for more details.

@@ -18,9 +18,12 @@ from typing import Any, Dict, List, Optional, Tuple, Union
18
18
  from typing_extensions import Annotated
19
19
 
20
20
  from pydantic import Field, StrictStr
21
+ from typing import List, Optional
21
22
  from typing_extensions import Annotated
22
23
  from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
23
24
  from scc_firewall_manager_sdk.models.msp_calculate_compatible_upgrade_versions_input import MspCalculateCompatibleUpgradeVersionsInput
25
+ from scc_firewall_manager_sdk.models.msp_upgrade_run_dto import MspUpgradeRunDto
26
+ from scc_firewall_manager_sdk.models.msp_upgrade_run_dto_page import MspUpgradeRunDtoPage
24
27
  from scc_firewall_manager_sdk.models.upgrade_compatibility_info_dto import UpgradeCompatibilityInfoDto
25
28
 
26
29
  from scc_firewall_manager_sdk.api_client import ApiClient, RequestSerialized
@@ -330,6 +333,846 @@ class MSPDeviceUpgradesApi:
330
333
 
331
334
 
332
335
 
336
+ @validate_call
337
+ def delete_msp_device_upgrade_run(
338
+ self,
339
+ uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
340
+ _request_timeout: Union[
341
+ None,
342
+ Annotated[StrictFloat, Field(gt=0)],
343
+ Tuple[
344
+ Annotated[StrictFloat, Field(gt=0)],
345
+ Annotated[StrictFloat, Field(gt=0)]
346
+ ]
347
+ ] = None,
348
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
349
+ _content_type: Optional[StrictStr] = None,
350
+ _headers: Optional[Dict[StrictStr, Any]] = None,
351
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
352
+ ) -> None:
353
+ """Delete MSP Device Upgrade Run
354
+
355
+ Delete a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Warning: if you delete an upgrade run currently in progress, you may end up allowing multiple upgrades to be triggered on devices.
356
+
357
+ :param uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
358
+ :type uid: str
359
+ :param _request_timeout: timeout setting for this request. If one
360
+ number provided, it will be total request
361
+ timeout. It can also be a pair (tuple) of
362
+ (connection, read) timeouts.
363
+ :type _request_timeout: int, tuple(int, int), optional
364
+ :param _request_auth: set to override the auth_settings for an a single
365
+ request; this effectively ignores the
366
+ authentication in the spec for a single request.
367
+ :type _request_auth: dict, optional
368
+ :param _content_type: force content-type for the request.
369
+ :type _content_type: str, Optional
370
+ :param _headers: set to override the headers for a single
371
+ request; this effectively ignores the headers
372
+ in the spec for a single request.
373
+ :type _headers: dict, optional
374
+ :param _host_index: set to override the host_index for a single
375
+ request; this effectively ignores the host_index
376
+ in the spec for a single request.
377
+ :type _host_index: int, optional
378
+ :return: Returns the result object.
379
+ """ # noqa: E501
380
+
381
+ _param = self._delete_msp_device_upgrade_run_serialize(
382
+ uid=uid,
383
+ _request_auth=_request_auth,
384
+ _content_type=_content_type,
385
+ _headers=_headers,
386
+ _host_index=_host_index
387
+ )
388
+
389
+ _response_types_map: Dict[str, Optional[str]] = {
390
+ '204': None,
391
+ '500': "CommonApiError",
392
+ }
393
+ response_data = self.api_client.call_api(
394
+ *_param,
395
+ _request_timeout=_request_timeout
396
+ )
397
+ response_data.read()
398
+ return self.api_client.response_deserialize(
399
+ response_data=response_data,
400
+ response_types_map=_response_types_map,
401
+ ).data
402
+
403
+
404
+ @validate_call
405
+ def delete_msp_device_upgrade_run_with_http_info(
406
+ self,
407
+ uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
408
+ _request_timeout: Union[
409
+ None,
410
+ Annotated[StrictFloat, Field(gt=0)],
411
+ Tuple[
412
+ Annotated[StrictFloat, Field(gt=0)],
413
+ Annotated[StrictFloat, Field(gt=0)]
414
+ ]
415
+ ] = None,
416
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
417
+ _content_type: Optional[StrictStr] = None,
418
+ _headers: Optional[Dict[StrictStr, Any]] = None,
419
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
420
+ ) -> ApiResponse[None]:
421
+ """Delete MSP Device Upgrade Run
422
+
423
+ Delete a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Warning: if you delete an upgrade run currently in progress, you may end up allowing multiple upgrades to be triggered on devices.
424
+
425
+ :param uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
426
+ :type uid: str
427
+ :param _request_timeout: timeout setting for this request. If one
428
+ number provided, it will be total request
429
+ timeout. It can also be a pair (tuple) of
430
+ (connection, read) timeouts.
431
+ :type _request_timeout: int, tuple(int, int), optional
432
+ :param _request_auth: set to override the auth_settings for an a single
433
+ request; this effectively ignores the
434
+ authentication in the spec for a single request.
435
+ :type _request_auth: dict, optional
436
+ :param _content_type: force content-type for the request.
437
+ :type _content_type: str, Optional
438
+ :param _headers: set to override the headers for a single
439
+ request; this effectively ignores the headers
440
+ in the spec for a single request.
441
+ :type _headers: dict, optional
442
+ :param _host_index: set to override the host_index for a single
443
+ request; this effectively ignores the host_index
444
+ in the spec for a single request.
445
+ :type _host_index: int, optional
446
+ :return: Returns the result object.
447
+ """ # noqa: E501
448
+
449
+ _param = self._delete_msp_device_upgrade_run_serialize(
450
+ uid=uid,
451
+ _request_auth=_request_auth,
452
+ _content_type=_content_type,
453
+ _headers=_headers,
454
+ _host_index=_host_index
455
+ )
456
+
457
+ _response_types_map: Dict[str, Optional[str]] = {
458
+ '204': None,
459
+ '500': "CommonApiError",
460
+ }
461
+ response_data = self.api_client.call_api(
462
+ *_param,
463
+ _request_timeout=_request_timeout
464
+ )
465
+ response_data.read()
466
+ return self.api_client.response_deserialize(
467
+ response_data=response_data,
468
+ response_types_map=_response_types_map,
469
+ )
470
+
471
+
472
+ @validate_call
473
+ def delete_msp_device_upgrade_run_without_preload_content(
474
+ self,
475
+ uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
476
+ _request_timeout: Union[
477
+ None,
478
+ Annotated[StrictFloat, Field(gt=0)],
479
+ Tuple[
480
+ Annotated[StrictFloat, Field(gt=0)],
481
+ Annotated[StrictFloat, Field(gt=0)]
482
+ ]
483
+ ] = None,
484
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
485
+ _content_type: Optional[StrictStr] = None,
486
+ _headers: Optional[Dict[StrictStr, Any]] = None,
487
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
488
+ ) -> RESTResponseType:
489
+ """Delete MSP Device Upgrade Run
490
+
491
+ Delete a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Warning: if you delete an upgrade run currently in progress, you may end up allowing multiple upgrades to be triggered on devices.
492
+
493
+ :param uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
494
+ :type uid: str
495
+ :param _request_timeout: timeout setting for this request. If one
496
+ number provided, it will be total request
497
+ timeout. It can also be a pair (tuple) of
498
+ (connection, read) timeouts.
499
+ :type _request_timeout: int, tuple(int, int), optional
500
+ :param _request_auth: set to override the auth_settings for an a single
501
+ request; this effectively ignores the
502
+ authentication in the spec for a single request.
503
+ :type _request_auth: dict, optional
504
+ :param _content_type: force content-type for the request.
505
+ :type _content_type: str, Optional
506
+ :param _headers: set to override the headers for a single
507
+ request; this effectively ignores the headers
508
+ in the spec for a single request.
509
+ :type _headers: dict, optional
510
+ :param _host_index: set to override the host_index for a single
511
+ request; this effectively ignores the host_index
512
+ in the spec for a single request.
513
+ :type _host_index: int, optional
514
+ :return: Returns the result object.
515
+ """ # noqa: E501
516
+
517
+ _param = self._delete_msp_device_upgrade_run_serialize(
518
+ uid=uid,
519
+ _request_auth=_request_auth,
520
+ _content_type=_content_type,
521
+ _headers=_headers,
522
+ _host_index=_host_index
523
+ )
524
+
525
+ _response_types_map: Dict[str, Optional[str]] = {
526
+ '204': None,
527
+ '500': "CommonApiError",
528
+ }
529
+ response_data = self.api_client.call_api(
530
+ *_param,
531
+ _request_timeout=_request_timeout
532
+ )
533
+ return response_data.response
534
+
535
+
536
+ def _delete_msp_device_upgrade_run_serialize(
537
+ self,
538
+ uid,
539
+ _request_auth,
540
+ _content_type,
541
+ _headers,
542
+ _host_index,
543
+ ) -> RequestSerialized:
544
+
545
+ _host = None
546
+
547
+ _collection_formats: Dict[str, str] = {
548
+ }
549
+
550
+ _path_params: Dict[str, str] = {}
551
+ _query_params: List[Tuple[str, str]] = []
552
+ _header_params: Dict[str, Optional[str]] = _headers or {}
553
+ _form_params: List[Tuple[str, str]] = []
554
+ _files: Dict[str, str] = {}
555
+ _body_params: Optional[bytes] = None
556
+
557
+ # process the path parameters
558
+ if uid is not None:
559
+ _path_params['uid'] = uid
560
+ # process the query parameters
561
+ # process the header parameters
562
+ # process the form parameters
563
+ # process the body parameter
564
+
565
+
566
+ # set the HTTP header `Accept`
567
+ _header_params['Accept'] = self.api_client.select_header_accept(
568
+ [
569
+ 'application/json'
570
+ ]
571
+ )
572
+
573
+
574
+ # authentication setting
575
+ _auth_settings: List[str] = [
576
+ 'bearerAuth'
577
+ ]
578
+
579
+ return self.api_client.param_serialize(
580
+ method='DELETE',
581
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/runs/{uid}',
582
+ path_params=_path_params,
583
+ query_params=_query_params,
584
+ header_params=_header_params,
585
+ body=_body_params,
586
+ post_params=_form_params,
587
+ files=_files,
588
+ auth_settings=_auth_settings,
589
+ collection_formats=_collection_formats,
590
+ _host=_host,
591
+ _request_auth=_request_auth
592
+ )
593
+
594
+
595
+
596
+
597
+ @validate_call
598
+ def get_msp_device_upgrade_run(
599
+ self,
600
+ msp_upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
601
+ _request_timeout: Union[
602
+ None,
603
+ Annotated[StrictFloat, Field(gt=0)],
604
+ Tuple[
605
+ Annotated[StrictFloat, Field(gt=0)],
606
+ Annotated[StrictFloat, Field(gt=0)]
607
+ ]
608
+ ] = None,
609
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
610
+ _content_type: Optional[StrictStr] = None,
611
+ _headers: Optional[Dict[StrictStr, Any]] = None,
612
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
613
+ ) -> MspUpgradeRunDto:
614
+ """Get MSP Device Upgrade Run
615
+
616
+ Get a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
617
+
618
+ :param msp_upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
619
+ :type msp_upgrade_run_uid: str
620
+ :param _request_timeout: timeout setting for this request. If one
621
+ number provided, it will be total request
622
+ timeout. It can also be a pair (tuple) of
623
+ (connection, read) timeouts.
624
+ :type _request_timeout: int, tuple(int, int), optional
625
+ :param _request_auth: set to override the auth_settings for an a single
626
+ request; this effectively ignores the
627
+ authentication in the spec for a single request.
628
+ :type _request_auth: dict, optional
629
+ :param _content_type: force content-type for the request.
630
+ :type _content_type: str, Optional
631
+ :param _headers: set to override the headers for a single
632
+ request; this effectively ignores the headers
633
+ in the spec for a single request.
634
+ :type _headers: dict, optional
635
+ :param _host_index: set to override the host_index for a single
636
+ request; this effectively ignores the host_index
637
+ in the spec for a single request.
638
+ :type _host_index: int, optional
639
+ :return: Returns the result object.
640
+ """ # noqa: E501
641
+
642
+ _param = self._get_msp_device_upgrade_run_serialize(
643
+ msp_upgrade_run_uid=msp_upgrade_run_uid,
644
+ _request_auth=_request_auth,
645
+ _content_type=_content_type,
646
+ _headers=_headers,
647
+ _host_index=_host_index
648
+ )
649
+
650
+ _response_types_map: Dict[str, Optional[str]] = {
651
+ '200': "MspUpgradeRunDto",
652
+ '404': "CommonApiError",
653
+ '500': "CommonApiError",
654
+ }
655
+ response_data = self.api_client.call_api(
656
+ *_param,
657
+ _request_timeout=_request_timeout
658
+ )
659
+ response_data.read()
660
+ return self.api_client.response_deserialize(
661
+ response_data=response_data,
662
+ response_types_map=_response_types_map,
663
+ ).data
664
+
665
+
666
+ @validate_call
667
+ def get_msp_device_upgrade_run_with_http_info(
668
+ self,
669
+ msp_upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
670
+ _request_timeout: Union[
671
+ None,
672
+ Annotated[StrictFloat, Field(gt=0)],
673
+ Tuple[
674
+ Annotated[StrictFloat, Field(gt=0)],
675
+ Annotated[StrictFloat, Field(gt=0)]
676
+ ]
677
+ ] = None,
678
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
679
+ _content_type: Optional[StrictStr] = None,
680
+ _headers: Optional[Dict[StrictStr, Any]] = None,
681
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
682
+ ) -> ApiResponse[MspUpgradeRunDto]:
683
+ """Get MSP Device Upgrade Run
684
+
685
+ Get a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
686
+
687
+ :param msp_upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
688
+ :type msp_upgrade_run_uid: str
689
+ :param _request_timeout: timeout setting for this request. If one
690
+ number provided, it will be total request
691
+ timeout. It can also be a pair (tuple) of
692
+ (connection, read) timeouts.
693
+ :type _request_timeout: int, tuple(int, int), optional
694
+ :param _request_auth: set to override the auth_settings for an a single
695
+ request; this effectively ignores the
696
+ authentication in the spec for a single request.
697
+ :type _request_auth: dict, optional
698
+ :param _content_type: force content-type for the request.
699
+ :type _content_type: str, Optional
700
+ :param _headers: set to override the headers for a single
701
+ request; this effectively ignores the headers
702
+ in the spec for a single request.
703
+ :type _headers: dict, optional
704
+ :param _host_index: set to override the host_index for a single
705
+ request; this effectively ignores the host_index
706
+ in the spec for a single request.
707
+ :type _host_index: int, optional
708
+ :return: Returns the result object.
709
+ """ # noqa: E501
710
+
711
+ _param = self._get_msp_device_upgrade_run_serialize(
712
+ msp_upgrade_run_uid=msp_upgrade_run_uid,
713
+ _request_auth=_request_auth,
714
+ _content_type=_content_type,
715
+ _headers=_headers,
716
+ _host_index=_host_index
717
+ )
718
+
719
+ _response_types_map: Dict[str, Optional[str]] = {
720
+ '200': "MspUpgradeRunDto",
721
+ '404': "CommonApiError",
722
+ '500': "CommonApiError",
723
+ }
724
+ response_data = self.api_client.call_api(
725
+ *_param,
726
+ _request_timeout=_request_timeout
727
+ )
728
+ response_data.read()
729
+ return self.api_client.response_deserialize(
730
+ response_data=response_data,
731
+ response_types_map=_response_types_map,
732
+ )
733
+
734
+
735
+ @validate_call
736
+ def get_msp_device_upgrade_run_without_preload_content(
737
+ self,
738
+ msp_upgrade_run_uid: Annotated[StrictStr, Field(description="The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager.")],
739
+ _request_timeout: Union[
740
+ None,
741
+ Annotated[StrictFloat, Field(gt=0)],
742
+ Tuple[
743
+ Annotated[StrictFloat, Field(gt=0)],
744
+ Annotated[StrictFloat, Field(gt=0)]
745
+ ]
746
+ ] = None,
747
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
748
+ _content_type: Optional[StrictStr] = None,
749
+ _headers: Optional[Dict[StrictStr, Any]] = None,
750
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
751
+ ) -> RESTResponseType:
752
+ """Get MSP Device Upgrade Run
753
+
754
+ Get a MSP Device Upgrade Run by UID in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
755
+
756
+ :param msp_upgrade_run_uid: The unique identifier, represented as a UUID, of the FTD Device Upgrade Run in SCC Firewall Manager. (required)
757
+ :type msp_upgrade_run_uid: str
758
+ :param _request_timeout: timeout setting for this request. If one
759
+ number provided, it will be total request
760
+ timeout. It can also be a pair (tuple) of
761
+ (connection, read) timeouts.
762
+ :type _request_timeout: int, tuple(int, int), optional
763
+ :param _request_auth: set to override the auth_settings for an a single
764
+ request; this effectively ignores the
765
+ authentication in the spec for a single request.
766
+ :type _request_auth: dict, optional
767
+ :param _content_type: force content-type for the request.
768
+ :type _content_type: str, Optional
769
+ :param _headers: set to override the headers for a single
770
+ request; this effectively ignores the headers
771
+ in the spec for a single request.
772
+ :type _headers: dict, optional
773
+ :param _host_index: set to override the host_index for a single
774
+ request; this effectively ignores the host_index
775
+ in the spec for a single request.
776
+ :type _host_index: int, optional
777
+ :return: Returns the result object.
778
+ """ # noqa: E501
779
+
780
+ _param = self._get_msp_device_upgrade_run_serialize(
781
+ msp_upgrade_run_uid=msp_upgrade_run_uid,
782
+ _request_auth=_request_auth,
783
+ _content_type=_content_type,
784
+ _headers=_headers,
785
+ _host_index=_host_index
786
+ )
787
+
788
+ _response_types_map: Dict[str, Optional[str]] = {
789
+ '200': "MspUpgradeRunDto",
790
+ '404': "CommonApiError",
791
+ '500': "CommonApiError",
792
+ }
793
+ response_data = self.api_client.call_api(
794
+ *_param,
795
+ _request_timeout=_request_timeout
796
+ )
797
+ return response_data.response
798
+
799
+
800
+ def _get_msp_device_upgrade_run_serialize(
801
+ self,
802
+ msp_upgrade_run_uid,
803
+ _request_auth,
804
+ _content_type,
805
+ _headers,
806
+ _host_index,
807
+ ) -> RequestSerialized:
808
+
809
+ _host = None
810
+
811
+ _collection_formats: Dict[str, str] = {
812
+ }
813
+
814
+ _path_params: Dict[str, str] = {}
815
+ _query_params: List[Tuple[str, str]] = []
816
+ _header_params: Dict[str, Optional[str]] = _headers or {}
817
+ _form_params: List[Tuple[str, str]] = []
818
+ _files: Dict[str, str] = {}
819
+ _body_params: Optional[bytes] = None
820
+
821
+ # process the path parameters
822
+ if msp_upgrade_run_uid is not None:
823
+ _path_params['mspUpgradeRunUid'] = msp_upgrade_run_uid
824
+ # process the query parameters
825
+ # process the header parameters
826
+ # process the form parameters
827
+ # process the body parameter
828
+
829
+
830
+ # set the HTTP header `Accept`
831
+ _header_params['Accept'] = self.api_client.select_header_accept(
832
+ [
833
+ 'application/json'
834
+ ]
835
+ )
836
+
837
+
838
+ # authentication setting
839
+ _auth_settings: List[str] = [
840
+ 'bearerAuth'
841
+ ]
842
+
843
+ return self.api_client.param_serialize(
844
+ method='GET',
845
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/runs/{mspUpgradeRunUid}',
846
+ path_params=_path_params,
847
+ query_params=_query_params,
848
+ header_params=_header_params,
849
+ body=_body_params,
850
+ post_params=_form_params,
851
+ files=_files,
852
+ auth_settings=_auth_settings,
853
+ collection_formats=_collection_formats,
854
+ _host=_host,
855
+ _request_auth=_request_auth
856
+ )
857
+
858
+
859
+
860
+
861
+ @validate_call
862
+ def get_msp_device_upgrade_runs(
863
+ self,
864
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
865
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
866
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
867
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
868
+ _request_timeout: Union[
869
+ None,
870
+ Annotated[StrictFloat, Field(gt=0)],
871
+ Tuple[
872
+ Annotated[StrictFloat, Field(gt=0)],
873
+ Annotated[StrictFloat, Field(gt=0)]
874
+ ]
875
+ ] = None,
876
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
877
+ _content_type: Optional[StrictStr] = None,
878
+ _headers: Optional[Dict[StrictStr, Any]] = None,
879
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
880
+ ) -> MspUpgradeRunDtoPage:
881
+ """Get MSP Device Upgrade Runs
882
+
883
+ Get a list of MSP device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
884
+
885
+ :param limit: The number of results to retrieve.
886
+ :type limit: str
887
+ :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
888
+ :type offset: str
889
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
890
+ :type q: str
891
+ :param sort: The fields to sort results by.
892
+ :type sort: List[str]
893
+ :param _request_timeout: timeout setting for this request. If one
894
+ number provided, it will be total request
895
+ timeout. It can also be a pair (tuple) of
896
+ (connection, read) timeouts.
897
+ :type _request_timeout: int, tuple(int, int), optional
898
+ :param _request_auth: set to override the auth_settings for an a single
899
+ request; this effectively ignores the
900
+ authentication in the spec for a single request.
901
+ :type _request_auth: dict, optional
902
+ :param _content_type: force content-type for the request.
903
+ :type _content_type: str, Optional
904
+ :param _headers: set to override the headers for a single
905
+ request; this effectively ignores the headers
906
+ in the spec for a single request.
907
+ :type _headers: dict, optional
908
+ :param _host_index: set to override the host_index for a single
909
+ request; this effectively ignores the host_index
910
+ in the spec for a single request.
911
+ :type _host_index: int, optional
912
+ :return: Returns the result object.
913
+ """ # noqa: E501
914
+
915
+ _param = self._get_msp_device_upgrade_runs_serialize(
916
+ limit=limit,
917
+ offset=offset,
918
+ q=q,
919
+ sort=sort,
920
+ _request_auth=_request_auth,
921
+ _content_type=_content_type,
922
+ _headers=_headers,
923
+ _host_index=_host_index
924
+ )
925
+
926
+ _response_types_map: Dict[str, Optional[str]] = {
927
+ '200': "MspUpgradeRunDtoPage",
928
+ '500': "CommonApiError",
929
+ }
930
+ response_data = self.api_client.call_api(
931
+ *_param,
932
+ _request_timeout=_request_timeout
933
+ )
934
+ response_data.read()
935
+ return self.api_client.response_deserialize(
936
+ response_data=response_data,
937
+ response_types_map=_response_types_map,
938
+ ).data
939
+
940
+
941
+ @validate_call
942
+ def get_msp_device_upgrade_runs_with_http_info(
943
+ self,
944
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
945
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
946
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
947
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
948
+ _request_timeout: Union[
949
+ None,
950
+ Annotated[StrictFloat, Field(gt=0)],
951
+ Tuple[
952
+ Annotated[StrictFloat, Field(gt=0)],
953
+ Annotated[StrictFloat, Field(gt=0)]
954
+ ]
955
+ ] = None,
956
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
957
+ _content_type: Optional[StrictStr] = None,
958
+ _headers: Optional[Dict[StrictStr, Any]] = None,
959
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
960
+ ) -> ApiResponse[MspUpgradeRunDtoPage]:
961
+ """Get MSP Device Upgrade Runs
962
+
963
+ Get a list of MSP device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
964
+
965
+ :param limit: The number of results to retrieve.
966
+ :type limit: str
967
+ :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
968
+ :type offset: str
969
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
970
+ :type q: str
971
+ :param sort: The fields to sort results by.
972
+ :type sort: List[str]
973
+ :param _request_timeout: timeout setting for this request. If one
974
+ number provided, it will be total request
975
+ timeout. It can also be a pair (tuple) of
976
+ (connection, read) timeouts.
977
+ :type _request_timeout: int, tuple(int, int), optional
978
+ :param _request_auth: set to override the auth_settings for an a single
979
+ request; this effectively ignores the
980
+ authentication in the spec for a single request.
981
+ :type _request_auth: dict, optional
982
+ :param _content_type: force content-type for the request.
983
+ :type _content_type: str, Optional
984
+ :param _headers: set to override the headers for a single
985
+ request; this effectively ignores the headers
986
+ in the spec for a single request.
987
+ :type _headers: dict, optional
988
+ :param _host_index: set to override the host_index for a single
989
+ request; this effectively ignores the host_index
990
+ in the spec for a single request.
991
+ :type _host_index: int, optional
992
+ :return: Returns the result object.
993
+ """ # noqa: E501
994
+
995
+ _param = self._get_msp_device_upgrade_runs_serialize(
996
+ limit=limit,
997
+ offset=offset,
998
+ q=q,
999
+ sort=sort,
1000
+ _request_auth=_request_auth,
1001
+ _content_type=_content_type,
1002
+ _headers=_headers,
1003
+ _host_index=_host_index
1004
+ )
1005
+
1006
+ _response_types_map: Dict[str, Optional[str]] = {
1007
+ '200': "MspUpgradeRunDtoPage",
1008
+ '500': "CommonApiError",
1009
+ }
1010
+ response_data = self.api_client.call_api(
1011
+ *_param,
1012
+ _request_timeout=_request_timeout
1013
+ )
1014
+ response_data.read()
1015
+ return self.api_client.response_deserialize(
1016
+ response_data=response_data,
1017
+ response_types_map=_response_types_map,
1018
+ )
1019
+
1020
+
1021
+ @validate_call
1022
+ def get_msp_device_upgrade_runs_without_preload_content(
1023
+ self,
1024
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
1025
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
1026
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
1027
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
1028
+ _request_timeout: Union[
1029
+ None,
1030
+ Annotated[StrictFloat, Field(gt=0)],
1031
+ Tuple[
1032
+ Annotated[StrictFloat, Field(gt=0)],
1033
+ Annotated[StrictFloat, Field(gt=0)]
1034
+ ]
1035
+ ] = None,
1036
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1037
+ _content_type: Optional[StrictStr] = None,
1038
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1039
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1040
+ ) -> RESTResponseType:
1041
+ """Get MSP Device Upgrade Runs
1042
+
1043
+ Get a list of MSP device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices across multiple managed tenants being upgraded, or staged for upgrades, together.
1044
+
1045
+ :param limit: The number of results to retrieve.
1046
+ :type limit: str
1047
+ :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
1048
+ :type offset: str
1049
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
1050
+ :type q: str
1051
+ :param sort: The fields to sort results by.
1052
+ :type sort: List[str]
1053
+ :param _request_timeout: timeout setting for this request. If one
1054
+ number provided, it will be total request
1055
+ timeout. It can also be a pair (tuple) of
1056
+ (connection, read) timeouts.
1057
+ :type _request_timeout: int, tuple(int, int), optional
1058
+ :param _request_auth: set to override the auth_settings for an a single
1059
+ request; this effectively ignores the
1060
+ authentication in the spec for a single request.
1061
+ :type _request_auth: dict, optional
1062
+ :param _content_type: force content-type for the request.
1063
+ :type _content_type: str, Optional
1064
+ :param _headers: set to override the headers for a single
1065
+ request; this effectively ignores the headers
1066
+ in the spec for a single request.
1067
+ :type _headers: dict, optional
1068
+ :param _host_index: set to override the host_index for a single
1069
+ request; this effectively ignores the host_index
1070
+ in the spec for a single request.
1071
+ :type _host_index: int, optional
1072
+ :return: Returns the result object.
1073
+ """ # noqa: E501
1074
+
1075
+ _param = self._get_msp_device_upgrade_runs_serialize(
1076
+ limit=limit,
1077
+ offset=offset,
1078
+ q=q,
1079
+ sort=sort,
1080
+ _request_auth=_request_auth,
1081
+ _content_type=_content_type,
1082
+ _headers=_headers,
1083
+ _host_index=_host_index
1084
+ )
1085
+
1086
+ _response_types_map: Dict[str, Optional[str]] = {
1087
+ '200': "MspUpgradeRunDtoPage",
1088
+ '500': "CommonApiError",
1089
+ }
1090
+ response_data = self.api_client.call_api(
1091
+ *_param,
1092
+ _request_timeout=_request_timeout
1093
+ )
1094
+ return response_data.response
1095
+
1096
+
1097
+ def _get_msp_device_upgrade_runs_serialize(
1098
+ self,
1099
+ limit,
1100
+ offset,
1101
+ q,
1102
+ sort,
1103
+ _request_auth,
1104
+ _content_type,
1105
+ _headers,
1106
+ _host_index,
1107
+ ) -> RequestSerialized:
1108
+
1109
+ _host = None
1110
+
1111
+ _collection_formats: Dict[str, str] = {
1112
+ 'sort': 'multi',
1113
+ }
1114
+
1115
+ _path_params: Dict[str, str] = {}
1116
+ _query_params: List[Tuple[str, str]] = []
1117
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1118
+ _form_params: List[Tuple[str, str]] = []
1119
+ _files: Dict[str, str] = {}
1120
+ _body_params: Optional[bytes] = None
1121
+
1122
+ # process the path parameters
1123
+ # process the query parameters
1124
+ if limit is not None:
1125
+
1126
+ _query_params.append(('limit', limit))
1127
+
1128
+ if offset is not None:
1129
+
1130
+ _query_params.append(('offset', offset))
1131
+
1132
+ if q is not None:
1133
+
1134
+ _query_params.append(('q', q))
1135
+
1136
+ if sort is not None:
1137
+
1138
+ _query_params.append(('sort', sort))
1139
+
1140
+ # process the header parameters
1141
+ # process the form parameters
1142
+ # process the body parameter
1143
+
1144
+
1145
+ # set the HTTP header `Accept`
1146
+ _header_params['Accept'] = self.api_client.select_header_accept(
1147
+ [
1148
+ 'application/json'
1149
+ ]
1150
+ )
1151
+
1152
+
1153
+ # authentication setting
1154
+ _auth_settings: List[str] = [
1155
+ 'bearerAuth'
1156
+ ]
1157
+
1158
+ return self.api_client.param_serialize(
1159
+ method='GET',
1160
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/runs',
1161
+ path_params=_path_params,
1162
+ query_params=_query_params,
1163
+ header_params=_header_params,
1164
+ body=_body_params,
1165
+ post_params=_form_params,
1166
+ files=_files,
1167
+ auth_settings=_auth_settings,
1168
+ collection_formats=_collection_formats,
1169
+ _host=_host,
1170
+ _request_auth=_request_auth
1171
+ )
1172
+
1173
+
1174
+
1175
+
333
1176
  @validate_call
334
1177
  def get_msp_ftd_compatible_upgrade_versions(
335
1178
  self,
@@ -601,3 +1444,249 @@ class MSPDeviceUpgradesApi:
601
1444
  )
602
1445
 
603
1446
 
1447
+
1448
+
1449
+ @validate_call
1450
+ def upgrade_msp_managed_ftd_devices(
1451
+ self,
1452
+ _request_timeout: Union[
1453
+ None,
1454
+ Annotated[StrictFloat, Field(gt=0)],
1455
+ Tuple[
1456
+ Annotated[StrictFloat, Field(gt=0)],
1457
+ Annotated[StrictFloat, Field(gt=0)]
1458
+ ]
1459
+ ] = None,
1460
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1461
+ _content_type: Optional[StrictStr] = None,
1462
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1463
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1464
+ ) -> CdoTransaction:
1465
+ """Upgrade multiple FTDs across multiple tenants
1466
+
1467
+ <p>Asynchronous operation to upgrade multiple FTD devices across managed tenants.</p> <p><strong>Notes:</strong></p> <ul> <li>Maximum of 50 FTD devices per hardware model per managed tenant per request</li> </ul> <p><strong>Response:</strong></p> <ul> <li>Returns a transaction object to track upgrade operation progress</li> <li>Use the transaction ID or the entity UID to monitor the status of the upgrade</li> </ul>
1468
+
1469
+ :param _request_timeout: timeout setting for this request. If one
1470
+ number provided, it will be total request
1471
+ timeout. It can also be a pair (tuple) of
1472
+ (connection, read) timeouts.
1473
+ :type _request_timeout: int, tuple(int, int), optional
1474
+ :param _request_auth: set to override the auth_settings for an a single
1475
+ request; this effectively ignores the
1476
+ authentication in the spec for a single request.
1477
+ :type _request_auth: dict, optional
1478
+ :param _content_type: force content-type for the request.
1479
+ :type _content_type: str, Optional
1480
+ :param _headers: set to override the headers for a single
1481
+ request; this effectively ignores the headers
1482
+ in the spec for a single request.
1483
+ :type _headers: dict, optional
1484
+ :param _host_index: set to override the host_index for a single
1485
+ request; this effectively ignores the host_index
1486
+ in the spec for a single request.
1487
+ :type _host_index: int, optional
1488
+ :return: Returns the result object.
1489
+ """ # noqa: E501
1490
+
1491
+ _param = self._upgrade_msp_managed_ftd_devices_serialize(
1492
+ _request_auth=_request_auth,
1493
+ _content_type=_content_type,
1494
+ _headers=_headers,
1495
+ _host_index=_host_index
1496
+ )
1497
+
1498
+ _response_types_map: Dict[str, Optional[str]] = {
1499
+ '202': "CdoTransaction",
1500
+ '500': "CommonApiError",
1501
+ }
1502
+ response_data = self.api_client.call_api(
1503
+ *_param,
1504
+ _request_timeout=_request_timeout
1505
+ )
1506
+ response_data.read()
1507
+ return self.api_client.response_deserialize(
1508
+ response_data=response_data,
1509
+ response_types_map=_response_types_map,
1510
+ ).data
1511
+
1512
+
1513
+ @validate_call
1514
+ def upgrade_msp_managed_ftd_devices_with_http_info(
1515
+ self,
1516
+ _request_timeout: Union[
1517
+ None,
1518
+ Annotated[StrictFloat, Field(gt=0)],
1519
+ Tuple[
1520
+ Annotated[StrictFloat, Field(gt=0)],
1521
+ Annotated[StrictFloat, Field(gt=0)]
1522
+ ]
1523
+ ] = None,
1524
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1525
+ _content_type: Optional[StrictStr] = None,
1526
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1527
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1528
+ ) -> ApiResponse[CdoTransaction]:
1529
+ """Upgrade multiple FTDs across multiple tenants
1530
+
1531
+ <p>Asynchronous operation to upgrade multiple FTD devices across managed tenants.</p> <p><strong>Notes:</strong></p> <ul> <li>Maximum of 50 FTD devices per hardware model per managed tenant per request</li> </ul> <p><strong>Response:</strong></p> <ul> <li>Returns a transaction object to track upgrade operation progress</li> <li>Use the transaction ID or the entity UID to monitor the status of the upgrade</li> </ul>
1532
+
1533
+ :param _request_timeout: timeout setting for this request. If one
1534
+ number provided, it will be total request
1535
+ timeout. It can also be a pair (tuple) of
1536
+ (connection, read) timeouts.
1537
+ :type _request_timeout: int, tuple(int, int), optional
1538
+ :param _request_auth: set to override the auth_settings for an a single
1539
+ request; this effectively ignores the
1540
+ authentication in the spec for a single request.
1541
+ :type _request_auth: dict, optional
1542
+ :param _content_type: force content-type for the request.
1543
+ :type _content_type: str, Optional
1544
+ :param _headers: set to override the headers for a single
1545
+ request; this effectively ignores the headers
1546
+ in the spec for a single request.
1547
+ :type _headers: dict, optional
1548
+ :param _host_index: set to override the host_index for a single
1549
+ request; this effectively ignores the host_index
1550
+ in the spec for a single request.
1551
+ :type _host_index: int, optional
1552
+ :return: Returns the result object.
1553
+ """ # noqa: E501
1554
+
1555
+ _param = self._upgrade_msp_managed_ftd_devices_serialize(
1556
+ _request_auth=_request_auth,
1557
+ _content_type=_content_type,
1558
+ _headers=_headers,
1559
+ _host_index=_host_index
1560
+ )
1561
+
1562
+ _response_types_map: Dict[str, Optional[str]] = {
1563
+ '202': "CdoTransaction",
1564
+ '500': "CommonApiError",
1565
+ }
1566
+ response_data = self.api_client.call_api(
1567
+ *_param,
1568
+ _request_timeout=_request_timeout
1569
+ )
1570
+ response_data.read()
1571
+ return self.api_client.response_deserialize(
1572
+ response_data=response_data,
1573
+ response_types_map=_response_types_map,
1574
+ )
1575
+
1576
+
1577
+ @validate_call
1578
+ def upgrade_msp_managed_ftd_devices_without_preload_content(
1579
+ self,
1580
+ _request_timeout: Union[
1581
+ None,
1582
+ Annotated[StrictFloat, Field(gt=0)],
1583
+ Tuple[
1584
+ Annotated[StrictFloat, Field(gt=0)],
1585
+ Annotated[StrictFloat, Field(gt=0)]
1586
+ ]
1587
+ ] = None,
1588
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1589
+ _content_type: Optional[StrictStr] = None,
1590
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1591
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1592
+ ) -> RESTResponseType:
1593
+ """Upgrade multiple FTDs across multiple tenants
1594
+
1595
+ <p>Asynchronous operation to upgrade multiple FTD devices across managed tenants.</p> <p><strong>Notes:</strong></p> <ul> <li>Maximum of 50 FTD devices per hardware model per managed tenant per request</li> </ul> <p><strong>Response:</strong></p> <ul> <li>Returns a transaction object to track upgrade operation progress</li> <li>Use the transaction ID or the entity UID to monitor the status of the upgrade</li> </ul>
1596
+
1597
+ :param _request_timeout: timeout setting for this request. If one
1598
+ number provided, it will be total request
1599
+ timeout. It can also be a pair (tuple) of
1600
+ (connection, read) timeouts.
1601
+ :type _request_timeout: int, tuple(int, int), optional
1602
+ :param _request_auth: set to override the auth_settings for an a single
1603
+ request; this effectively ignores the
1604
+ authentication in the spec for a single request.
1605
+ :type _request_auth: dict, optional
1606
+ :param _content_type: force content-type for the request.
1607
+ :type _content_type: str, Optional
1608
+ :param _headers: set to override the headers for a single
1609
+ request; this effectively ignores the headers
1610
+ in the spec for a single request.
1611
+ :type _headers: dict, optional
1612
+ :param _host_index: set to override the host_index for a single
1613
+ request; this effectively ignores the host_index
1614
+ in the spec for a single request.
1615
+ :type _host_index: int, optional
1616
+ :return: Returns the result object.
1617
+ """ # noqa: E501
1618
+
1619
+ _param = self._upgrade_msp_managed_ftd_devices_serialize(
1620
+ _request_auth=_request_auth,
1621
+ _content_type=_content_type,
1622
+ _headers=_headers,
1623
+ _host_index=_host_index
1624
+ )
1625
+
1626
+ _response_types_map: Dict[str, Optional[str]] = {
1627
+ '202': "CdoTransaction",
1628
+ '500': "CommonApiError",
1629
+ }
1630
+ response_data = self.api_client.call_api(
1631
+ *_param,
1632
+ _request_timeout=_request_timeout
1633
+ )
1634
+ return response_data.response
1635
+
1636
+
1637
+ def _upgrade_msp_managed_ftd_devices_serialize(
1638
+ self,
1639
+ _request_auth,
1640
+ _content_type,
1641
+ _headers,
1642
+ _host_index,
1643
+ ) -> RequestSerialized:
1644
+
1645
+ _host = None
1646
+
1647
+ _collection_formats: Dict[str, str] = {
1648
+ }
1649
+
1650
+ _path_params: Dict[str, str] = {}
1651
+ _query_params: List[Tuple[str, str]] = []
1652
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1653
+ _form_params: List[Tuple[str, str]] = []
1654
+ _files: Dict[str, str] = {}
1655
+ _body_params: Optional[bytes] = None
1656
+
1657
+ # process the path parameters
1658
+ # process the query parameters
1659
+ # process the header parameters
1660
+ # process the form parameters
1661
+ # process the body parameter
1662
+
1663
+
1664
+ # set the HTTP header `Accept`
1665
+ _header_params['Accept'] = self.api_client.select_header_accept(
1666
+ [
1667
+ 'application/json'
1668
+ ]
1669
+ )
1670
+
1671
+
1672
+ # authentication setting
1673
+ _auth_settings: List[str] = [
1674
+ 'bearerAuth'
1675
+ ]
1676
+
1677
+ return self.api_client.param_serialize(
1678
+ method='POST',
1679
+ resource_path='/v1/msp/inventory/devices/ftds/upgrades/trigger',
1680
+ path_params=_path_params,
1681
+ query_params=_query_params,
1682
+ header_params=_header_params,
1683
+ body=_body_params,
1684
+ post_params=_form_params,
1685
+ files=_files,
1686
+ auth_settings=_auth_settings,
1687
+ collection_formats=_collection_formats,
1688
+ _host=_host,
1689
+ _request_auth=_request_auth
1690
+ )
1691
+
1692
+