# Activity AI Sales Order API

API for managing AI-assisted sales order activities

**Version:** 1.0.0

## Overview

### Base URLs

- **Production server**: `https://sv.api.repzo.me`

- **Staging server**: `https://staging.sv.api.repzo.me`

### API Categories

- **Activity AI Sales Order**: Operations related to AI-assisted sales order activities

## Authentication

This API uses the following authentication methods:

- **ApiKeyAuth**

## Endpoints

### `/activity-ai-sales-order`

#### GET /activity-ai-sales-order

**Summary:** Get all AI sales order activities

**Description:** Retrieve a list of all AI sales order activities with optional filtering and pagination

**Tags:** Activity AI Sales Order

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `limit` | query | integer | No | Maximum number of records to return |

| `offset` | query | integer | No | Number of records to skip for pagination |

| `sort` | query | string | No | Field to sort by |

| `order` | query | string | No | Sort order (asc or desc) |

| `filter` | query | string | No | Filter conditions in JSON format |

| `search` | query | string | No | Search term for text fields |

##### Responses

**200** - List of AI sales order activities retrieved successfully

Content-Type: `application/json`

**400** - Bad request

**401** - Unauthorized

**500** - Internal server error

---

#### POST /activity-ai-sales-order

**Summary:** Create a new AI sales order activity

**Description:** Create a new AI sales order activity with the provided data

**Tags:** Activity AI Sales Order

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - AI sales order activity created successfully

Content-Type: `application/json`

**400** - Bad request

**401** - Unauthorized

**500** - Internal server error

---

### `/activity-ai-sales-order/{id}`

#### GET /activity-ai-sales-order/{id}

**Summary:** Get AI sales order activity by ID

**Description:** Retrieve a specific AI sales order activity by its ID

**Tags:** Activity AI Sales Order

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | AI sales order activity ID |

##### Responses

**200** - AI sales order activity retrieved successfully

Content-Type: `application/json`

**404** - AI sales order activity not found

**401** - Unauthorized

**500** - Internal server error

---

#### PUT /activity-ai-sales-order/{id}

**Summary:** Update AI sales order activity

**Description:** Update an existing AI sales order activity with new data

**Tags:** Activity AI Sales Order

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | AI sales order activity ID |

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - AI sales order activity updated successfully

Content-Type: `application/json`

**400** - Bad request

**404** - AI sales order activity not found

**401** - Unauthorized

**500** - Internal server error

---

#### DELETE /activity-ai-sales-order/{id}

**Summary:** Delete AI sales order activity

**Description:** Delete an existing AI sales order activity

**Tags:** Activity AI Sales Order

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | AI sales order activity ID |

##### Responses

**200** - AI sales order activity deleted successfully

Content-Type: `application/json`

**404** - AI sales order activity not found

**401** - Unauthorized

**500** - Internal server error

---

### `/activity-ai-sales-order/{id}/generate`

#### POST /activity-ai-sales-order/{id}/generate

**Summary:** Generate AI recommendations

**Description:** Generate AI-powered sales order recommendations for the activity

**Tags:** Activity AI Sales Order

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | AI sales order activity ID |

##### Responses

**200** - AI recommendations generated successfully

Content-Type: `application/json`

**404** - AI sales order activity not found

**401** - Unauthorized

**500** - Internal server error

---

## Data Models

### ActivityAiSalesOrder

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `_id` | string | No | Unique identifier for the AI sales order activity |

| `client` | string | Yes | Client ID |

| `rep` | string | Yes | Sales representative ID |

| `activityType` | string | Yes | Type of AI activity |

| `inputData` | object | No | No description |

| `aiModel` | object | No | No description |

| `recommendations` | array | No | No description |

| `insights` | object | No | No description |

| `status` | string | No | Processing status |

| `processingTime` | number | No | Processing time in seconds |

| `accuracy` | object | No | No description |

| `feedback` | object | No | No description |

| `generatedOrder` | object | No | No description |

| `metadata` | object | No | Additional metadata |

| `createdAt` | string | No | Record creation timestamp |

| `updatedAt` | string | No | Record last update timestamp |

### ActivityAiSalesOrderInput

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `client` | string | Yes | Client ID |

| `rep` | string | Yes | Sales representative ID |

| `activityType` | string | Yes | Type of AI activity |

| `inputData` | object | No | No description |

| `aiModel` | object | No | No description |

| `feedback` | object | No | No description |

| `metadata` | object | No | Additional metadata |

## TypeScript Usage

See [activity-ai-sales-order-examples.md](./activity-ai-sales-order-examples.md) for detailed TypeScript usage examples.