@epilot/customer-portal-client 0.30.6 → 0.30.7-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +144 -20
  3. package/package.json +1 -1
  4. package/src/openapi-runtime.json +13 -0
  5. package/src/openapi.json +115 -16
package/dist/openapi.d.ts CHANGED
@@ -836,7 +836,13 @@ declare namespace Components {
836
836
  * 5da0a718-c822-403d-9f5d-20d4584e0528
837
837
  */
838
838
  EntityId /* uuid */;
839
- self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "USER_ACCOUNT_SELF_MANAGEMENT" | "DENY";
839
+ self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY";
840
+ /**
841
+ * Enable or disable user account self management
842
+ * example:
843
+ * false
844
+ */
845
+ user_account_self_management?: boolean;
840
846
  /**
841
847
  * Feature settings for the portal
842
848
  */
@@ -1194,7 +1200,13 @@ declare namespace Components {
1194
1200
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1195
1201
  */
1196
1202
  EntityId /* uuid */;
1197
- self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "USER_ACCOUNT_SELF_MANAGEMENT" | "DENY";
1203
+ self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY";
1204
+ /**
1205
+ * Enable or disable user account self management
1206
+ * example:
1207
+ * false
1208
+ */
1209
+ user_account_self_management?: boolean;
1198
1210
  /**
1199
1211
  * Feature settings for the portal
1200
1212
  */
@@ -2951,6 +2963,10 @@ declare namespace Components {
2951
2963
  body?: {
2952
2964
  [key: string]: any;
2953
2965
  };
2966
+ /**
2967
+ * Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
2968
+ */
2969
+ result?: string;
2954
2970
  };
2955
2971
  /**
2956
2972
  * Name of the Contact attribute to update with the matched Contact ID. Must be a Contact relation attribute supporting multiple entities.
@@ -3164,9 +3180,9 @@ declare namespace Components {
3164
3180
  [key: string]: any;
3165
3181
  };
3166
3182
  /**
3167
- * Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. Supports variable interpolation.
3183
+ * Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
3168
3184
  */
3169
- result: string;
3185
+ result?: string;
3170
3186
  };
3171
3187
  /**
3172
3188
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
@@ -3718,6 +3734,12 @@ declare namespace Components {
3718
3734
  * The external ID of the reading
3719
3735
  */
3720
3736
  external_id?: string;
3737
+ /**
3738
+ * A note or comment for the reading
3739
+ * example:
3740
+ * Customer reported unusual consumption
3741
+ */
3742
+ note?: string | null;
3721
3743
  /**
3722
3744
  * Additional metadata for the reading
3723
3745
  * example:
@@ -4329,7 +4351,13 @@ declare namespace Components {
4329
4351
  * 5da0a718-c822-403d-9f5d-20d4584e0528
4330
4352
  */
4331
4353
  EntityId /* uuid */;
4332
- self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "USER_ACCOUNT_SELF_MANAGEMENT" | "DENY";
4354
+ self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY";
4355
+ /**
4356
+ * Enable or disable user account self management
4357
+ * example:
4358
+ * false
4359
+ */
4360
+ user_account_self_management?: boolean;
4333
4361
  /**
4334
4362
  * Feature settings for the portal
4335
4363
  */
@@ -4770,7 +4798,13 @@ declare namespace Components {
4770
4798
  * 5da0a718-c822-403d-9f5d-20d4584e0528
4771
4799
  */
4772
4800
  EntityId /* uuid */;
4773
- self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "USER_ACCOUNT_SELF_MANAGEMENT" | "DENY";
4801
+ self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY";
4802
+ /**
4803
+ * Enable or disable user account self management
4804
+ * example:
4805
+ * false
4806
+ */
4807
+ user_account_self_management?: boolean;
4774
4808
  /**
4775
4809
  * Feature settings for the portal
4776
4810
  */
@@ -5789,7 +5823,13 @@ declare namespace Components {
5789
5823
  * 5da0a718-c822-403d-9f5d-20d4584e0528
5790
5824
  */
5791
5825
  EntityId /* uuid */;
5792
- self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "USER_ACCOUNT_SELF_MANAGEMENT" | "DENY";
5826
+ self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY";
5827
+ /**
5828
+ * Enable or disable user account self management
5829
+ * example:
5830
+ * false
5831
+ */
5832
+ user_account_self_management?: boolean;
5793
5833
  /**
5794
5834
  * Feature settings for the portal
5795
5835
  */
@@ -6184,7 +6224,13 @@ declare namespace Components {
6184
6224
  * 5da0a718-c822-403d-9f5d-20d4584e0528
6185
6225
  */
6186
6226
  EntityId /* uuid */;
6187
- self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "USER_ACCOUNT_SELF_MANAGEMENT" | "DENY";
6227
+ self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY";
6228
+ /**
6229
+ * Enable or disable user account self management
6230
+ * example:
6231
+ * false
6232
+ */
6233
+ user_account_self_management?: boolean;
6188
6234
  /**
6189
6235
  * Feature settings for the portal
6190
6236
  */
@@ -8049,6 +8095,20 @@ declare namespace Paths {
8049
8095
  export type $500 = Components.Responses.InternalServerError;
8050
8096
  }
8051
8097
  }
8098
+ namespace GetEmailTemplatesByPortalId {
8099
+ namespace Parameters {
8100
+ export type PortalId = string;
8101
+ }
8102
+ export interface PathParameters {
8103
+ portal_id: Parameters.PortalId;
8104
+ }
8105
+ namespace Responses {
8106
+ export type $200 = /* Email templates used for authentication and internal processes */ Components.Schemas.EmailTemplates;
8107
+ export type $401 = Components.Responses.Unauthorized;
8108
+ export type $403 = Components.Responses.Forbidden;
8109
+ export type $500 = Components.Responses.InternalServerError;
8110
+ }
8111
+ }
8052
8112
  namespace GetEntityActivityFeed {
8053
8113
  namespace Parameters {
8054
8114
  export type After = string; // date-time
@@ -8400,7 +8460,13 @@ declare namespace Paths {
8400
8460
  * 5da0a718-c822-403d-9f5d-20d4584e0528
8401
8461
  */
8402
8462
  Components.Schemas.EntityId /* uuid */;
8403
- self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "USER_ACCOUNT_SELF_MANAGEMENT" | "DENY";
8463
+ self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY";
8464
+ /**
8465
+ * Enable or disable user account self management
8466
+ * example:
8467
+ * false
8468
+ */
8469
+ user_account_self_management?: boolean;
8404
8470
  /**
8405
8471
  * Feature settings for the portal
8406
8472
  */
@@ -9838,17 +9904,28 @@ declare namespace Paths {
9838
9904
  }
9839
9905
  namespace ReplaceECPTemplateVariables {
9840
9906
  export interface RequestBody {
9841
- [name: string]: {
9842
- /**
9843
- * ID of the entity
9844
- */
9845
- _id?: /**
9846
- * Entity ID
9847
- * example:
9848
- * 5da0a718-c822-403d-9f5d-20d4584e0528
9849
- */
9850
- Components.Schemas.EntityId /* uuid */;
9851
- is_main_entity?: boolean;
9907
+ /**
9908
+ * ID of the template
9909
+ */
9910
+ template_id?: /**
9911
+ * Entity ID
9912
+ * example:
9913
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
9914
+ */
9915
+ Components.Schemas.EntityId /* uuid */;
9916
+ entity_context?: {
9917
+ [name: string]: {
9918
+ /**
9919
+ * ID of the entity
9920
+ */
9921
+ _id?: /**
9922
+ * Entity ID
9923
+ * example:
9924
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
9925
+ */
9926
+ Components.Schemas.EntityId /* uuid */;
9927
+ is_main_entity?: boolean;
9928
+ };
9852
9929
  };
9853
9930
  }
9854
9931
  namespace Responses {
@@ -9903,6 +9980,31 @@ declare namespace Paths {
9903
9980
  */
9904
9981
  userEmailsOnEntity?: string[];
9905
9982
  };
9983
+ portalUser?: {
9984
+ /**
9985
+ * example:
9986
+ * https://employee-portal.ecp.dev.epilot.io/register?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com
9987
+ */
9988
+ invitationLink?: string;
9989
+ /**
9990
+ * example:
9991
+ * https://employee-portal.ecp.dev.epilot.io/requests/opportunities/b8fef220-abe0-4382-a704-26848f60977b
9992
+ */
9993
+ newDocumentLink?: string;
9994
+ /**
9995
+ * example:
9996
+ * https://employee-portal.ecp.dev.epilot.io/requests/opportunities/b8fef220-abe0-4382-a704-26848f60977b
9997
+ */
9998
+ entityLink?: string;
9999
+ /**
10000
+ * example:
10001
+ * [
10002
+ * "peter@doe.com",
10003
+ * "jane@doe.com"
10004
+ * ]
10005
+ */
10006
+ userEmailsOnEntity?: string[];
10007
+ };
9906
10008
  }
9907
10009
  export type $401 = Components.Responses.Unauthorized;
9908
10010
  export type $500 = Components.Responses.InternalServerError;
@@ -10978,6 +11080,16 @@ export interface OperationMethods {
10978
11080
  data?: Paths.UpsertEmailTemplates.RequestBody,
10979
11081
  config?: AxiosRequestConfig
10980
11082
  ): OperationResponse<Paths.UpsertEmailTemplates.Responses.$200>
11083
+ /**
11084
+ * getEmailTemplatesByPortalId - getEmailTemplatesByPortalId
11085
+ *
11086
+ * Retrieves the email templates of a portal by portal ID
11087
+ */
11088
+ 'getEmailTemplatesByPortalId'(
11089
+ parameters?: Parameters<Paths.GetEmailTemplatesByPortalId.PathParameters> | null,
11090
+ data?: any,
11091
+ config?: AxiosRequestConfig
11092
+ ): OperationResponse<Paths.GetEmailTemplatesByPortalId.Responses.$200>
10981
11093
  /**
10982
11094
  * getPublicPortalWidgets - getPublicPortalWidgets
10983
11095
  *
@@ -12192,6 +12304,18 @@ export interface PathsDictionary {
12192
12304
  config?: AxiosRequestConfig
12193
12305
  ): OperationResponse<Paths.GetEmailTemplates.Responses.$200>
12194
12306
  }
12307
+ ['/v2/portal/email-templates/{portal_id}']: {
12308
+ /**
12309
+ * getEmailTemplatesByPortalId - getEmailTemplatesByPortalId
12310
+ *
12311
+ * Retrieves the email templates of a portal by portal ID
12312
+ */
12313
+ 'get'(
12314
+ parameters?: Parameters<Paths.GetEmailTemplatesByPortalId.PathParameters> | null,
12315
+ data?: any,
12316
+ config?: AxiosRequestConfig
12317
+ ): OperationResponse<Paths.GetEmailTemplatesByPortalId.Responses.$200>
12318
+ }
12195
12319
  ['/v2/portal/public-widgets']: {
12196
12320
  /**
12197
12321
  * getPublicPortalWidgets - getPublicPortalWidgets
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/customer-portal-client",
3
- "version": "0.30.6",
3
+ "version": "0.30.7-rc.2",
4
4
  "description": "API Client for epilot portal API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/openapi-runtime.json CHANGED
@@ -400,6 +400,19 @@
400
400
  "responses": {}
401
401
  }
402
402
  },
403
+ "/v2/portal/email-templates/{portal_id}": {
404
+ "get": {
405
+ "operationId": "getEmailTemplatesByPortalId",
406
+ "parameters": [
407
+ {
408
+ "in": "path",
409
+ "name": "portal_id",
410
+ "required": true
411
+ }
412
+ ],
413
+ "responses": {}
414
+ }
415
+ },
403
416
  "/v2/portal/public-widgets": {
404
417
  "get": {
405
418
  "operationId": "getPublicPortalWidgets",
package/src/openapi.json CHANGED
@@ -1555,6 +1555,53 @@
1555
1555
  }
1556
1556
  }
1557
1557
  },
1558
+ "/v2/portal/email-templates/{portal_id}": {
1559
+ "get": {
1560
+ "operationId": "getEmailTemplatesByPortalId",
1561
+ "summary": "getEmailTemplatesByPortalId",
1562
+ "description": "Retrieves the email templates of a portal by portal ID",
1563
+ "tags": [
1564
+ "ECP Admin"
1565
+ ],
1566
+ "security": [
1567
+ {
1568
+ "EpilotAuth": []
1569
+ }
1570
+ ],
1571
+ "parameters": [
1572
+ {
1573
+ "in": "path",
1574
+ "name": "portal_id",
1575
+ "required": true,
1576
+ "schema": {
1577
+ "type": "string"
1578
+ },
1579
+ "description": "ID of the portal"
1580
+ }
1581
+ ],
1582
+ "responses": {
1583
+ "200": {
1584
+ "description": "Retrieved the email templates successfully.",
1585
+ "content": {
1586
+ "application/json": {
1587
+ "schema": {
1588
+ "$ref": "#/components/schemas/EmailTemplates"
1589
+ }
1590
+ }
1591
+ }
1592
+ },
1593
+ "401": {
1594
+ "$ref": "#/components/responses/Unauthorized"
1595
+ },
1596
+ "403": {
1597
+ "$ref": "#/components/responses/Forbidden"
1598
+ },
1599
+ "500": {
1600
+ "$ref": "#/components/responses/InternalServerError"
1601
+ }
1602
+ }
1603
+ }
1604
+ },
1558
1605
  "/v2/portal/public-widgets": {
1559
1606
  "get": {
1560
1607
  "operationId": "getPublicPortalWidgets",
@@ -1743,15 +1790,24 @@
1743
1790
  "application/json": {
1744
1791
  "schema": {
1745
1792
  "type": "object",
1746
- "additionalProperties": {
1747
- "type": "object",
1748
- "properties": {
1749
- "_id": {
1750
- "$ref": "#/components/schemas/EntityId",
1751
- "description": "ID of the entity"
1752
- },
1753
- "is_main_entity": {
1754
- "type": "boolean"
1793
+ "properties": {
1794
+ "template_id": {
1795
+ "$ref": "#/components/schemas/EntityId",
1796
+ "description": "ID of the template"
1797
+ },
1798
+ "entity_context": {
1799
+ "type": "object",
1800
+ "additionalProperties": {
1801
+ "type": "object",
1802
+ "properties": {
1803
+ "_id": {
1804
+ "$ref": "#/components/schemas/EntityId",
1805
+ "description": "ID of the entity"
1806
+ },
1807
+ "is_main_entity": {
1808
+ "type": "boolean"
1809
+ }
1810
+ }
1755
1811
  }
1756
1812
  }
1757
1813
  }
@@ -1820,6 +1876,33 @@
1820
1876
  }
1821
1877
  }
1822
1878
  }
1879
+ },
1880
+ "portalUser": {
1881
+ "type": "object",
1882
+ "properties": {
1883
+ "invitationLink": {
1884
+ "type": "string",
1885
+ "example": "https://employee-portal.ecp.dev.epilot.io/register?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com"
1886
+ },
1887
+ "newDocumentLink": {
1888
+ "type": "string",
1889
+ "example": "https://employee-portal.ecp.dev.epilot.io/requests/opportunities/b8fef220-abe0-4382-a704-26848f60977b"
1890
+ },
1891
+ "entityLink": {
1892
+ "type": "string",
1893
+ "example": "https://employee-portal.ecp.dev.epilot.io/requests/opportunities/b8fef220-abe0-4382-a704-26848f60977b"
1894
+ },
1895
+ "userEmailsOnEntity": {
1896
+ "type": "array",
1897
+ "example": [
1898
+ "peter@doe.com",
1899
+ "jane@doe.com"
1900
+ ],
1901
+ "items": {
1902
+ "type": "string"
1903
+ }
1904
+ }
1905
+ }
1823
1906
  }
1824
1907
  }
1825
1908
  }
@@ -8333,10 +8416,14 @@
8333
8416
  "enum": [
8334
8417
  "ALLOW_WITH_CONTACT_CREATION",
8335
8418
  "ALLOW_WITHOUT_CONTACT_CREATION",
8336
- "USER_ACCOUNT_SELF_MANAGEMENT",
8337
8419
  "DENY"
8338
8420
  ]
8339
8421
  },
8422
+ "user_account_self_management": {
8423
+ "type": "boolean",
8424
+ "description": "Enable or disable user account self management",
8425
+ "example": false
8426
+ },
8340
8427
  "feature_settings": {
8341
8428
  "type": "object",
8342
8429
  "description": "Feature settings for the portal",
@@ -11779,13 +11866,12 @@
11779
11866
  },
11780
11867
  "result": {
11781
11868
  "type": "string",
11782
- "description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. Supports variable interpolation."
11869
+ "description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
11783
11870
  }
11784
11871
  },
11785
11872
  "required": [
11786
11873
  "url",
11787
- "headers",
11788
- "result"
11874
+ "headers"
11789
11875
  ]
11790
11876
  },
11791
11877
  "use_static_ips": {
@@ -11843,12 +11929,15 @@
11843
11929
  "body": {
11844
11930
  "type": "object",
11845
11931
  "description": "Optional JSON body to use for the call. Defaults to object with all configured identifiers grouped by entity, e.g. `{\"contract\": {\"contract_name\": \"Name\"}}`. Supports variable interpolation."
11932
+ },
11933
+ "result": {
11934
+ "type": "string",
11935
+ "description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
11846
11936
  }
11847
11937
  },
11848
11938
  "required": [
11849
11939
  "url",
11850
- "headers",
11851
- "result"
11940
+ "headers"
11852
11941
  ]
11853
11942
  },
11854
11943
  "contact_relation_attribute": {
@@ -12348,6 +12437,12 @@
12348
12437
  "type": "string",
12349
12438
  "description": "The external ID of the reading"
12350
12439
  },
12440
+ "note": {
12441
+ "type": "string",
12442
+ "nullable": true,
12443
+ "description": "A note or comment for the reading",
12444
+ "example": "Customer reported unusual consumption"
12445
+ },
12351
12446
  "metadata": {
12352
12447
  "type": "object",
12353
12448
  "additionalProperties": {
@@ -13024,10 +13119,14 @@
13024
13119
  "enum": [
13025
13120
  "ALLOW_WITH_CONTACT_CREATION",
13026
13121
  "ALLOW_WITHOUT_CONTACT_CREATION",
13027
- "USER_ACCOUNT_SELF_MANAGEMENT",
13028
13122
  "DENY"
13029
13123
  ]
13030
13124
  },
13125
+ "user_account_self_management": {
13126
+ "type": "boolean",
13127
+ "description": "Enable or disable user account self management",
13128
+ "example": false
13129
+ },
13031
13130
  "feature_settings": {
13032
13131
  "type": "object",
13033
13132
  "description": "Feature settings for the portal",