edge-impulse-api 1.40.3 → 1.40.11
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.
|
@@ -384,7 +384,7 @@ export declare class OrganizationsApi {
|
|
|
384
384
|
}): Promise<UploadReadmeImageResponse>;
|
|
385
385
|
/**
|
|
386
386
|
* White label admin only API to add a development board.
|
|
387
|
-
* @summary Add a development board to a whitelabel
|
|
387
|
+
* @summary White Label Admin - Add a development board to a whitelabel
|
|
388
388
|
* @param organizationId Organization ID
|
|
389
389
|
* @param developmentBoardRequest
|
|
390
390
|
*/
|
|
@@ -395,7 +395,7 @@ export declare class OrganizationsApi {
|
|
|
395
395
|
}): Promise<DevelopmentBoardCreatedResponse>;
|
|
396
396
|
/**
|
|
397
397
|
* White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.
|
|
398
|
-
* @summary Add organization API key
|
|
398
|
+
* @summary White Label Admin - Add organization API key
|
|
399
399
|
* @param organizationId Organization ID
|
|
400
400
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
401
401
|
* @param adminAddOrganizationApiKeyRequest
|
|
@@ -407,7 +407,7 @@ export declare class OrganizationsApi {
|
|
|
407
407
|
}): Promise<GenericApiResponse>;
|
|
408
408
|
/**
|
|
409
409
|
* White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.
|
|
410
|
-
* @summary Add Project API key
|
|
410
|
+
* @summary White Label Admin - Add Project API key
|
|
411
411
|
* @param organizationId Organization ID
|
|
412
412
|
* @param projectId Project ID
|
|
413
413
|
* @param adminAddProjectApiKeyRequest
|
|
@@ -419,7 +419,7 @@ export declare class OrganizationsApi {
|
|
|
419
419
|
}): Promise<GenericApiResponse>;
|
|
420
420
|
/**
|
|
421
421
|
* White label admin only API to add a user to an organization. If no user is provided, the current user is used.
|
|
422
|
-
* @summary Add user to an organization
|
|
422
|
+
* @summary White Label Admin - Add user to an organization
|
|
423
423
|
* @param organizationId Organization ID
|
|
424
424
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
425
425
|
* @param adminAddOrganizationUserRequest
|
|
@@ -431,7 +431,7 @@ export declare class OrganizationsApi {
|
|
|
431
431
|
}): Promise<GenericApiResponse>;
|
|
432
432
|
/**
|
|
433
433
|
* White label admin only API to add a user to a project. If no user is provided, the current user is used.
|
|
434
|
-
* @summary Add user to a project
|
|
434
|
+
* @summary White Label Admin - Add user to a project
|
|
435
435
|
* @param organizationId Organization ID
|
|
436
436
|
* @param projectId Project ID
|
|
437
437
|
* @param adminAddProjectUserRequest
|
|
@@ -443,7 +443,7 @@ export declare class OrganizationsApi {
|
|
|
443
443
|
}): Promise<GenericApiResponse>;
|
|
444
444
|
/**
|
|
445
445
|
* Create a new organization. This is an internal API only available to white label admins
|
|
446
|
-
* @summary Create new organization within white label context
|
|
446
|
+
* @summary White Label Admin - Create new organization within white label context
|
|
447
447
|
* @param organizationId Organization ID
|
|
448
448
|
* @param whitelabelAdminCreateOrganizationRequest
|
|
449
449
|
*/
|
|
@@ -454,7 +454,7 @@ export declare class OrganizationsApi {
|
|
|
454
454
|
}): Promise<CreateOrganizationResponse>;
|
|
455
455
|
/**
|
|
456
456
|
* White label admin only API to create a new project for an organization.
|
|
457
|
-
* @summary Create a new organization project
|
|
457
|
+
* @summary White Label Admin - Create a new organization project
|
|
458
458
|
* @param organizationId Organization ID
|
|
459
459
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
460
460
|
* @param adminCreateProjectRequest
|
|
@@ -466,7 +466,7 @@ export declare class OrganizationsApi {
|
|
|
466
466
|
}): Promise<CreateProjectResponse>;
|
|
467
467
|
/**
|
|
468
468
|
* Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an internal API only available to white label admins.
|
|
469
|
-
* @summary Creates a new usage report
|
|
469
|
+
* @summary White Label Admin - Creates a new usage report
|
|
470
470
|
* @param organizationId Organization ID
|
|
471
471
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
472
472
|
* @param startDate Start date
|
|
@@ -479,7 +479,7 @@ export declare class OrganizationsApi {
|
|
|
479
479
|
}): Promise<StartJobResponse>;
|
|
480
480
|
/**
|
|
481
481
|
* Create a new free tier project. This is an internal API only available to white label admins.
|
|
482
|
-
* @summary Create a new project within white label context.
|
|
482
|
+
* @summary White Label Admin - Create a new project within white label context.
|
|
483
483
|
* @param organizationId Organization ID
|
|
484
484
|
* @param adminCreateProjectRequest
|
|
485
485
|
*/
|
|
@@ -490,7 +490,7 @@ export declare class OrganizationsApi {
|
|
|
490
490
|
}): Promise<CreateProjectResponse>;
|
|
491
491
|
/**
|
|
492
492
|
* White label admin only API to delete an organization.
|
|
493
|
-
* @summary Delete an organization
|
|
493
|
+
* @summary White Label Admin - Delete an organization
|
|
494
494
|
* @param organizationId Organization ID
|
|
495
495
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
496
496
|
*/
|
|
@@ -501,7 +501,7 @@ export declare class OrganizationsApi {
|
|
|
501
501
|
}): Promise<GenericApiResponse>;
|
|
502
502
|
/**
|
|
503
503
|
* Delete a usage report for an organization. This is an internal API only available to white label admins.
|
|
504
|
-
* @summary Delete usage report
|
|
504
|
+
* @summary White Label Admin - Delete usage report
|
|
505
505
|
* @param organizationId Organization ID
|
|
506
506
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
507
507
|
* @param usageReportId Usage report ID
|
|
@@ -513,7 +513,7 @@ export declare class OrganizationsApi {
|
|
|
513
513
|
}): Promise<GenericApiResponse>;
|
|
514
514
|
/**
|
|
515
515
|
* White label admin only API to delete a project.
|
|
516
|
-
* @summary Delete a project
|
|
516
|
+
* @summary White Label Admin - Delete a project
|
|
517
517
|
* @param organizationId Organization ID
|
|
518
518
|
* @param projectId Project ID
|
|
519
519
|
*/
|
|
@@ -524,7 +524,7 @@ export declare class OrganizationsApi {
|
|
|
524
524
|
}): Promise<GenericApiResponse>;
|
|
525
525
|
/**
|
|
526
526
|
* Download a usage report for an organization. This is an internal API only available to white label admins.
|
|
527
|
-
* @summary Download usage report
|
|
527
|
+
* @summary White Label Admin - Download usage report
|
|
528
528
|
* @param organizationId Organization ID
|
|
529
529
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
530
530
|
* @param usageReportId Usage report ID
|
|
@@ -536,7 +536,7 @@ export declare class OrganizationsApi {
|
|
|
536
536
|
}): Promise<any>;
|
|
537
537
|
/**
|
|
538
538
|
* White label admin only API to get the white label information.
|
|
539
|
-
* @summary Get white label information
|
|
539
|
+
* @summary White Label Admin - Get white label information
|
|
540
540
|
* @param organizationId Organization ID
|
|
541
541
|
*/
|
|
542
542
|
whitelabelAdminGetInfo(organizationId: number, options?: {
|
|
@@ -546,7 +546,7 @@ export declare class OrganizationsApi {
|
|
|
546
546
|
}): Promise<GetWhitelabelResponse>;
|
|
547
547
|
/**
|
|
548
548
|
* White label admin only API to get global metrics.
|
|
549
|
-
* @summary Get global white label metrics
|
|
549
|
+
* @summary White Label Admin - Get global white label metrics
|
|
550
550
|
* @param organizationId Organization ID
|
|
551
551
|
*/
|
|
552
552
|
whitelabelAdminGetMetrics(organizationId: number, options?: {
|
|
@@ -556,7 +556,7 @@ export declare class OrganizationsApi {
|
|
|
556
556
|
}): Promise<AdminGetMetricsResponse>;
|
|
557
557
|
/**
|
|
558
558
|
* Get compute time usage for an organization over a period of time. This is an internal API only available to white label admins
|
|
559
|
-
* @summary Get organization compute time usage
|
|
559
|
+
* @summary White Label Admin - Get organization compute time usage
|
|
560
560
|
* @param organizationId Organization ID
|
|
561
561
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
562
562
|
* @param startDate Start date
|
|
@@ -569,7 +569,7 @@ export declare class OrganizationsApi {
|
|
|
569
569
|
}): Promise<AdminGetOrganizationComputeTimeUsageResponse>;
|
|
570
570
|
/**
|
|
571
571
|
* White label admin only API to list all information about an organization.
|
|
572
|
-
* @summary Get organization information
|
|
572
|
+
* @summary White Label Admin - Get organization information
|
|
573
573
|
* @param organizationId Organization ID
|
|
574
574
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
575
575
|
* @param includeDeleted Whether to include deleted entities (users, projects, orgs)
|
|
@@ -581,7 +581,7 @@ export declare class OrganizationsApi {
|
|
|
581
581
|
}): Promise<AdminOrganizationInfoResponse>;
|
|
582
582
|
/**
|
|
583
583
|
* Get a usage report for an organization. This is an internal API only available to white label admins.
|
|
584
|
-
* @summary Get usage report
|
|
584
|
+
* @summary White Label Admin - Get usage report
|
|
585
585
|
* @param organizationId Organization ID
|
|
586
586
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
587
587
|
* @param usageReportId Usage report ID
|
|
@@ -593,7 +593,7 @@ export declare class OrganizationsApi {
|
|
|
593
593
|
}): Promise<AdminGetOrganizationUsageReportResponse>;
|
|
594
594
|
/**
|
|
595
595
|
* Get all usage reports for an organization. This is an internal API only available to white label admins.
|
|
596
|
-
* @summary Get all usage reports
|
|
596
|
+
* @summary White Label Admin - Get all usage reports
|
|
597
597
|
* @param organizationId Organization ID
|
|
598
598
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
599
599
|
* @param limit Maximum number of results
|
|
@@ -606,7 +606,7 @@ export declare class OrganizationsApi {
|
|
|
606
606
|
}): Promise<AdminGetOrganizationUsageReportsResponse>;
|
|
607
607
|
/**
|
|
608
608
|
* White label admin only API to get the list of all organizations.
|
|
609
|
-
* @summary Get all organizations within a white label
|
|
609
|
+
* @summary White Label Admin - Get all organizations within a white label
|
|
610
610
|
* @param organizationId Organization ID
|
|
611
611
|
* @param active Whether to search for entities (users, orgs) active in the last X days
|
|
612
612
|
* @param includeDeleted Whether to include deleted entities (users, projects, orgs)
|
|
@@ -622,7 +622,7 @@ export declare class OrganizationsApi {
|
|
|
622
622
|
}): Promise<AdminGetOrganizationsResponse>;
|
|
623
623
|
/**
|
|
624
624
|
* White label admin only API to get project information.
|
|
625
|
-
* @summary Get a white label project
|
|
625
|
+
* @summary White Label Admin - Get a white label project
|
|
626
626
|
* @param organizationId Organization ID
|
|
627
627
|
* @param projectId Project ID
|
|
628
628
|
*/
|
|
@@ -633,7 +633,7 @@ export declare class OrganizationsApi {
|
|
|
633
633
|
}): Promise<ProjectInfoResponse>;
|
|
634
634
|
/**
|
|
635
635
|
* White label admin only API to get the list of all projects.
|
|
636
|
-
* @summary Get all white label projects
|
|
636
|
+
* @summary White Label Admin - Get all white label projects
|
|
637
637
|
* @param organizationId Organization ID
|
|
638
638
|
* @param active Whether to search for entities (users, orgs) active in the last X days
|
|
639
639
|
* @param sort Fields and order to sort query by
|
|
@@ -648,7 +648,7 @@ export declare class OrganizationsApi {
|
|
|
648
648
|
}): Promise<AdminListProjectsResponse>;
|
|
649
649
|
/**
|
|
650
650
|
* White label admin only API to get information about a user.
|
|
651
|
-
* @summary Get a white label user
|
|
651
|
+
* @summary White Label Admin - Get a white label user
|
|
652
652
|
* @param organizationId Organization ID
|
|
653
653
|
* @param userId User ID
|
|
654
654
|
*/
|
|
@@ -659,7 +659,7 @@ export declare class OrganizationsApi {
|
|
|
659
659
|
}): Promise<AdminGetUserResponse>;
|
|
660
660
|
/**
|
|
661
661
|
* White label admin only API to get marketing metrics about a user.
|
|
662
|
-
* @summary Get white label user metrics
|
|
662
|
+
* @summary White Label Admin - Get white label user metrics
|
|
663
663
|
* @param organizationId Organization ID
|
|
664
664
|
* @param userId User ID
|
|
665
665
|
*/
|
|
@@ -670,7 +670,7 @@ export declare class OrganizationsApi {
|
|
|
670
670
|
}): Promise<AdminGetUserMetricsResponse>;
|
|
671
671
|
/**
|
|
672
672
|
* White label admin only API to get the list of all registered users.
|
|
673
|
-
* @summary Get all white label users
|
|
673
|
+
* @summary White Label Admin - Get all white label users
|
|
674
674
|
* @param organizationId Organization ID
|
|
675
675
|
* @param active Whether to search for entities (users, orgs) active in the last X days
|
|
676
676
|
* @param tier Whether to search for free, pro or enterprise entities (users, projects)
|
|
@@ -687,7 +687,7 @@ export declare class OrganizationsApi {
|
|
|
687
687
|
}): Promise<AdminGetUsersResponse>;
|
|
688
688
|
/**
|
|
689
689
|
* White label admin only API to remove a development board.
|
|
690
|
-
* @summary Remove a development board from a whitelabel
|
|
690
|
+
* @summary White Label Admin - Remove a development board from a whitelabel
|
|
691
691
|
* @param organizationId Organization ID
|
|
692
692
|
* @param developmentBoardId Development board ID.
|
|
693
693
|
*/
|
|
@@ -698,7 +698,7 @@ export declare class OrganizationsApi {
|
|
|
698
698
|
}): Promise<GenericApiResponse>;
|
|
699
699
|
/**
|
|
700
700
|
* White label admin only API to remove a user from an organization.
|
|
701
|
-
* @summary Remove user from an organization
|
|
701
|
+
* @summary White Label Admin - Remove user from an organization
|
|
702
702
|
* @param organizationId Organization ID
|
|
703
703
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
704
704
|
* @param userId User ID
|
|
@@ -710,7 +710,7 @@ export declare class OrganizationsApi {
|
|
|
710
710
|
}): Promise<GenericApiResponse>;
|
|
711
711
|
/**
|
|
712
712
|
* White label admin only API to remove a user from a project.
|
|
713
|
-
* @summary Remove user from a project
|
|
713
|
+
* @summary White Label Admin - Remove user from a project
|
|
714
714
|
* @param organizationId Organization ID
|
|
715
715
|
* @param projectId Project ID
|
|
716
716
|
* @param userId User ID
|
|
@@ -722,7 +722,7 @@ export declare class OrganizationsApi {
|
|
|
722
722
|
}): Promise<GenericApiResponse>;
|
|
723
723
|
/**
|
|
724
724
|
* White label admin only API to restore a deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.
|
|
725
|
-
* @summary Restore an organization
|
|
725
|
+
* @summary White Label Admin - Restore an organization
|
|
726
726
|
* @param organizationId Organization ID
|
|
727
727
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
728
728
|
*/
|
|
@@ -733,7 +733,7 @@ export declare class OrganizationsApi {
|
|
|
733
733
|
}): Promise<GenericApiResponse>;
|
|
734
734
|
/**
|
|
735
735
|
* White label admin only API to update the default deployment target for this white label.
|
|
736
|
-
* @summary Update default deployment target
|
|
736
|
+
* @summary White Label Admin - Update default deployment target
|
|
737
737
|
* @param organizationId Organization ID
|
|
738
738
|
* @param updateWhitelabelDefaultDeploymentTargetRequest
|
|
739
739
|
*/
|
|
@@ -744,7 +744,7 @@ export declare class OrganizationsApi {
|
|
|
744
744
|
}): Promise<GenericApiResponse>;
|
|
745
745
|
/**
|
|
746
746
|
* White label admin only API to customize the order of deployment options in the deployment view for this white label.
|
|
747
|
-
* @summary Update the order of deployment options in the deployment view
|
|
747
|
+
* @summary White Label Admin - Update the order of deployment options in the deployment view
|
|
748
748
|
* @param organizationId Organization ID
|
|
749
749
|
* @param updateWhitelabelDeploymentOptionsOrderRequest
|
|
750
750
|
*/
|
|
@@ -755,7 +755,7 @@ export declare class OrganizationsApi {
|
|
|
755
755
|
}): Promise<GenericApiResponse>;
|
|
756
756
|
/**
|
|
757
757
|
* White label admin only API to update some or all of the deployment targets enabled for this white label.
|
|
758
|
-
* @summary Update deployment targets
|
|
758
|
+
* @summary White Label Admin - Update deployment targets
|
|
759
759
|
* @param organizationId Organization ID
|
|
760
760
|
* @param updateWhitelabelDeploymentTargetsRequest
|
|
761
761
|
*/
|
|
@@ -766,7 +766,7 @@ export declare class OrganizationsApi {
|
|
|
766
766
|
}): Promise<GenericApiResponse>;
|
|
767
767
|
/**
|
|
768
768
|
* White label admin only API to update a development board.
|
|
769
|
-
* @summary Update a development board in a whitelabel
|
|
769
|
+
* @summary White Label Admin - Update a development board in a whitelabel
|
|
770
770
|
* @param organizationId Organization ID
|
|
771
771
|
* @param developmentBoardId Development board ID.
|
|
772
772
|
* @param developmentBoardRequestUpdate
|
|
@@ -778,7 +778,7 @@ export declare class OrganizationsApi {
|
|
|
778
778
|
}): Promise<GenericApiResponse>;
|
|
779
779
|
/**
|
|
780
780
|
* White label admin only API to update the image of a development board.
|
|
781
|
-
* @summary Update the image of a whitelabel development board
|
|
781
|
+
* @summary White Label Admin - Update the image of a whitelabel development board
|
|
782
782
|
* @param organizationId Organization ID
|
|
783
783
|
* @param developmentBoardId Development board ID.
|
|
784
784
|
* @param image
|
|
@@ -790,7 +790,7 @@ export declare class OrganizationsApi {
|
|
|
790
790
|
}): Promise<UploadAssetResponse>;
|
|
791
791
|
/**
|
|
792
792
|
* White label admin only API to update the white label information.
|
|
793
|
-
* @summary Update white label information
|
|
793
|
+
* @summary White Label Admin - Update white label information
|
|
794
794
|
* @param organizationId Organization ID
|
|
795
795
|
* @param updateWhitelabelRequest
|
|
796
796
|
*/
|
|
@@ -801,7 +801,7 @@ export declare class OrganizationsApi {
|
|
|
801
801
|
}): Promise<GenericApiResponse>;
|
|
802
802
|
/**
|
|
803
803
|
* White label admin only API to update some or all of the learning blocks enabled for this white label.
|
|
804
|
-
* @summary Update learning blocks
|
|
804
|
+
* @summary White Label Admin - Update learning blocks
|
|
805
805
|
* @param organizationId Organization ID
|
|
806
806
|
* @param updateWhitelabelLearningBlocksRequest
|
|
807
807
|
*/
|
|
@@ -812,7 +812,7 @@ export declare class OrganizationsApi {
|
|
|
812
812
|
}): Promise<GenericApiResponse>;
|
|
813
813
|
/**
|
|
814
814
|
* White label admin only API to update organization properties such as name and logo.
|
|
815
|
-
* @summary Update organization
|
|
815
|
+
* @summary White Label Admin - Update organization
|
|
816
816
|
* @param organizationId Organization ID
|
|
817
817
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
818
818
|
* @param adminUpdateOrganizationRequest
|
|
@@ -824,7 +824,7 @@ export declare class OrganizationsApi {
|
|
|
824
824
|
}): Promise<GenericApiResponse>;
|
|
825
825
|
/**
|
|
826
826
|
* White label admin only API to update project properties.
|
|
827
|
-
* @summary Update white label project
|
|
827
|
+
* @summary White Label Admin - Update white label project
|
|
828
828
|
* @param organizationId Organization ID
|
|
829
829
|
* @param projectId Project ID
|
|
830
830
|
* @param updateProjectRequest
|
|
@@ -836,7 +836,7 @@ export declare class OrganizationsApi {
|
|
|
836
836
|
}): Promise<GenericApiResponse>;
|
|
837
837
|
/**
|
|
838
838
|
* White label admin only API to update some or all theme colors.
|
|
839
|
-
* @summary Update theme colors
|
|
839
|
+
* @summary White Label Admin - Update theme colors
|
|
840
840
|
* @param organizationId Organization ID
|
|
841
841
|
* @param updateThemeColorsRequest
|
|
842
842
|
*/
|
|
@@ -847,7 +847,7 @@ export declare class OrganizationsApi {
|
|
|
847
847
|
}): Promise<GenericApiResponse>;
|
|
848
848
|
/**
|
|
849
849
|
* White label admin only API to update the white label theme device logo.
|
|
850
|
-
* @summary Update theme device logo
|
|
850
|
+
* @summary White Label Admin - Update theme device logo
|
|
851
851
|
* @param organizationId Organization ID
|
|
852
852
|
* @param image
|
|
853
853
|
*/
|
|
@@ -858,7 +858,7 @@ export declare class OrganizationsApi {
|
|
|
858
858
|
}): Promise<UploadAssetResponse>;
|
|
859
859
|
/**
|
|
860
860
|
* White label admin only API to update the theme favicon.
|
|
861
|
-
* @summary Update theme favicon
|
|
861
|
+
* @summary White Label Admin - Update theme favicon
|
|
862
862
|
* @param organizationId Organization ID
|
|
863
863
|
* @param image
|
|
864
864
|
*/
|
|
@@ -869,7 +869,7 @@ export declare class OrganizationsApi {
|
|
|
869
869
|
}): Promise<GenericApiResponse>;
|
|
870
870
|
/**
|
|
871
871
|
* White label admin only API to update the white label theme logo.
|
|
872
|
-
* @summary Update theme logo
|
|
872
|
+
* @summary White Label Admin - Update theme logo
|
|
873
873
|
* @param organizationId Organization ID
|
|
874
874
|
* @param image
|
|
875
875
|
*/
|
|
@@ -880,7 +880,7 @@ export declare class OrganizationsApi {
|
|
|
880
880
|
}): Promise<UploadAssetResponse>;
|
|
881
881
|
/**
|
|
882
882
|
* White label admin only API to update user properties.
|
|
883
|
-
* @summary Update white label user
|
|
883
|
+
* @summary White Label Admin - Update white label user
|
|
884
884
|
* @param organizationId Organization ID
|
|
885
885
|
* @param userId User ID
|
|
886
886
|
* @param adminUpdateUserRequest
|
|
@@ -1702,7 +1702,7 @@ class OrganizationsApi {
|
|
|
1702
1702
|
}
|
|
1703
1703
|
/**
|
|
1704
1704
|
* White label admin only API to add a development board.
|
|
1705
|
-
* @summary Add a development board to a whitelabel
|
|
1705
|
+
* @summary White Label Admin - Add a development board to a whitelabel
|
|
1706
1706
|
* @param organizationId Organization ID
|
|
1707
1707
|
* @param developmentBoardRequest
|
|
1708
1708
|
*/
|
|
@@ -1777,7 +1777,7 @@ class OrganizationsApi {
|
|
|
1777
1777
|
}
|
|
1778
1778
|
/**
|
|
1779
1779
|
* White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.
|
|
1780
|
-
* @summary Add organization API key
|
|
1780
|
+
* @summary White Label Admin - Add organization API key
|
|
1781
1781
|
* @param organizationId Organization ID
|
|
1782
1782
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
1783
1783
|
* @param adminAddOrganizationApiKeyRequest
|
|
@@ -1862,7 +1862,7 @@ class OrganizationsApi {
|
|
|
1862
1862
|
}
|
|
1863
1863
|
/**
|
|
1864
1864
|
* White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.
|
|
1865
|
-
* @summary Add Project API key
|
|
1865
|
+
* @summary White Label Admin - Add Project API key
|
|
1866
1866
|
* @param organizationId Organization ID
|
|
1867
1867
|
* @param projectId Project ID
|
|
1868
1868
|
* @param adminAddProjectApiKeyRequest
|
|
@@ -1947,7 +1947,7 @@ class OrganizationsApi {
|
|
|
1947
1947
|
}
|
|
1948
1948
|
/**
|
|
1949
1949
|
* White label admin only API to add a user to an organization. If no user is provided, the current user is used.
|
|
1950
|
-
* @summary Add user to an organization
|
|
1950
|
+
* @summary White Label Admin - Add user to an organization
|
|
1951
1951
|
* @param organizationId Organization ID
|
|
1952
1952
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
1953
1953
|
* @param adminAddOrganizationUserRequest
|
|
@@ -2028,7 +2028,7 @@ class OrganizationsApi {
|
|
|
2028
2028
|
}
|
|
2029
2029
|
/**
|
|
2030
2030
|
* White label admin only API to add a user to a project. If no user is provided, the current user is used.
|
|
2031
|
-
* @summary Add user to a project
|
|
2031
|
+
* @summary White Label Admin - Add user to a project
|
|
2032
2032
|
* @param organizationId Organization ID
|
|
2033
2033
|
* @param projectId Project ID
|
|
2034
2034
|
* @param adminAddProjectUserRequest
|
|
@@ -2109,7 +2109,7 @@ class OrganizationsApi {
|
|
|
2109
2109
|
}
|
|
2110
2110
|
/**
|
|
2111
2111
|
* Create a new organization. This is an internal API only available to white label admins
|
|
2112
|
-
* @summary Create new organization within white label context
|
|
2112
|
+
* @summary White Label Admin - Create new organization within white label context
|
|
2113
2113
|
* @param organizationId Organization ID
|
|
2114
2114
|
* @param whitelabelAdminCreateOrganizationRequest
|
|
2115
2115
|
*/
|
|
@@ -2188,7 +2188,7 @@ class OrganizationsApi {
|
|
|
2188
2188
|
}
|
|
2189
2189
|
/**
|
|
2190
2190
|
* White label admin only API to create a new project for an organization.
|
|
2191
|
-
* @summary Create a new organization project
|
|
2191
|
+
* @summary White Label Admin - Create a new organization project
|
|
2192
2192
|
* @param organizationId Organization ID
|
|
2193
2193
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
2194
2194
|
* @param adminCreateProjectRequest
|
|
@@ -2273,7 +2273,7 @@ class OrganizationsApi {
|
|
|
2273
2273
|
}
|
|
2274
2274
|
/**
|
|
2275
2275
|
* Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an internal API only available to white label admins.
|
|
2276
|
-
* @summary Creates a new usage report
|
|
2276
|
+
* @summary White Label Admin - Creates a new usage report
|
|
2277
2277
|
* @param organizationId Organization ID
|
|
2278
2278
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
2279
2279
|
* @param startDate Start date
|
|
@@ -2368,7 +2368,7 @@ class OrganizationsApi {
|
|
|
2368
2368
|
}
|
|
2369
2369
|
/**
|
|
2370
2370
|
* Create a new free tier project. This is an internal API only available to white label admins.
|
|
2371
|
-
* @summary Create a new project within white label context.
|
|
2371
|
+
* @summary White Label Admin - Create a new project within white label context.
|
|
2372
2372
|
* @param organizationId Organization ID
|
|
2373
2373
|
* @param adminCreateProjectRequest
|
|
2374
2374
|
*/
|
|
@@ -2447,7 +2447,7 @@ class OrganizationsApi {
|
|
|
2447
2447
|
}
|
|
2448
2448
|
/**
|
|
2449
2449
|
* White label admin only API to delete an organization.
|
|
2450
|
-
* @summary Delete an organization
|
|
2450
|
+
* @summary White Label Admin - Delete an organization
|
|
2451
2451
|
* @param organizationId Organization ID
|
|
2452
2452
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
2453
2453
|
*/
|
|
@@ -2526,7 +2526,7 @@ class OrganizationsApi {
|
|
|
2526
2526
|
}
|
|
2527
2527
|
/**
|
|
2528
2528
|
* Delete a usage report for an organization. This is an internal API only available to white label admins.
|
|
2529
|
-
* @summary Delete usage report
|
|
2529
|
+
* @summary White Label Admin - Delete usage report
|
|
2530
2530
|
* @param organizationId Organization ID
|
|
2531
2531
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
2532
2532
|
* @param usageReportId Usage report ID
|
|
@@ -2611,7 +2611,7 @@ class OrganizationsApi {
|
|
|
2611
2611
|
}
|
|
2612
2612
|
/**
|
|
2613
2613
|
* White label admin only API to delete a project.
|
|
2614
|
-
* @summary Delete a project
|
|
2614
|
+
* @summary White Label Admin - Delete a project
|
|
2615
2615
|
* @param organizationId Organization ID
|
|
2616
2616
|
* @param projectId Project ID
|
|
2617
2617
|
*/
|
|
@@ -2690,7 +2690,7 @@ class OrganizationsApi {
|
|
|
2690
2690
|
}
|
|
2691
2691
|
/**
|
|
2692
2692
|
* Download a usage report for an organization. This is an internal API only available to white label admins.
|
|
2693
|
-
* @summary Download usage report
|
|
2693
|
+
* @summary White Label Admin - Download usage report
|
|
2694
2694
|
* @param organizationId Organization ID
|
|
2695
2695
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
2696
2696
|
* @param usageReportId Usage report ID
|
|
@@ -2766,7 +2766,7 @@ class OrganizationsApi {
|
|
|
2766
2766
|
}
|
|
2767
2767
|
/**
|
|
2768
2768
|
* White label admin only API to get the white label information.
|
|
2769
|
-
* @summary Get white label information
|
|
2769
|
+
* @summary White Label Admin - Get white label information
|
|
2770
2770
|
* @param organizationId Organization ID
|
|
2771
2771
|
*/
|
|
2772
2772
|
async whitelabelAdminGetInfo(organizationId, options = { headers: {} }) {
|
|
@@ -2839,7 +2839,7 @@ class OrganizationsApi {
|
|
|
2839
2839
|
}
|
|
2840
2840
|
/**
|
|
2841
2841
|
* White label admin only API to get global metrics.
|
|
2842
|
-
* @summary Get global white label metrics
|
|
2842
|
+
* @summary White Label Admin - Get global white label metrics
|
|
2843
2843
|
* @param organizationId Organization ID
|
|
2844
2844
|
*/
|
|
2845
2845
|
async whitelabelAdminGetMetrics(organizationId, options = { headers: {} }) {
|
|
@@ -2912,7 +2912,7 @@ class OrganizationsApi {
|
|
|
2912
2912
|
}
|
|
2913
2913
|
/**
|
|
2914
2914
|
* Get compute time usage for an organization over a period of time. This is an internal API only available to white label admins
|
|
2915
|
-
* @summary Get organization compute time usage
|
|
2915
|
+
* @summary White Label Admin - Get organization compute time usage
|
|
2916
2916
|
* @param organizationId Organization ID
|
|
2917
2917
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
2918
2918
|
* @param startDate Start date
|
|
@@ -3007,7 +3007,7 @@ class OrganizationsApi {
|
|
|
3007
3007
|
}
|
|
3008
3008
|
/**
|
|
3009
3009
|
* White label admin only API to list all information about an organization.
|
|
3010
|
-
* @summary Get organization information
|
|
3010
|
+
* @summary White Label Admin - Get organization information
|
|
3011
3011
|
* @param organizationId Organization ID
|
|
3012
3012
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
3013
3013
|
* @param includeDeleted Whether to include deleted entities (users, projects, orgs)
|
|
@@ -3090,7 +3090,7 @@ class OrganizationsApi {
|
|
|
3090
3090
|
}
|
|
3091
3091
|
/**
|
|
3092
3092
|
* Get a usage report for an organization. This is an internal API only available to white label admins.
|
|
3093
|
-
* @summary Get usage report
|
|
3093
|
+
* @summary White Label Admin - Get usage report
|
|
3094
3094
|
* @param organizationId Organization ID
|
|
3095
3095
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
3096
3096
|
* @param usageReportId Usage report ID
|
|
@@ -3175,7 +3175,7 @@ class OrganizationsApi {
|
|
|
3175
3175
|
}
|
|
3176
3176
|
/**
|
|
3177
3177
|
* Get all usage reports for an organization. This is an internal API only available to white label admins.
|
|
3178
|
-
* @summary Get all usage reports
|
|
3178
|
+
* @summary White Label Admin - Get all usage reports
|
|
3179
3179
|
* @param organizationId Organization ID
|
|
3180
3180
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
3181
3181
|
* @param limit Maximum number of results
|
|
@@ -3262,7 +3262,7 @@ class OrganizationsApi {
|
|
|
3262
3262
|
}
|
|
3263
3263
|
/**
|
|
3264
3264
|
* White label admin only API to get the list of all organizations.
|
|
3265
|
-
* @summary Get all organizations within a white label
|
|
3265
|
+
* @summary White Label Admin - Get all organizations within a white label
|
|
3266
3266
|
* @param organizationId Organization ID
|
|
3267
3267
|
* @param active Whether to search for entities (users, orgs) active in the last X days
|
|
3268
3268
|
* @param includeDeleted Whether to include deleted entities (users, projects, orgs)
|
|
@@ -3359,7 +3359,7 @@ class OrganizationsApi {
|
|
|
3359
3359
|
}
|
|
3360
3360
|
/**
|
|
3361
3361
|
* White label admin only API to get project information.
|
|
3362
|
-
* @summary Get a white label project
|
|
3362
|
+
* @summary White Label Admin - Get a white label project
|
|
3363
3363
|
* @param organizationId Organization ID
|
|
3364
3364
|
* @param projectId Project ID
|
|
3365
3365
|
*/
|
|
@@ -3438,7 +3438,7 @@ class OrganizationsApi {
|
|
|
3438
3438
|
}
|
|
3439
3439
|
/**
|
|
3440
3440
|
* White label admin only API to get the list of all projects.
|
|
3441
|
-
* @summary Get all white label projects
|
|
3441
|
+
* @summary White Label Admin - Get all white label projects
|
|
3442
3442
|
* @param organizationId Organization ID
|
|
3443
3443
|
* @param active Whether to search for entities (users, orgs) active in the last X days
|
|
3444
3444
|
* @param sort Fields and order to sort query by
|
|
@@ -3531,7 +3531,7 @@ class OrganizationsApi {
|
|
|
3531
3531
|
}
|
|
3532
3532
|
/**
|
|
3533
3533
|
* White label admin only API to get information about a user.
|
|
3534
|
-
* @summary Get a white label user
|
|
3534
|
+
* @summary White Label Admin - Get a white label user
|
|
3535
3535
|
* @param organizationId Organization ID
|
|
3536
3536
|
* @param userId User ID
|
|
3537
3537
|
*/
|
|
@@ -3610,7 +3610,7 @@ class OrganizationsApi {
|
|
|
3610
3610
|
}
|
|
3611
3611
|
/**
|
|
3612
3612
|
* White label admin only API to get marketing metrics about a user.
|
|
3613
|
-
* @summary Get white label user metrics
|
|
3613
|
+
* @summary White Label Admin - Get white label user metrics
|
|
3614
3614
|
* @param organizationId Organization ID
|
|
3615
3615
|
* @param userId User ID
|
|
3616
3616
|
*/
|
|
@@ -3689,7 +3689,7 @@ class OrganizationsApi {
|
|
|
3689
3689
|
}
|
|
3690
3690
|
/**
|
|
3691
3691
|
* White label admin only API to get the list of all registered users.
|
|
3692
|
-
* @summary Get all white label users
|
|
3692
|
+
* @summary White Label Admin - Get all white label users
|
|
3693
3693
|
* @param organizationId Organization ID
|
|
3694
3694
|
* @param active Whether to search for entities (users, orgs) active in the last X days
|
|
3695
3695
|
* @param tier Whether to search for free, pro or enterprise entities (users, projects)
|
|
@@ -3790,7 +3790,7 @@ class OrganizationsApi {
|
|
|
3790
3790
|
}
|
|
3791
3791
|
/**
|
|
3792
3792
|
* White label admin only API to remove a development board.
|
|
3793
|
-
* @summary Remove a development board from a whitelabel
|
|
3793
|
+
* @summary White Label Admin - Remove a development board from a whitelabel
|
|
3794
3794
|
* @param organizationId Organization ID
|
|
3795
3795
|
* @param developmentBoardId Development board ID.
|
|
3796
3796
|
*/
|
|
@@ -3869,7 +3869,7 @@ class OrganizationsApi {
|
|
|
3869
3869
|
}
|
|
3870
3870
|
/**
|
|
3871
3871
|
* White label admin only API to remove a user from an organization.
|
|
3872
|
-
* @summary Remove user from an organization
|
|
3872
|
+
* @summary White Label Admin - Remove user from an organization
|
|
3873
3873
|
* @param organizationId Organization ID
|
|
3874
3874
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
3875
3875
|
* @param userId User ID
|
|
@@ -3954,7 +3954,7 @@ class OrganizationsApi {
|
|
|
3954
3954
|
}
|
|
3955
3955
|
/**
|
|
3956
3956
|
* White label admin only API to remove a user from a project.
|
|
3957
|
-
* @summary Remove user from a project
|
|
3957
|
+
* @summary White Label Admin - Remove user from a project
|
|
3958
3958
|
* @param organizationId Organization ID
|
|
3959
3959
|
* @param projectId Project ID
|
|
3960
3960
|
* @param userId User ID
|
|
@@ -4039,7 +4039,7 @@ class OrganizationsApi {
|
|
|
4039
4039
|
}
|
|
4040
4040
|
/**
|
|
4041
4041
|
* White label admin only API to restore a deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.
|
|
4042
|
-
* @summary Restore an organization
|
|
4042
|
+
* @summary White Label Admin - Restore an organization
|
|
4043
4043
|
* @param organizationId Organization ID
|
|
4044
4044
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
4045
4045
|
*/
|
|
@@ -4118,7 +4118,7 @@ class OrganizationsApi {
|
|
|
4118
4118
|
}
|
|
4119
4119
|
/**
|
|
4120
4120
|
* White label admin only API to update the default deployment target for this white label.
|
|
4121
|
-
* @summary Update default deployment target
|
|
4121
|
+
* @summary White Label Admin - Update default deployment target
|
|
4122
4122
|
* @param organizationId Organization ID
|
|
4123
4123
|
* @param updateWhitelabelDefaultDeploymentTargetRequest
|
|
4124
4124
|
*/
|
|
@@ -4197,7 +4197,7 @@ class OrganizationsApi {
|
|
|
4197
4197
|
}
|
|
4198
4198
|
/**
|
|
4199
4199
|
* White label admin only API to customize the order of deployment options in the deployment view for this white label.
|
|
4200
|
-
* @summary Update the order of deployment options in the deployment view
|
|
4200
|
+
* @summary White Label Admin - Update the order of deployment options in the deployment view
|
|
4201
4201
|
* @param organizationId Organization ID
|
|
4202
4202
|
* @param updateWhitelabelDeploymentOptionsOrderRequest
|
|
4203
4203
|
*/
|
|
@@ -4276,7 +4276,7 @@ class OrganizationsApi {
|
|
|
4276
4276
|
}
|
|
4277
4277
|
/**
|
|
4278
4278
|
* White label admin only API to update some or all of the deployment targets enabled for this white label.
|
|
4279
|
-
* @summary Update deployment targets
|
|
4279
|
+
* @summary White Label Admin - Update deployment targets
|
|
4280
4280
|
* @param organizationId Organization ID
|
|
4281
4281
|
* @param updateWhitelabelDeploymentTargetsRequest
|
|
4282
4282
|
*/
|
|
@@ -4355,7 +4355,7 @@ class OrganizationsApi {
|
|
|
4355
4355
|
}
|
|
4356
4356
|
/**
|
|
4357
4357
|
* White label admin only API to update a development board.
|
|
4358
|
-
* @summary Update a development board in a whitelabel
|
|
4358
|
+
* @summary White Label Admin - Update a development board in a whitelabel
|
|
4359
4359
|
* @param organizationId Organization ID
|
|
4360
4360
|
* @param developmentBoardId Development board ID.
|
|
4361
4361
|
* @param developmentBoardRequestUpdate
|
|
@@ -4436,7 +4436,7 @@ class OrganizationsApi {
|
|
|
4436
4436
|
}
|
|
4437
4437
|
/**
|
|
4438
4438
|
* White label admin only API to update the image of a development board.
|
|
4439
|
-
* @summary Update the image of a whitelabel development board
|
|
4439
|
+
* @summary White Label Admin - Update the image of a whitelabel development board
|
|
4440
4440
|
* @param organizationId Organization ID
|
|
4441
4441
|
* @param developmentBoardId Development board ID.
|
|
4442
4442
|
* @param image
|
|
@@ -4520,7 +4520,7 @@ class OrganizationsApi {
|
|
|
4520
4520
|
}
|
|
4521
4521
|
/**
|
|
4522
4522
|
* White label admin only API to update the white label information.
|
|
4523
|
-
* @summary Update white label information
|
|
4523
|
+
* @summary White Label Admin - Update white label information
|
|
4524
4524
|
* @param organizationId Organization ID
|
|
4525
4525
|
* @param updateWhitelabelRequest
|
|
4526
4526
|
*/
|
|
@@ -4599,7 +4599,7 @@ class OrganizationsApi {
|
|
|
4599
4599
|
}
|
|
4600
4600
|
/**
|
|
4601
4601
|
* White label admin only API to update some or all of the learning blocks enabled for this white label.
|
|
4602
|
-
* @summary Update learning blocks
|
|
4602
|
+
* @summary White Label Admin - Update learning blocks
|
|
4603
4603
|
* @param organizationId Organization ID
|
|
4604
4604
|
* @param updateWhitelabelLearningBlocksRequest
|
|
4605
4605
|
*/
|
|
@@ -4678,7 +4678,7 @@ class OrganizationsApi {
|
|
|
4678
4678
|
}
|
|
4679
4679
|
/**
|
|
4680
4680
|
* White label admin only API to update organization properties such as name and logo.
|
|
4681
|
-
* @summary Update organization
|
|
4681
|
+
* @summary White Label Admin - Update organization
|
|
4682
4682
|
* @param organizationId Organization ID
|
|
4683
4683
|
* @param innerOrganizationId Organization ID within the context of a white label
|
|
4684
4684
|
* @param adminUpdateOrganizationRequest
|
|
@@ -4763,7 +4763,7 @@ class OrganizationsApi {
|
|
|
4763
4763
|
}
|
|
4764
4764
|
/**
|
|
4765
4765
|
* White label admin only API to update project properties.
|
|
4766
|
-
* @summary Update white label project
|
|
4766
|
+
* @summary White Label Admin - Update white label project
|
|
4767
4767
|
* @param organizationId Organization ID
|
|
4768
4768
|
* @param projectId Project ID
|
|
4769
4769
|
* @param updateProjectRequest
|
|
@@ -4848,7 +4848,7 @@ class OrganizationsApi {
|
|
|
4848
4848
|
}
|
|
4849
4849
|
/**
|
|
4850
4850
|
* White label admin only API to update some or all theme colors.
|
|
4851
|
-
* @summary Update theme colors
|
|
4851
|
+
* @summary White Label Admin - Update theme colors
|
|
4852
4852
|
* @param organizationId Organization ID
|
|
4853
4853
|
* @param updateThemeColorsRequest
|
|
4854
4854
|
*/
|
|
@@ -4927,7 +4927,7 @@ class OrganizationsApi {
|
|
|
4927
4927
|
}
|
|
4928
4928
|
/**
|
|
4929
4929
|
* White label admin only API to update the white label theme device logo.
|
|
4930
|
-
* @summary Update theme device logo
|
|
4930
|
+
* @summary White Label Admin - Update theme device logo
|
|
4931
4931
|
* @param organizationId Organization ID
|
|
4932
4932
|
* @param image
|
|
4933
4933
|
*/
|
|
@@ -5005,7 +5005,7 @@ class OrganizationsApi {
|
|
|
5005
5005
|
}
|
|
5006
5006
|
/**
|
|
5007
5007
|
* White label admin only API to update the theme favicon.
|
|
5008
|
-
* @summary Update theme favicon
|
|
5008
|
+
* @summary White Label Admin - Update theme favicon
|
|
5009
5009
|
* @param organizationId Organization ID
|
|
5010
5010
|
* @param image
|
|
5011
5011
|
*/
|
|
@@ -5087,7 +5087,7 @@ class OrganizationsApi {
|
|
|
5087
5087
|
}
|
|
5088
5088
|
/**
|
|
5089
5089
|
* White label admin only API to update the white label theme logo.
|
|
5090
|
-
* @summary Update theme logo
|
|
5090
|
+
* @summary White Label Admin - Update theme logo
|
|
5091
5091
|
* @param organizationId Organization ID
|
|
5092
5092
|
* @param image
|
|
5093
5093
|
*/
|
|
@@ -5165,7 +5165,7 @@ class OrganizationsApi {
|
|
|
5165
5165
|
}
|
|
5166
5166
|
/**
|
|
5167
5167
|
* White label admin only API to update user properties.
|
|
5168
|
-
* @summary Update white label user
|
|
5168
|
+
* @summary White Label Admin - Update white label user
|
|
5169
5169
|
* @param organizationId Organization ID
|
|
5170
5170
|
* @param userId User ID
|
|
5171
5171
|
* @param adminUpdateUserRequest
|