@iblai/iblai-api 4.265.1-core → 4.265.2-core

package/src/services/ActivitiesService.ts

@@ -0,0 +1,255 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Activity } from '../models/Activity';
+import type { PaginatedActivityList } from '../models/PaginatedActivityList';
+import type { PatchedActivity } from '../models/PatchedActivity';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class ActivitiesService {
+    /**
+     * List activities
+     * Returns a paginated list of Activities in your Platform. Supports filtering by `type`, `is_done`, `owner`, `deal`, `person`, schedule-from ranges, and `metadata__has_key`.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/list`.
+     * @returns PaginatedActivityList
+     * @throws ApiError
+     */
+    public static activitiesList({
+        deal,
+        isDone,
+        metadataHasKey,
+        owner,
+        page,
+        pageSize,
+        person,
+        scheduleFromGte,
+        scheduleFromLte,
+        type,
+    }: {
+        deal?: number,
+        isDone?: boolean,
+        metadataHasKey?: string,
+        owner?: number,
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number,
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number,
+        person?: string,
+        scheduleFromGte?: string,
+        scheduleFromLte?: string,
+        /**
+         * Interaction kind.
+         *
+         * * `call` - Call
+         * * `meeting` - Meeting
+         * * `email` - Email
+         * * `note` - Note
+         * * `task` - Task
+         * * `lunch` - Lunch
+         * * `deadline` - Deadline
+         */
+        type?: 'call' | 'deadline' | 'email' | 'lunch' | 'meeting' | 'note' | 'task',
+    }): CancelablePromise<PaginatedActivityList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/activities/',
+            query: {
+                'deal': deal,
+                'is_done': isDone,
+                'metadata__has_key': metadataHasKey,
+                'owner': owner,
+                'page': page,
+                'page_size': pageSize,
+                'person': person,
+                'schedule_from__gte': scheduleFromGte,
+                'schedule_from__lte': scheduleFromLte,
+                'type': type,
+            },
+            errors: {
+                401: `Authentication required.`,
+                403: `Missing required permission \`Ibl.CRM/Activities/list\`.`,
+            },
+        });
+    }
+    /**
+     * Create an activity
+     * Creates an Activity. Either `deal` or `person` must be supplied; both must belong to your Platform.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    public static activitiesCreate({
+        requestBody,
+    }: {
+        requestBody: Activity,
+    }): CancelablePromise<Activity> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/activities/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Activities/write\`.`,
+            },
+        });
+    }
+    /**
+     * Retrieve an activity
+     * Returns a single Activity by id.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/read`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    public static activitiesRetrieve({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number,
+    }): CancelablePromise<Activity> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/activities/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Activities/read\`.`,
+                404: `Activity not found.`,
+            },
+        });
+    }
+    /**
+     * Replace an activity
+     * Replaces all editable fields on the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    public static activitiesUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number,
+        requestBody: Activity,
+    }): CancelablePromise<Activity> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/activities/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Activities/write\`.`,
+                404: `Activity not found.`,
+            },
+        });
+    }
+    /**
+     * Update an activity
+     * Updates only the supplied fields on the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    public static activitiesPartialUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number,
+        requestBody?: PatchedActivity,
+    }): CancelablePromise<Activity> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/activities/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Activities/write\`.`,
+                404: `Activity not found.`,
+            },
+        });
+    }
+    /**
+     * Delete an activity
+     * Deletes the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    public static activitiesDestroy({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/activities/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Activities/delete\`.`,
+                404: `Activity not found.`,
+            },
+        });
+    }
+    /**
+     * Mark an activity as done
+     * Flips `is_done=True` and stamps `done_at` if it isn't already set. Idempotent — calling on an already-done Activity preserves the original `done_at`.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    public static activitiesDoneCreate({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number,
+    }): CancelablePromise<Activity> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/activities/{id}/done/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Activities/write\`.`,
+                404: `Activity not found.`,
+            },
+        });
+    }
+}