edge-impulse-api 1.22.2 → 1.32.24444

package/build/library/sdk/api/organizationDataCampaignsApi.d.ts

@@ -0,0 +1,196 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AddOrganizationDataCampaignDashboardRequest } from '../model/addOrganizationDataCampaignDashboardRequest';
+import { AddOrganizationDataCampaignDashboardResponse } from '../model/addOrganizationDataCampaignDashboardResponse';
+import { AddOrganizationDataCampaignRequest } from '../model/addOrganizationDataCampaignRequest';
+import { AddOrganizationDataCampaignResponse } from '../model/addOrganizationDataCampaignResponse';
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetOrganizationDataCampaignDashboardResponse } from '../model/getOrganizationDataCampaignDashboardResponse';
+import { GetOrganizationDataCampaignDashboardsResponse } from '../model/getOrganizationDataCampaignDashboardsResponse';
+import { GetOrganizationDataCampaignResponse } from '../model/getOrganizationDataCampaignResponse';
+import { GetOrganizationDataCampaignsResponse } from '../model/getOrganizationDataCampaignsResponse';
+import { OrganizationDataCampaignDiffRequest } from '../model/organizationDataCampaignDiffRequest';
+import { OrganizationDataCampaignDiffResponse } from '../model/organizationDataCampaignDiffResponse';
+import { UpdateOrganizationDataCampaignDashboardRequest } from '../model/updateOrganizationDataCampaignDashboardRequest';
+import { UpdateOrganizationDataCampaignRequest } from '../model/updateOrganizationDataCampaignRequest';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum OrganizationDataCampaignsApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type uploadDashboardScreenshotFormParams = {
+    image: RequestFile;
+};
+export declare type OrganizationDataCampaignsApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class OrganizationDataCampaignsApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: OrganizationDataCampaignsApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: OrganizationDataCampaignsApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: OrganizationDataCampaignsApiOpts);
+    get opts(): OrganizationDataCampaignsApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: OrganizationDataCampaignsApiApiKeys, value: string | undefined): void;
+    /**
+     * Add a new data campaign to a data campaign dashboard
+     * @summary Add a data campaign
+     * @param organizationId Organization ID
+     * @param addOrganizationDataCampaignRequest
+     */
+    addOrganizationDataCampaign(organizationId: number, addOrganizationDataCampaignRequest: AddOrganizationDataCampaignRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AddOrganizationDataCampaignResponse>;
+    /**
+     * Add a new data campaign dashboard
+     * @summary Add data campaign dashboard
+     * @param organizationId Organization ID
+     * @param addOrganizationDataCampaignDashboardRequest
+     */
+    addOrganizationDataCampaignDashboard(organizationId: number, addOrganizationDataCampaignDashboardRequest: AddOrganizationDataCampaignDashboardRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AddOrganizationDataCampaignDashboardResponse>;
+    /**
+     * Delete a data campaign
+     * @summary Delete data campaign
+     * @param organizationId Organization ID
+     * @param campaignId
+     */
+    deleteOrganizationDataCampaign(organizationId: number, campaignId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Delete a data campaign dashboard
+     * @summary Delete data campaign dashboard
+     * @param organizationId Organization ID
+     * @param campaignDashboardId
+     */
+    deleteOrganizationDataCampaignDashboard(organizationId: number, campaignDashboardId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Get a data campaign
+     * @summary Get data campaign
+     * @param organizationId Organization ID
+     * @param campaignId
+     */
+    getOrganizationDataCampaign(organizationId: number, campaignId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataCampaignResponse>;
+    /**
+     * Get a data campaign dashboard
+     * @summary Get data campaign dashboard
+     * @param organizationId Organization ID
+     * @param campaignDashboardId
+     */
+    getOrganizationDataCampaignDashboard(organizationId: number, campaignDashboardId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataCampaignDashboardResponse>;
+    /**
+     * List all data campaign dashboards
+     * @summary Get data campaign dashboards
+     * @param organizationId Organization ID
+     */
+    getOrganizationDataCampaignDashboards(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataCampaignDashboardsResponse>;
+    /**
+     * Get which items have changed for a data campaign. You post the data points and we\'ll return which data items are different in the past day.
+     * @summary Get diff for data campaign
+     * @param organizationId Organization ID
+     * @param campaignId
+     * @param organizationDataCampaignDiffRequest
+     */
+    getOrganizationDataCampaignDiff(organizationId: number, campaignId: number, organizationDataCampaignDiffRequest: OrganizationDataCampaignDiffRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<OrganizationDataCampaignDiffResponse>;
+    /**
+     * Get a list of all data campaigns for a dashboard
+     * @summary Get data campaigns
+     * @param organizationId Organization ID
+     * @param campaignDashboardId
+     */
+    getOrganizationDataCampaignsForDashboard(organizationId: number, campaignDashboardId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataCampaignsResponse>;
+    /**
+     * Update a data campaign
+     * @summary Update data campaign
+     * @param organizationId Organization ID
+     * @param campaignId
+     * @param updateOrganizationDataCampaignRequest
+     */
+    updateOrganizationDataCampaign(organizationId: number, campaignId: number, updateOrganizationDataCampaignRequest: UpdateOrganizationDataCampaignRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Update a data campaign dashboard
+     * @summary Update data campaign dashboard
+     * @param organizationId Organization ID
+     * @param campaignDashboardId
+     * @param updateOrganizationDataCampaignDashboardRequest
+     */
+    updateOrganizationDataCampaignDashboard(organizationId: number, campaignDashboardId: number, updateOrganizationDataCampaignDashboardRequest: UpdateOrganizationDataCampaignDashboardRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Used internally to upload a picture of a screenshot
+     * @summary Upload a dashboard screenshot
+     * @param organizationId Organization ID
+     * @param campaignDashboardId
+     * @param image
+     */
+    uploadDashboardScreenshot(organizationId: number, campaignDashboardId: number, params: uploadDashboardScreenshotFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+}
+export {};