@epilot/sdk 2.2.6 → 2.3.0

package/docs/design.md

@@ -1,6 +1,6 @@
 # Design Builder API v2
 
-- **Base URL:** `https://design-builder-api.epilot.io`
+- **Base URL:** `https://design-builder-api.{environment}.epilot.io`
 - **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)
 
 ## Usage
@@ -49,6 +49,7 @@ const { data } = await designClient.getAllDesigns(...)
 - [`UpdateDesignReq`](#updatedesignreq)
 - [`ItemMetada`](#itemmetada)
 - [`AddConsumerReq`](#addconsumerreq)
+- [`RemoveConsumerReq`](#removeconsumerreq)
 - [`DesignItem`](#designitem)
 - [`BrandItem`](#branditem)
 - [`Custom_Style`](#custom_style)
@@ -65,6 +66,10 @@ const { data } = await designClient.getAllDesigns(...)
 - [`WidgetPortalData`](#widgetportaldata)
 - [`ErrorResp`](#errorresp)
 - [`FileData`](#filedata)
+- [`DesignId`](#designid)
+- [`Theme`](#theme)
+- [`Application`](#application)
+- [`DesignParameters`](#designparameters)
 
 ### `getAllDesigns`
 
@@ -80,91 +85,90 @@ const { data } = await client.getAllDesigns()
 <summary>Response</summary>
 
 ```json
-[
-  {
-    "designs": [
-      {
-        "id": "string",
-        "created_at": "2021-01-30T08:30:00Z",
-        "created_by": "string",
-        "edited": true,
-        "last_modified_at": "string",
-        "brand_id": "string",
-        "brand_name": "string",
-        "user": {
-          "emailaddress": "string",
-          "fullname": "string",
-          "name": "string",
-          "userid": "string"
+{
+  "designs": [
+    {
+      "id": "string",
+      "created_at": "2021-01-30T08:30:00Z",
+      "created_by": "string",
+      "edited": true,
+      "last_modified_at": "string",
+      "brand_id": "string",
+      "brand_name": "string",
+      "user": {
+        "emailaddress": "string",
+        "fullname": "string",
+        "name": "string",
+        "userid": "string"
+      },
+      "style_name": "string",
+      "style": {
+        "logo": {
+          "main": {
+            "name": "string",
+            "display_name": "string",
+            "file_type": "LOGO",
+            "s3_object_key": "string",
+            "url": "string"
+          }
         },
-        "style_name": "string",
-        "style": {
-          "logo": {
-            "main": {
-              "name": "string",
-              "display_name": "string",
-              "file_type": "LOGO",
-              "s3_object_key": "string",
-              "url": "string"
-            }
-          },
-          "palette": {
-            "primary": "string",
-            "secondary": "string",
-            "error": "string",
-            "background": "string",
-            "paper": "string",
-            "navbar": "string",
-            "portal_login_background": "string"
-          },
-          "typography": {
-            "font": {
-              "font_id": "string",
-              "font_name": "string",
-              "font_family": "string",
-              "font_weight_regular": "string",
-              "font_weight_medium": "string",
-              "font_weight_bold": "string",
-              "urls": [
-                {
-                  "type": "WOFF2",
-                  "url": "string"
-                }
-              ]
-            },
-            "primary": "string",
-            "secondary": "string"
-          },
-          "shape": {
-            "border_radius": 0
-          },
-          "consumer": {
-            "widgets": [
-              {
-                "id": "string",
-                "name": "string"
-              }
-            ],
-            "customer_portals": [
+        "palette": {
+          "primary": "string",
+          "secondary": "string",
+          "error": "string",
+          "background": "string",
+          "paper": "string",
+          "navbar": "string",
+          "portal_login_background": "string"
+        },
+        "typography": {
+          "font": {
+            "font_id": "string",
+            "font_name": "string",
+            "font_family": "string",
+            "font_weight_regular": "string",
+            "font_weight_medium": "string",
+            "font_weight_bold": "string",
+            "urls": [
               {
-                "id": "string",
-                "name": "string"
+                "type": "WOFF2",
+                "url": "string"
               }
             ]
-          }
+          },
+          "primary": "string",
+          "secondary": "string"
         },
-        "is_default": true,
-        "custom_theme": "string",
-        "use_custom_theme": true,
-        "design_tokens": {
-          "coupon": "string",
-          "cashback": "string",
-          "custom_css": "string"
+        "shape": {
+          "border_radius": 0
+        },
+        "consumer": {
+          "widgets": [
+            {
+              "id": "string",
+              "name": "string"
+            }
+          ],
+          "customer_portals": [
+            {
+              "id": "string",
+              "name": "string"
+            }
+          ]
         }
+      },
+      "is_default": true,
+      "_manifest": ["string"],
+      "custom_theme": "string",
+      "use_custom_theme": true,
+      "design_tokens": {
+        "coupon": "string",
+        "cashback": "string",
+        "custom_css": "string"
       }
-    ]
-  }
-]
+    }
+  ]
+}
 ```
 
 </details>
@@ -247,6 +251,7 @@ const { data } = await client.addDesign(
         }
       },
       is_default: true,
+      _manifest: ['string'],
       custom_theme: 'string',
       use_custom_theme: true,
       design_tokens: {
@@ -335,6 +340,7 @@ const { data } = await client.addDesign(
       }
     },
     "is_default": true,
+    "_manifest": ["string"],
     "custom_theme": "string",
     "use_custom_theme": true,
     "design_tokens": {
@@ -438,6 +444,7 @@ const { data } = await client.getDesign({
       }
     },
     "is_default": true,
+    "_manifest": ["string"],
     "custom_theme": "string",
     "use_custom_theme": true,
     "design_tokens": {
@@ -545,6 +552,7 @@ const { data } = await client.updateDesign(
         }
       },
       is_default: true,
+      _manifest: ['string'],
       custom_theme: 'string',
       use_custom_theme: true,
       design_tokens: {
@@ -731,6 +739,7 @@ const { data } = await client.getConsumerDesign({
       }
     },
     "is_default": true,
+    "_manifest": ["string"],
     "custom_theme": "string",
     "use_custom_theme": true,
     "design_tokens": {
@@ -759,7 +768,7 @@ const { data } = await client.addConsumer(
     application: 'example',
   },
   {
-    consumer_id: 'string',
+    consumer_id: '4a062990-a6a3-11eb-9828-4f3da7d4935a',
     consumer_name: 'string',
     should_delete: 'string'
   },
@@ -781,8 +790,7 @@ const { data } = await client.removeConsumer(
     application: 'example',
   },
   {
-    consumer_id: 'string',
-    consumer_name: 'string',
+    consumer_id: '4a062990-a6a3-11eb-9828-4f3da7d4935a',
     should_delete: 'string'
   },
 )
@@ -854,6 +862,7 @@ type GetAllDesignsRes = {
       consumer: { ... }
     }
     is_default?: boolean
+    _manifest?: string[]
     custom_theme?: string
     use_custom_theme?: boolean
     design_tokens?: {
@@ -905,6 +914,7 @@ type AddDesignReq = {
       consumer: { ... }
     }
     is_default?: boolean
+    _manifest?: string[]
     custom_theme?: string
     use_custom_theme?: boolean
     design_tokens?: {
@@ -943,6 +953,7 @@ type AddDesignRes = {
       consumer: { ... }
     }
     is_default?: boolean
+    _manifest?: string[]
     custom_theme?: string
     use_custom_theme?: boolean
     design_tokens?: {
@@ -981,6 +992,7 @@ type GetDesignRes = {
       consumer: { ... }
     }
     is_default?: boolean
+    _manifest?: string[]
     custom_theme?: string
     use_custom_theme?: boolean
     design_tokens?: {
@@ -1014,6 +1026,7 @@ type UpdateDesignReq = {
       consumer: { ... }
     }
     is_default?: boolean
+    _manifest?: string[]
     custom_theme?: string
     use_custom_theme?: boolean
     design_tokens?: {
@@ -1047,6 +1060,15 @@ type AddConsumerReq = {
 }
 ```
 
+### `RemoveConsumerReq`
+
+```ts
+type RemoveConsumerReq = {
+  consumer_id: string
+  should_delete?: string
+}
+```
+
 ### `DesignItem`
 
 ```ts
@@ -1087,6 +1109,7 @@ type DesignItem = {
     }
   }
   is_default?: boolean
+  _manifest?: string[]
 }
 ```
 
@@ -1257,6 +1280,7 @@ type WidgetPortalData = {
 ```ts
 type ErrorResp = {
   message?: string
+  error?: object
 }
 ```
 
@@ -1271,3 +1295,37 @@ type FileData = {
   url: string
 }
 ```
+
+### `DesignId`
+
+Id of the design
+
+```ts
+type DesignId = string
+```
+
+### `Theme`
+
+Type of theme to be parsed and returned
+
+```ts
+type Theme = "NEW" | "OLD"
+```
+
+### `Application`
+
+Type of application that uses the design
+
+```ts
+type Application = string
+```
+
+### `DesignParameters`
+
+```ts
+type DesignParameters = {
+  designId?: string
+  theme?: "NEW" | "OLD"
+  application?: string
+}
+```

package/docs/email-settings.md

@@ -69,6 +69,7 @@ const { data } = await emailSettingsClient.provisionEpilotEmailAddress(...)
 **Domains**
 - [`addDomain`](#adddomain)
 - [`deleteDomain`](#deletedomain)
+- [`getDomains`](#getdomains)
 - [`verifyNameServers`](#verifynameservers)
 - [`verifyDomain`](#verifydomain)
 
@@ -1179,6 +1180,27 @@ const { data } = await client.deleteDomain(
 
 ---
 
+### `getDomains`
+
+Retrieves all custom email domains for the organization.
+
+`GET /v1/email-settings/domain`
+
+```ts
+const { data } = await client.getDomains()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+["string"]
+```
+
+</details>
+
+---
+
 ### `verifyNameServers`
 
 Verifies that the domain's name server (NS) records are correctly configured.

package/docs/entity.md

@@ -307,6 +307,7 @@ const { data } = await client.listSchemas({
       "dialog_config": {},
       "attributes": [],
       "_purpose": ["string"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "explicit_search_mappings": {},
       "group_headlines": []
     }
@@ -372,6 +373,7 @@ const { data } = await client.listSchemasV2({
       "dialog_config": {},
       "attributes": [],
       "_purpose": ["string"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "explicit_search_mappings": {},
       "group_headlines": []
     }
@@ -510,6 +512,7 @@ const { data } = await client.getSchema({
     }
   ],
   "_purpose": ["string"],
+  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "explicit_search_mappings": {
     "image": {
       "type": "keyword",
@@ -648,6 +651,7 @@ const { data } = await client.putSchema(
       /* ... 5 more */
     ],
     _purpose: ['string'],
+    _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
     explicit_search_mappings: {
       image: {
         type: 'keyword',
@@ -784,6 +788,7 @@ const { data } = await client.putSchema(
     }
   ],
   "_purpose": ["string"],
+  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "explicit_search_mappings": {
     "image": {
       "type": "keyword",
@@ -1030,6 +1035,7 @@ const { data } = await client.getSchemaVersions({
       "dialog_config": {},
       "attributes": [],
       "_purpose": ["string"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "explicit_search_mappings": {},
       "group_headlines": []
     }
@@ -1065,6 +1071,7 @@ const { data } = await client.getSchemaVersions({
       "dialog_config": {},
       "attributes": [],
       "_purpose": ["string"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "explicit_search_mappings": {},
       "group_headlines": []
     }
@@ -1209,6 +1216,7 @@ const { data } = await client.freezeSchema(
     }
   ],
   "_purpose": ["string"],
+  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "explicit_search_mappings": {
     "image": {
       "type": "keyword",
@@ -1360,6 +1368,7 @@ const { data } = await client.unfreezeSchema({
     }
   ],
   "_purpose": ["string"],
+  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "explicit_search_mappings": {
     "image": {
       "type": "keyword",
@@ -1474,6 +1483,7 @@ const { data } = await client.listSchemaBlueprints()
       "dialog_config": {},
       "attributes": [],
       "_purpose": ["string"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "explicit_search_mappings": {},
       "group_headlines": []
     }
@@ -6939,6 +6949,7 @@ type FileAttribute = {
   display_images_landscaped?: boolean
   enable_description?: boolean
   default_access_control?: "public-read" | "private"
+  file_size_bytes?: number
 }
 ```
 
@@ -7839,9 +7850,15 @@ type TableAttribute = {
     type?: "string" | "number" | "date" | "boolean"
     width?: string
     required?: boolean
+    bold?: boolean
   }>
   min_rows?: number
   max_rows?: number
+  transposed?: boolean
+  column_header?: {
+    template?: string
+    start?: number
+  }
 }
 ```