@epilot/sdk 2.2.7 → 2.3.1

package/docs/template-variables.md

@@ -146,6 +146,7 @@ const { data } = await client.getVariableContext(
       context_data: {},
       template_name: 'string',
       template_tags: ['string'],
+      template_id: 'string',
       variables_version: '2'
     }
   },
@@ -250,6 +251,7 @@ const { data } = await client.replaceTemplates(
       context_data: {},
       template_name: 'string',
       template_tags: ['string'],
+      template_id: 'string',
       variables_version: '2'
     }
   },
@@ -297,6 +299,7 @@ const { data } = await client.replaceTemplatesV2(
       context_data: {},
       template_name: 'string',
       template_tags: ['string'],
+      template_id: 'string',
       variables_version: '2'
     }
   },
@@ -341,6 +344,7 @@ const { data } = await client.getCustomVariables()
     "name": "My Custom table",
     "key": "my_custom_table",
     "_tags": ["string"],
+    "_manifest": ["string"],
     "helper_params": ["param1", "param2"],
     "helper_logic": "return param1 * param2;",
     "config": {
@@ -378,6 +382,7 @@ const { data } = await client.createCustomVariable(
     name: 'My Custom table',
     key: 'my_custom_table',
     _tags: ['string'],
+    _manifest: ['string'],
     helper_params: ['param1', 'param2'],
     helper_logic: 'return param1 * param2;',
     config: {
@@ -539,6 +544,7 @@ const { data } = await client.createCustomVariable(
   "name": "My Custom table",
   "key": "my_custom_table",
   "_tags": ["string"],
+  "_manifest": ["string"],
   "helper_params": ["param1", "param2"],
   "helper_logic": "return param1 * param2;",
   "config": {
@@ -619,6 +625,7 @@ const { data } = await client.searchCustomVariables(
       "name": "My Custom table",
       "key": "my_custom_table",
       "_tags": ["string"],
+      "_manifest": ["string"],
       "helper_params": ["param1", "param2"],
       "helper_logic": "return param1 * param2;",
       "config": {},
@@ -654,6 +661,7 @@ const { data } = await client.updateCustomVariable(
     name: 'My Custom table',
     key: 'my_custom_table',
     _tags: ['string'],
+    _manifest: ['string'],
     helper_params: ['param1', 'param2'],
     helper_logic: 'return param1 * param2;',
     config: {
@@ -815,6 +823,7 @@ const { data } = await client.updateCustomVariable(
   "name": "My Custom table",
   "key": "my_custom_table",
   "_tags": ["string"],
+  "_manifest": ["string"],
   "helper_params": ["param1", "param2"],
   "helper_logic": "return param1 * param2;",
   "config": {
@@ -884,6 +893,7 @@ const { data } = await client.getCustomVariable({
   "name": "My Custom table",
   "key": "my_custom_table",
   "_tags": ["string"],
+  "_manifest": ["string"],
   "helper_params": ["param1", "param2"],
   "helper_logic": "return param1 * param2;",
   "config": {
@@ -965,6 +975,7 @@ const { data } = await client.getBluePrintTableConfig()
   "name": "My Custom table",
   "key": "my_custom_table",
   "_tags": ["string"],
+  "_manifest": ["string"],
   "helper_params": ["param1", "param2"],
   "helper_logic": "return param1 * param2;",
   "config": {
@@ -1039,6 +1050,7 @@ type VariableParameters = {
   context_data?: object
   template_name?: string
   template_tags?: string[]
+  template_id?: string
   variables_version?: string
 }
 ```
@@ -1129,6 +1141,7 @@ type CustomVariable = {
   name?: string
   key: string
   _tags?: string[]
+  _manifest?: string[]
   helper_params?: string[]
   helper_logic?: string
   config?: object

package/docs/user.md

@@ -91,6 +91,7 @@ const { data } = await userClient.signUpUser(...)
 - [`UserV2`](#userv2)
 - [`User`](#user)
 - [`LoginParameters`](#loginparameters)
+- [`GroupImageUri`](#groupimageuri)
 - [`CreateGroupReq`](#creategroupreq)
 - [`UpdateGroupReq`](#updategroupreq)
 - [`Group`](#group)
@@ -832,7 +833,10 @@ const { data } = await client.getGroupsForUser({
     },
     "users": [
       {}
-    ]
+    ],
+    "image_uri": {
+      "gradient_colors": ["#0588f0", "#3358d4"]
+    }
   }
 ]
 ```
@@ -871,7 +875,8 @@ const { data } = await client.getGroups({
       "updated_at": "2024-02-08T04:44:32.246Z",
       "created_by": "123",
       "crt_assignee": {},
-      "users": []
+      "users": [],
+      "image_uri": {}
     }
   ]
 }
@@ -892,7 +897,10 @@ const { data } = await client.createGroup(
   null,
   {
     name: 'Finance',
-    user_ids: ['123', '456']
+    user_ids: ['123', '456'],
+    image_uri: {
+      gradient_colors: ['#0588f0', '#3358d4']
+    }
   },
 )
 ```
@@ -987,7 +995,10 @@ const { data } = await client.createGroup(
       "email_notification_setting": {},
       "properties": []
     }
-  ]
+  ],
+  "image_uri": {
+    "gradient_colors": ["#0588f0", "#3358d4"]
+  }
 }
 ```
 
@@ -1098,7 +1109,10 @@ const { data } = await client.getGroup({
       "email_notification_setting": {},
       "properties": []
     }
-  ]
+  ],
+  "image_uri": {
+    "gradient_colors": ["#0588f0", "#3358d4"]
+  }
 }
 ```
 
@@ -1119,7 +1133,10 @@ const { data } = await client.updateGroup(
   },
   {
     name: 'Finance',
-    user_ids: ['123', '456']
+    user_ids: ['123', '456'],
+    image_uri: {
+      gradient_colors: ['#0588f0', '#3358d4']
+    }
   },
 )
 ```
@@ -1214,7 +1231,10 @@ const { data } = await client.updateGroup(
       "email_notification_setting": {},
       "properties": []
     }
-  ]
+  ],
+  "image_uri": {
+    "gradient_colors": ["#0588f0", "#3358d4"]
+  }
 }
 ```
 
@@ -1338,7 +1358,10 @@ const { data } = await client.advanceUserAssignment({
       "email_notification_setting": {},
       "properties": []
     }
-  ]
+  ],
+  "image_uri": {
+    "gradient_colors": ["#0588f0", "#3358d4"]
+  }
 }
 ```
 
@@ -2303,12 +2326,31 @@ type LoginParameters = {
 }
 ```
 
+### `GroupImageUri`
+
+Group's profile image or gradient colors. Supports uploaded image URLs and generated gradient avatars.
+
+```ts
+type GroupImageUri = {
+  original?: string // uri
+  thumbnail_32?: string // uri
+  thumbnail_64?: string // uri
+  gradient_colors?: string[]
+}
+```
+
 ### `CreateGroupReq`
 
 ```ts
 type CreateGroupReq = {
   name: string
   user_ids?: string[]
+  image_uri?: {
+    original?: string // uri
+    thumbnail_32?: string // uri
+    thumbnail_64?: string // uri
+    gradient_colors?: string[]
+  }
 }
 ```
 
@@ -2318,6 +2360,12 @@ type CreateGroupReq = {
 type UpdateGroupReq = {
   name?: string
   user_ids?: string[]
+  image_uri?: {
+    original?: string // uri
+    thumbnail_32?: string // uri
+    thumbnail_64?: string // uri
+    gradient_colors?: string[]
+  }
 }
 ```
 
@@ -2398,6 +2446,12 @@ type Group = {
       value: { ... }
     }>
   }>
+  image_uri?: {
+    original?: string // uri
+    thumbnail_32?: string // uri
+    thumbnail_64?: string // uri
+    gradient_colors?: string[]
+  }
 }
 ```
 

package/docs/workflow-definition.md

@@ -181,7 +181,8 @@ const { data } = await client.getDefinitions()
       {}
     ],
     "taxonomies": ["string"],
-    "singleClosingReasonSelection": true
+    "singleClosingReasonSelection": true,
+    "_manifest": ["string"]
   }
 ]
 ```
@@ -261,7 +262,8 @@ const { data } = await client.createDefinition(
       }
     ],
     taxonomies: ['string'],
-    singleClosingReasonSelection: true
+    singleClosingReasonSelection: true,
+    _manifest: ['string']
   },
 )
 ```
@@ -332,7 +334,8 @@ const { data } = await client.createDefinition(
     }
   ],
   "taxonomies": ["string"],
-  "singleClosingReasonSelection": true
+  "singleClosingReasonSelection": true,
+  "_manifest": ["string"]
 }
 ```
 
@@ -381,7 +384,8 @@ const { data } = await client.listFlowTemplates({
       "closing_reasons": [],
       "entity_sync": [],
       "taxonomies": ["string"],
-      "singleClosingReasonSelection": true
+      "singleClosingReasonSelection": true,
+      "_manifest": ["string"]
     }
   ]
 }
@@ -512,7 +516,8 @@ const { data } = await client.createFlowTemplate(
       }
     ],
     taxonomies: ['string'],
-    singleClosingReasonSelection: true
+    singleClosingReasonSelection: true,
+    _manifest: ['string']
   },
 )
 ```
@@ -631,7 +636,8 @@ const { data } = await client.createFlowTemplate(
     }
   ],
   "taxonomies": ["string"],
-  "singleClosingReasonSelection": true
+  "singleClosingReasonSelection": true,
+  "_manifest": ["string"]
 }
 ```
 
@@ -689,7 +695,8 @@ const { data } = await client.searchFlowTemplates(
       "closing_reasons": [],
       "entity_sync": [],
       "taxonomies": ["string"],
-      "singleClosingReasonSelection": true
+      "singleClosingReasonSelection": true,
+      "_manifest": ["string"]
     }
   ]
 }
@@ -825,7 +832,8 @@ const { data } = await client.getFlowTemplate({
     }
   ],
   "taxonomies": ["string"],
-  "singleClosingReasonSelection": true
+  "singleClosingReasonSelection": true,
+  "_manifest": ["string"]
 }
 ```
 
@@ -956,7 +964,8 @@ const { data } = await client.updateFlowTemplate(
       }
     ],
     taxonomies: ['string'],
-    singleClosingReasonSelection: true
+    singleClosingReasonSelection: true,
+    _manifest: ['string']
   },
 )
 ```
@@ -1075,7 +1084,8 @@ const { data } = await client.updateFlowTemplate(
     }
   ],
   "taxonomies": ["string"],
-  "singleClosingReasonSelection": true
+  "singleClosingReasonSelection": true,
+  "_manifest": ["string"]
 }
 ```
 
@@ -1223,7 +1233,8 @@ const { data } = await client.duplicateFlowTemplate({
     }
   ],
   "taxonomies": ["string"],
-  "singleClosingReasonSelection": true
+  "singleClosingReasonSelection": true,
+  "_manifest": ["string"]
 }
 ```
 
@@ -1309,7 +1320,8 @@ const { data } = await client.getDefinition({
     }
   ],
   "taxonomies": ["string"],
-  "singleClosingReasonSelection": true
+  "singleClosingReasonSelection": true,
+  "_manifest": ["string"]
 }
 ```
 
@@ -1390,7 +1402,8 @@ const { data } = await client.updateDefinition(
       }
     ],
     taxonomies: ['string'],
-    singleClosingReasonSelection: true
+    singleClosingReasonSelection: true,
+    _manifest: ['string']
   },
 )
 ```
@@ -1461,7 +1474,8 @@ const { data } = await client.updateDefinition(
     }
   ],
   "taxonomies": ["string"],
-  "singleClosingReasonSelection": true
+  "singleClosingReasonSelection": true,
+  "_manifest": ["string"]
 }
 ```