@usepylon/sdk 0.1.0-alpha.5 → 0.1.0-beta.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.
- package/dist/cjs/BaseClient.js +1 -1
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +51 -46
- package/dist/cjs/api/resources/accounts/client/requests/AccountsSearchRequest.d.ts +2 -0
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +25 -1
- package/dist/cjs/api/resources/contacts/client/Client.js +74 -1
- package/dist/cjs/api/resources/contacts/client/requests/ContactsMergeRequest.d.ts +1 -1
- package/dist/cjs/api/resources/contacts/client/requests/ContactsPortalInvitationRequest.d.ts +10 -0
- package/dist/cjs/api/resources/contacts/client/requests/ContactsPortalInvitationRequest.js +3 -0
- package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/customerPortal/client/Client.d.ts +53 -0
- package/dist/cjs/api/resources/customerPortal/client/Client.js +193 -0
- package/dist/cjs/api/resources/customerPortal/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/customerPortal/client/index.js +17 -0
- package/dist/cjs/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.d.ts +15 -0
- package/dist/cjs/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.js +3 -0
- package/dist/cjs/api/resources/customerPortal/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/customerPortal/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/customerPortal/exports.d.ts +2 -0
- package/dist/cjs/api/resources/customerPortal/exports.js +21 -0
- package/dist/cjs/api/resources/customerPortal/index.d.ts +1 -0
- package/dist/cjs/api/resources/customerPortal/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/issues/client/Client.d.ts +11 -0
- package/dist/cjs/api/resources/issues/client/Client.js +11 -0
- package/dist/cjs/api/resources/issues/client/requests/IssuesCreateRequest.d.ts +11 -0
- package/dist/cjs/api/resources/issues/client/requests/IssuesSearchRequest.d.ts +2 -0
- package/dist/cjs/api/resources/issues/resources/voiceCalls/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/issues/resources/voiceCalls/client/Client.js +1 -1
- package/dist/cjs/api/resources/teams/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/teams/client/Client.js +72 -0
- package/dist/cjs/api/resources/teams/client/requests/TeamsDeleteRequest.d.ts +10 -0
- package/dist/cjs/api/resources/teams/client/requests/TeamsDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/teams/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/users/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/users/client/Client.js +71 -0
- package/dist/cjs/api/resources/users/client/requests/UsersInviteRequest.d.ts +15 -0
- package/dist/cjs/api/resources/users/client/requests/UsersInviteRequest.js +3 -0
- package/dist/cjs/api/resources/users/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/ArticleVisibilityConfig.d.ts +5 -0
- package/dist/cjs/api/types/CustomerPortalAccessSettings.d.ts +16 -0
- package/dist/cjs/api/types/CustomerPortalAccessSettings.js +3 -0
- package/dist/cjs/api/types/CustomerPortalBranding.d.ts +14 -0
- package/dist/cjs/api/types/CustomerPortalBranding.js +3 -0
- package/dist/cjs/api/types/CustomerPortalDisplaySettings.d.ts +8 -0
- package/dist/cjs/api/types/CustomerPortalDisplaySettings.js +3 -0
- package/dist/cjs/api/types/CustomerPortalFooterCategory.d.ts +7 -0
- package/dist/cjs/api/types/CustomerPortalFooterCategory.js +3 -0
- package/dist/cjs/api/types/CustomerPortalInvitationResult.d.ts +4 -0
- package/dist/cjs/api/types/CustomerPortalInvitationResult.js +3 -0
- package/dist/cjs/api/types/CustomerPortalLink.d.ts +6 -0
- package/dist/cjs/api/types/CustomerPortalLink.js +3 -0
- package/dist/cjs/api/types/CustomerPortalNavigation.d.ts +7 -0
- package/dist/cjs/api/types/CustomerPortalNavigation.js +3 -0
- package/dist/cjs/api/types/CustomerPortalSettings.d.ts +11 -0
- package/dist/cjs/api/types/CustomerPortalSettings.js +3 -0
- package/dist/cjs/api/types/CustomerPortalTabs.d.ts +8 -0
- package/dist/cjs/api/types/CustomerPortalTabs.js +3 -0
- package/dist/cjs/api/types/CustomerPortalUserPermissions.d.ts +8 -0
- package/dist/cjs/api/types/CustomerPortalUserPermissions.js +3 -0
- package/dist/cjs/api/types/DeleteTeamResponseBody.d.ts +4 -0
- package/dist/cjs/api/types/DeleteTeamResponseBody.js +3 -0
- package/dist/cjs/api/types/DestinationMetadata.d.ts +2 -0
- package/dist/cjs/api/types/ErrorApiResponseBody.d.ts +7 -1
- package/dist/cjs/api/types/ExternalIssue.d.ts +8 -0
- package/dist/cjs/api/types/Filter.d.ts +17 -7
- package/dist/cjs/api/types/Filter.js +6 -1
- package/dist/cjs/api/types/FilterError.d.ts +26 -0
- package/dist/cjs/api/types/FilterError.js +3 -0
- package/dist/cjs/api/types/FilterRelatedObject.d.ts +14 -0
- package/dist/cjs/api/types/FilterRelatedObject.js +3 -0
- package/dist/cjs/api/types/GetCustomerPortalSettingsResponseBody.d.ts +6 -0
- package/dist/cjs/api/types/GetCustomerPortalSettingsResponseBody.js +3 -0
- package/dist/cjs/api/types/IssueThread.d.ts +6 -0
- package/dist/cjs/api/types/SearchAccountsSort.d.ts +23 -0
- package/dist/cjs/api/types/SearchAccountsSort.js +20 -0
- package/dist/cjs/api/types/SearchIssuesSort.d.ts +23 -0
- package/dist/cjs/api/types/SearchIssuesSort.js +20 -0
- package/dist/cjs/api/types/SendCustomerPortalInvitationResponseBody.d.ts +6 -0
- package/dist/cjs/api/types/SendCustomerPortalInvitationResponseBody.js +3 -0
- package/dist/cjs/api/types/Task.d.ts +2 -0
- package/dist/cjs/api/types/TicketFormLayoutField.d.ts +11 -1
- package/dist/cjs/api/types/UpdateCustomerPortalAccessSettings.d.ts +16 -0
- package/dist/cjs/api/types/UpdateCustomerPortalAccessSettings.js +3 -0
- package/dist/cjs/api/types/UpdateCustomerPortalBranding.d.ts +14 -0
- package/dist/cjs/api/types/UpdateCustomerPortalBranding.js +3 -0
- package/dist/cjs/api/types/UpdateCustomerPortalDisplaySettings.d.ts +8 -0
- package/dist/cjs/api/types/UpdateCustomerPortalDisplaySettings.js +3 -0
- package/dist/cjs/api/types/UpdateCustomerPortalNavigation.d.ts +7 -0
- package/dist/cjs/api/types/UpdateCustomerPortalNavigation.js +3 -0
- package/dist/cjs/api/types/UpdateCustomerPortalTabs.d.ts +8 -0
- package/dist/cjs/api/types/UpdateCustomerPortalTabs.js +3 -0
- package/dist/cjs/api/types/UpdateCustomerPortalUserPermissions.d.ts +8 -0
- package/dist/cjs/api/types/UpdateCustomerPortalUserPermissions.js +3 -0
- package/dist/cjs/api/types/VoiceCall.d.ts +2 -0
- package/dist/cjs/api/types/VoiceCallParticipant.d.ts +20 -0
- package/dist/cjs/api/types/VoiceCallParticipant.js +3 -0
- package/dist/cjs/api/types/index.d.ts +24 -0
- package/dist/cjs/api/types/index.js +24 -0
- package/dist/esm/BaseClient.js +1 -1
- package/dist/esm/Client.d.ts +3 -0
- package/dist/esm/Client.js +5 -0
- package/dist/esm/api/resources/accounts/client/requests/AccountsSearchRequest.d.ts +2 -0
- package/dist/esm/api/resources/contacts/client/Client.d.ts +25 -1
- package/dist/esm/api/resources/contacts/client/Client.js +74 -1
- package/dist/esm/api/resources/contacts/client/requests/ContactsMergeRequest.d.ts +1 -1
- package/dist/esm/api/resources/contacts/client/requests/ContactsPortalInvitationRequest.d.ts +10 -0
- package/dist/esm/api/resources/contacts/client/requests/ContactsPortalInvitationRequest.js +2 -0
- package/dist/esm/api/resources/contacts/client/requests/index.d.ts +1 -0
- package/dist/esm/api/resources/customerPortal/client/Client.d.ts +53 -0
- package/dist/esm/api/resources/customerPortal/client/Client.js +156 -0
- package/dist/esm/api/resources/customerPortal/client/index.d.ts +1 -0
- package/dist/esm/api/resources/customerPortal/client/index.js +1 -0
- package/dist/esm/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.d.ts +15 -0
- package/dist/esm/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.js +2 -0
- package/dist/esm/api/resources/customerPortal/client/requests/index.d.ts +1 -0
- package/dist/esm/api/resources/customerPortal/client/requests/index.js +1 -0
- package/dist/esm/api/resources/customerPortal/exports.d.ts +2 -0
- package/dist/esm/api/resources/customerPortal/exports.js +3 -0
- package/dist/esm/api/resources/customerPortal/index.d.ts +1 -0
- package/dist/esm/api/resources/customerPortal/index.js +1 -0
- package/dist/esm/api/resources/index.d.ts +2 -0
- package/dist/esm/api/resources/index.js +2 -0
- package/dist/esm/api/resources/issues/client/Client.d.ts +11 -0
- package/dist/esm/api/resources/issues/client/Client.js +11 -0
- package/dist/esm/api/resources/issues/client/requests/IssuesCreateRequest.d.ts +11 -0
- package/dist/esm/api/resources/issues/client/requests/IssuesSearchRequest.d.ts +2 -0
- package/dist/esm/api/resources/issues/resources/voiceCalls/client/Client.d.ts +1 -1
- package/dist/esm/api/resources/issues/resources/voiceCalls/client/Client.js +1 -1
- package/dist/esm/api/resources/teams/client/Client.d.ts +26 -0
- package/dist/esm/api/resources/teams/client/Client.js +72 -0
- package/dist/esm/api/resources/teams/client/requests/TeamsDeleteRequest.d.ts +10 -0
- package/dist/esm/api/resources/teams/client/requests/TeamsDeleteRequest.js +2 -0
- package/dist/esm/api/resources/teams/client/requests/index.d.ts +1 -0
- package/dist/esm/api/resources/users/client/Client.d.ts +25 -0
- package/dist/esm/api/resources/users/client/Client.js +71 -0
- package/dist/esm/api/resources/users/client/requests/UsersInviteRequest.d.ts +15 -0
- package/dist/esm/api/resources/users/client/requests/UsersInviteRequest.js +2 -0
- package/dist/esm/api/resources/users/client/requests/index.d.ts +1 -0
- package/dist/esm/api/types/ArticleVisibilityConfig.d.ts +5 -0
- package/dist/esm/api/types/CustomerPortalAccessSettings.d.ts +16 -0
- package/dist/esm/api/types/CustomerPortalAccessSettings.js +2 -0
- package/dist/esm/api/types/CustomerPortalBranding.d.ts +14 -0
- package/dist/esm/api/types/CustomerPortalBranding.js +2 -0
- package/dist/esm/api/types/CustomerPortalDisplaySettings.d.ts +8 -0
- package/dist/esm/api/types/CustomerPortalDisplaySettings.js +2 -0
- package/dist/esm/api/types/CustomerPortalFooterCategory.d.ts +7 -0
- package/dist/esm/api/types/CustomerPortalFooterCategory.js +2 -0
- package/dist/esm/api/types/CustomerPortalInvitationResult.d.ts +4 -0
- package/dist/esm/api/types/CustomerPortalInvitationResult.js +2 -0
- package/dist/esm/api/types/CustomerPortalLink.d.ts +6 -0
- package/dist/esm/api/types/CustomerPortalLink.js +2 -0
- package/dist/esm/api/types/CustomerPortalNavigation.d.ts +7 -0
- package/dist/esm/api/types/CustomerPortalNavigation.js +2 -0
- package/dist/esm/api/types/CustomerPortalSettings.d.ts +11 -0
- package/dist/esm/api/types/CustomerPortalSettings.js +2 -0
- package/dist/esm/api/types/CustomerPortalTabs.d.ts +8 -0
- package/dist/esm/api/types/CustomerPortalTabs.js +2 -0
- package/dist/esm/api/types/CustomerPortalUserPermissions.d.ts +8 -0
- package/dist/esm/api/types/CustomerPortalUserPermissions.js +2 -0
- package/dist/esm/api/types/DeleteTeamResponseBody.d.ts +4 -0
- package/dist/esm/api/types/DeleteTeamResponseBody.js +2 -0
- package/dist/esm/api/types/DestinationMetadata.d.ts +2 -0
- package/dist/esm/api/types/ErrorApiResponseBody.d.ts +7 -1
- package/dist/esm/api/types/ExternalIssue.d.ts +8 -0
- package/dist/esm/api/types/Filter.d.ts +17 -7
- package/dist/esm/api/types/Filter.js +6 -1
- package/dist/esm/api/types/FilterError.d.ts +26 -0
- package/dist/esm/api/types/FilterError.js +2 -0
- package/dist/esm/api/types/FilterRelatedObject.d.ts +14 -0
- package/dist/esm/api/types/FilterRelatedObject.js +2 -0
- package/dist/esm/api/types/GetCustomerPortalSettingsResponseBody.d.ts +6 -0
- package/dist/esm/api/types/GetCustomerPortalSettingsResponseBody.js +2 -0
- package/dist/esm/api/types/IssueThread.d.ts +6 -0
- package/dist/esm/api/types/SearchAccountsSort.d.ts +23 -0
- package/dist/esm/api/types/SearchAccountsSort.js +17 -0
- package/dist/esm/api/types/SearchIssuesSort.d.ts +23 -0
- package/dist/esm/api/types/SearchIssuesSort.js +17 -0
- package/dist/esm/api/types/SendCustomerPortalInvitationResponseBody.d.ts +6 -0
- package/dist/esm/api/types/SendCustomerPortalInvitationResponseBody.js +2 -0
- package/dist/esm/api/types/Task.d.ts +2 -0
- package/dist/esm/api/types/TicketFormLayoutField.d.ts +11 -1
- package/dist/esm/api/types/UpdateCustomerPortalAccessSettings.d.ts +16 -0
- package/dist/esm/api/types/UpdateCustomerPortalAccessSettings.js +2 -0
- package/dist/esm/api/types/UpdateCustomerPortalBranding.d.ts +14 -0
- package/dist/esm/api/types/UpdateCustomerPortalBranding.js +2 -0
- package/dist/esm/api/types/UpdateCustomerPortalDisplaySettings.d.ts +8 -0
- package/dist/esm/api/types/UpdateCustomerPortalDisplaySettings.js +2 -0
- package/dist/esm/api/types/UpdateCustomerPortalNavigation.d.ts +7 -0
- package/dist/esm/api/types/UpdateCustomerPortalNavigation.js +2 -0
- package/dist/esm/api/types/UpdateCustomerPortalTabs.d.ts +8 -0
- package/dist/esm/api/types/UpdateCustomerPortalTabs.js +2 -0
- package/dist/esm/api/types/UpdateCustomerPortalUserPermissions.d.ts +8 -0
- package/dist/esm/api/types/UpdateCustomerPortalUserPermissions.js +2 -0
- package/dist/esm/api/types/VoiceCall.d.ts +2 -0
- package/dist/esm/api/types/VoiceCallParticipant.d.ts +20 -0
- package/dist/esm/api/types/VoiceCallParticipant.js +2 -0
- package/dist/esm/api/types/index.d.ts +24 -0
- package/dist/esm/api/types/index.js +24 -0
- package/package.json +1 -1
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests/index.js"), exports);
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type * as Pylon from "../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {}
|
|
5
|
+
*/
|
|
6
|
+
export interface CustomerPortalUpdateSettingsRequest {
|
|
7
|
+
access?: Pylon.UpdateCustomerPortalAccessSettings;
|
|
8
|
+
branding?: Pylon.UpdateCustomerPortalBranding;
|
|
9
|
+
display?: Pylon.UpdateCustomerPortalDisplaySettings;
|
|
10
|
+
/** Whether the customer portal is enabled. Enabling it requires a plan that includes the customer portal. */
|
|
11
|
+
enabled?: boolean;
|
|
12
|
+
navigation?: Pylon.UpdateCustomerPortalNavigation;
|
|
13
|
+
portal_user_permissions?: Pylon.UpdateCustomerPortalUserPermissions;
|
|
14
|
+
tabs?: Pylon.UpdateCustomerPortalTabs;
|
|
15
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { CustomerPortalUpdateSettingsRequest } from "./CustomerPortalUpdateSettingsRequest.js";
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
+
};
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
exports.CustomerPortalClient = void 0;
|
|
19
|
+
var Client_js_1 = require("./client/Client.js");
|
|
20
|
+
Object.defineProperty(exports, "CustomerPortalClient", { enumerable: true, get: function () { return Client_js_1.CustomerPortalClient; } });
|
|
21
|
+
__exportStar(require("./client/index.js"), exports);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.js";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./client/index.js"), exports);
|
|
@@ -11,6 +11,8 @@ export * from "./callRecordings/client/requests/index.js";
|
|
|
11
11
|
export * as callRecordings from "./callRecordings/index.js";
|
|
12
12
|
export * from "./contacts/client/requests/index.js";
|
|
13
13
|
export * as contacts from "./contacts/index.js";
|
|
14
|
+
export * from "./customerPortal/client/requests/index.js";
|
|
15
|
+
export * as customerPortal from "./customerPortal/index.js";
|
|
14
16
|
export * from "./customFields/client/requests/index.js";
|
|
15
17
|
export * as customFields from "./customFields/index.js";
|
|
16
18
|
export * from "./customFields/types/index.js";
|
|
@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
};
|
|
37
37
|
})();
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.users = exports.userStatuses = exports.userRoles = exports.trainingData = exports.ticketForms = exports.teams = exports.tasks = exports.taskStatuses = exports.tags = exports.surveys = exports.projects = exports.milestones = exports.me = exports.macros = exports.macroGroups = exports.knowledgeBases = exports.issues = exports.issueStatuses = exports.issueGroups = exports.featureRequests = exports.emailSuppressions = exports.customObjects = exports.customFields = exports.contacts = exports.callRecordings = exports.auditLogs = exports.attachments = exports.articleFeedback = exports.activityTypes = exports.accounts = void 0;
|
|
39
|
+
exports.users = exports.userStatuses = exports.userRoles = exports.trainingData = exports.ticketForms = exports.teams = exports.tasks = exports.taskStatuses = exports.tags = exports.surveys = exports.projects = exports.milestones = exports.me = exports.macros = exports.macroGroups = exports.knowledgeBases = exports.issues = exports.issueStatuses = exports.issueGroups = exports.featureRequests = exports.emailSuppressions = exports.customObjects = exports.customFields = exports.customerPortal = exports.contacts = exports.callRecordings = exports.auditLogs = exports.attachments = exports.articleFeedback = exports.activityTypes = exports.accounts = void 0;
|
|
40
40
|
__exportStar(require("./accounts/client/requests/index.js"), exports);
|
|
41
41
|
exports.accounts = __importStar(require("./accounts/index.js"));
|
|
42
42
|
exports.activityTypes = __importStar(require("./activityTypes/index.js"));
|
|
@@ -50,6 +50,8 @@ __exportStar(require("./callRecordings/client/requests/index.js"), exports);
|
|
|
50
50
|
exports.callRecordings = __importStar(require("./callRecordings/index.js"));
|
|
51
51
|
__exportStar(require("./contacts/client/requests/index.js"), exports);
|
|
52
52
|
exports.contacts = __importStar(require("./contacts/index.js"));
|
|
53
|
+
__exportStar(require("./customerPortal/client/requests/index.js"), exports);
|
|
54
|
+
exports.customerPortal = __importStar(require("./customerPortal/index.js"));
|
|
53
55
|
__exportStar(require("./customFields/client/requests/index.js"), exports);
|
|
54
56
|
exports.customFields = __importStar(require("./customFields/index.js"));
|
|
55
57
|
__exportStar(require("./customFields/types/index.js"), exports);
|
|
@@ -99,6 +99,17 @@ export declare class IssuesClient {
|
|
|
99
99
|
*
|
|
100
100
|
* @example
|
|
101
101
|
* await client.issues.create({
|
|
102
|
+
* account_id: "acc_123",
|
|
103
|
+
* body_html: "<p>We are scheduling maintenance for this weekend.</p>",
|
|
104
|
+
* destination_metadata: {
|
|
105
|
+
* destination: "slack",
|
|
106
|
+
* slack_channel_id: "C0123456789"
|
|
107
|
+
* },
|
|
108
|
+
* title: "Maintenance window"
|
|
109
|
+
* })
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* await client.issues.create({
|
|
102
113
|
* body_html: "<p>Your order is ready.</p>",
|
|
103
114
|
* destination_metadata: {
|
|
104
115
|
* destination: "whatsapp",
|
|
@@ -237,6 +237,17 @@ class IssuesClient {
|
|
|
237
237
|
*
|
|
238
238
|
* @example
|
|
239
239
|
* await client.issues.create({
|
|
240
|
+
* account_id: "acc_123",
|
|
241
|
+
* body_html: "<p>We are scheduling maintenance for this weekend.</p>",
|
|
242
|
+
* destination_metadata: {
|
|
243
|
+
* destination: "slack",
|
|
244
|
+
* slack_channel_id: "C0123456789"
|
|
245
|
+
* },
|
|
246
|
+
* title: "Maintenance window"
|
|
247
|
+
* })
|
|
248
|
+
*
|
|
249
|
+
* @example
|
|
250
|
+
* await client.issues.create({
|
|
240
251
|
* body_html: "<p>Your order is ready.</p>",
|
|
241
252
|
* destination_metadata: {
|
|
242
253
|
* destination: "whatsapp",
|
|
@@ -31,6 +31,17 @@ import type * as Pylon from "../../../../index.js";
|
|
|
31
31
|
*
|
|
32
32
|
* @example
|
|
33
33
|
* {
|
|
34
|
+
* account_id: "acc_123",
|
|
35
|
+
* body_html: "<p>We are scheduling maintenance for this weekend.</p>",
|
|
36
|
+
* destination_metadata: {
|
|
37
|
+
* destination: "slack",
|
|
38
|
+
* slack_channel_id: "C0123456789"
|
|
39
|
+
* },
|
|
40
|
+
* title: "Maintenance window"
|
|
41
|
+
* }
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* {
|
|
34
45
|
* body_html: "<p>Your order is ready.</p>",
|
|
35
46
|
* destination_metadata: {
|
|
36
47
|
* destination: "whatsapp",
|
|
@@ -17,4 +17,6 @@ export interface IssuesSearchRequest {
|
|
|
17
17
|
limit?: number;
|
|
18
18
|
/** Fuzzy text search. Results are intersected with any provided filter. */
|
|
19
19
|
search_text?: string;
|
|
20
|
+
/** The order of results, as a list of sort keys. Only one sort key is supported right now. Omit for the default order. Send the same sort with every page of a cursor. */
|
|
21
|
+
sort?: Pylon.SearchIssuesSort[];
|
|
20
22
|
}
|
|
@@ -11,7 +11,7 @@ export declare class VoiceCallsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<VoiceCallsClient.Options>;
|
|
12
12
|
constructor(options: VoiceCallsClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Returns voice call records for the specified phone issue. Each call includes its recordings, with parsed transcript segments and a presigned download URL for the audio file. Recordings whose transcript has not yet completed are omitted; refetch later to see them.
|
|
14
|
+
* Returns voice call records for the specified phone issue. Each call includes its participants and its recordings, with parsed transcript segments and a presigned download URL for the audio file. Recordings whose transcript has not yet completed are omitted; refetch later to see them.
|
|
15
15
|
*
|
|
16
16
|
* **Rate limit:** 120 requests per minute
|
|
17
17
|
*
|
|
@@ -56,7 +56,7 @@ class VoiceCallsClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Returns voice call records for the specified phone issue. Each call includes its recordings, with parsed transcript segments and a presigned download URL for the audio file. Recordings whose transcript has not yet completed are omitted; refetch later to see them.
|
|
59
|
+
* Returns voice call records for the specified phone issue. Each call includes its participants and its recordings, with parsed transcript segments and a presigned download URL for the audio file. Recordings whose transcript has not yet completed are omitted; refetch later to see them.
|
|
60
60
|
*
|
|
61
61
|
* **Rate limit:** 120 requests per minute
|
|
62
62
|
*
|
|
@@ -82,6 +82,32 @@ export declare class TeamsClient {
|
|
|
82
82
|
*/
|
|
83
83
|
get(request: Pylon.TeamsGetRequest, requestOptions?: TeamsClient.RequestOptions): core.HttpResponsePromise<Pylon.GetTeamResponseBody>;
|
|
84
84
|
private __get;
|
|
85
|
+
/**
|
|
86
|
+
* Delete an existing team
|
|
87
|
+
* Deletes a team and its memberships and schedules. Subteams are detached and remain available.
|
|
88
|
+
* Teams referenced by other configuration or owning internal accounts cannot be deleted until those references are removed.
|
|
89
|
+
*
|
|
90
|
+
* **Rate limit:** 30 requests per minute
|
|
91
|
+
*
|
|
92
|
+
* @param {Pylon.TeamsDeleteRequest} request
|
|
93
|
+
* @param {TeamsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link Pylon.BadRequestError}
|
|
96
|
+
* @throws {@link Pylon.UnauthorizedError}
|
|
97
|
+
* @throws {@link Pylon.ForbiddenError}
|
|
98
|
+
* @throws {@link Pylon.NotFoundError}
|
|
99
|
+
* @throws {@link Pylon.TooManyRequestsError}
|
|
100
|
+
* @throws {@link Pylon.InternalServerError}
|
|
101
|
+
* @throws {@link errors.PylonError}
|
|
102
|
+
* @throws {@link errors.PylonTimeoutError}
|
|
103
|
+
*
|
|
104
|
+
* @example
|
|
105
|
+
* await client.teams.delete({
|
|
106
|
+
* id: "id"
|
|
107
|
+
* })
|
|
108
|
+
*/
|
|
109
|
+
delete(request: Pylon.TeamsDeleteRequest, requestOptions?: TeamsClient.RequestOptions): core.HttpResponsePromise<Pylon.DeleteTeamResponseBody>;
|
|
110
|
+
private __delete;
|
|
85
111
|
/**
|
|
86
112
|
* Updates an existing team, including how it assigns issues and its recurring assignment
|
|
87
113
|
* schedule. Only provided fields are modified; supplying schedule.blocks replaces the whole
|
|
@@ -278,6 +278,78 @@ class TeamsClient {
|
|
|
278
278
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/teams/{id}");
|
|
279
279
|
});
|
|
280
280
|
}
|
|
281
|
+
/**
|
|
282
|
+
* Delete an existing team
|
|
283
|
+
* Deletes a team and its memberships and schedules. Subteams are detached and remain available.
|
|
284
|
+
* Teams referenced by other configuration or owning internal accounts cannot be deleted until those references are removed.
|
|
285
|
+
*
|
|
286
|
+
* **Rate limit:** 30 requests per minute
|
|
287
|
+
*
|
|
288
|
+
* @param {Pylon.TeamsDeleteRequest} request
|
|
289
|
+
* @param {TeamsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
290
|
+
*
|
|
291
|
+
* @throws {@link Pylon.BadRequestError}
|
|
292
|
+
* @throws {@link Pylon.UnauthorizedError}
|
|
293
|
+
* @throws {@link Pylon.ForbiddenError}
|
|
294
|
+
* @throws {@link Pylon.NotFoundError}
|
|
295
|
+
* @throws {@link Pylon.TooManyRequestsError}
|
|
296
|
+
* @throws {@link Pylon.InternalServerError}
|
|
297
|
+
* @throws {@link errors.PylonError}
|
|
298
|
+
* @throws {@link errors.PylonTimeoutError}
|
|
299
|
+
*
|
|
300
|
+
* @example
|
|
301
|
+
* await client.teams.delete({
|
|
302
|
+
* id: "id"
|
|
303
|
+
* })
|
|
304
|
+
*/
|
|
305
|
+
delete(request, requestOptions) {
|
|
306
|
+
return core.HttpResponsePromise.fromPromise(this.__delete(request, requestOptions));
|
|
307
|
+
}
|
|
308
|
+
__delete(request, requestOptions) {
|
|
309
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
310
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
311
|
+
const { id } = request;
|
|
312
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
313
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
314
|
+
const _response = yield core.fetcher({
|
|
315
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PylonEnvironment.Us, `teams/${core.url.encodePathParam(id)}`),
|
|
316
|
+
method: "DELETE",
|
|
317
|
+
headers: _headers,
|
|
318
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
319
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
320
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
321
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
322
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
323
|
+
logging: this._options.logging,
|
|
324
|
+
});
|
|
325
|
+
if (_response.ok) {
|
|
326
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
327
|
+
}
|
|
328
|
+
if (_response.error.reason === "status-code") {
|
|
329
|
+
switch (_response.error.statusCode) {
|
|
330
|
+
case 400:
|
|
331
|
+
throw new Pylon.BadRequestError(_response.error.body, _response.rawResponse);
|
|
332
|
+
case 401:
|
|
333
|
+
throw new Pylon.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
334
|
+
case 403:
|
|
335
|
+
throw new Pylon.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
336
|
+
case 404:
|
|
337
|
+
throw new Pylon.NotFoundError(_response.error.body, _response.rawResponse);
|
|
338
|
+
case 429:
|
|
339
|
+
throw new Pylon.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
340
|
+
case 500:
|
|
341
|
+
throw new Pylon.InternalServerError(_response.error.body, _response.rawResponse);
|
|
342
|
+
default:
|
|
343
|
+
throw new errors.PylonError({
|
|
344
|
+
statusCode: _response.error.statusCode,
|
|
345
|
+
body: _response.error.body,
|
|
346
|
+
rawResponse: _response.rawResponse,
|
|
347
|
+
});
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/teams/{id}");
|
|
351
|
+
});
|
|
352
|
+
}
|
|
281
353
|
/**
|
|
282
354
|
* Updates an existing team, including how it assigns issues and its recurring assignment
|
|
283
355
|
* schedule. Only provided fields are modified; supplying schedule.blocks replaces the whole
|
|
@@ -32,6 +32,31 @@ export declare class UsersClient {
|
|
|
32
32
|
*/
|
|
33
33
|
list(request?: Pylon.UsersListRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Pylon.GetUsersResponseBody>;
|
|
34
34
|
private __list;
|
|
35
|
+
/**
|
|
36
|
+
* Creates a user and emails them an invitation to join the organization. If a user with this email already exists,
|
|
37
|
+
* they are reactivated if needed and sent a new invitation, and any pending invitation is canceled. Requires admin permissions.
|
|
38
|
+
*
|
|
39
|
+
* **Rate limit:** 30 requests per minute
|
|
40
|
+
*
|
|
41
|
+
* @param {Pylon.UsersInviteRequest} request
|
|
42
|
+
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link Pylon.BadRequestError}
|
|
45
|
+
* @throws {@link Pylon.UnauthorizedError}
|
|
46
|
+
* @throws {@link Pylon.ForbiddenError}
|
|
47
|
+
* @throws {@link Pylon.TooManyRequestsError}
|
|
48
|
+
* @throws {@link Pylon.InternalServerError}
|
|
49
|
+
* @throws {@link errors.PylonError}
|
|
50
|
+
* @throws {@link errors.PylonTimeoutError}
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* await client.users.invite({
|
|
54
|
+
* email: "jane@example.com",
|
|
55
|
+
* name: "name"
|
|
56
|
+
* })
|
|
57
|
+
*/
|
|
58
|
+
invite(request: Pylon.UsersInviteRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Pylon.GetUserResponseBody>;
|
|
59
|
+
private __invite;
|
|
35
60
|
/**
|
|
36
61
|
* Filterable fields and their allowed operators:
|
|
37
62
|
*
|
|
@@ -142,6 +142,77 @@ class UsersClient {
|
|
|
142
142
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/users");
|
|
143
143
|
});
|
|
144
144
|
}
|
|
145
|
+
/**
|
|
146
|
+
* Creates a user and emails them an invitation to join the organization. If a user with this email already exists,
|
|
147
|
+
* they are reactivated if needed and sent a new invitation, and any pending invitation is canceled. Requires admin permissions.
|
|
148
|
+
*
|
|
149
|
+
* **Rate limit:** 30 requests per minute
|
|
150
|
+
*
|
|
151
|
+
* @param {Pylon.UsersInviteRequest} request
|
|
152
|
+
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
153
|
+
*
|
|
154
|
+
* @throws {@link Pylon.BadRequestError}
|
|
155
|
+
* @throws {@link Pylon.UnauthorizedError}
|
|
156
|
+
* @throws {@link Pylon.ForbiddenError}
|
|
157
|
+
* @throws {@link Pylon.TooManyRequestsError}
|
|
158
|
+
* @throws {@link Pylon.InternalServerError}
|
|
159
|
+
* @throws {@link errors.PylonError}
|
|
160
|
+
* @throws {@link errors.PylonTimeoutError}
|
|
161
|
+
*
|
|
162
|
+
* @example
|
|
163
|
+
* await client.users.invite({
|
|
164
|
+
* email: "jane@example.com",
|
|
165
|
+
* name: "name"
|
|
166
|
+
* })
|
|
167
|
+
*/
|
|
168
|
+
invite(request, requestOptions) {
|
|
169
|
+
return core.HttpResponsePromise.fromPromise(this.__invite(request, requestOptions));
|
|
170
|
+
}
|
|
171
|
+
__invite(request, requestOptions) {
|
|
172
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
173
|
+
var _a, _b, _c, _d, _e, _f, _g;
|
|
174
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
175
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
176
|
+
const _response = yield core.fetcher({
|
|
177
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PylonEnvironment.Us, "users/invite"),
|
|
178
|
+
method: "POST",
|
|
179
|
+
headers: _headers,
|
|
180
|
+
contentType: "application/json",
|
|
181
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
182
|
+
requestType: "json",
|
|
183
|
+
body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
|
|
184
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
185
|
+
maxRetries: 0,
|
|
186
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
187
|
+
fetchFn: (_g = this._options) === null || _g === void 0 ? void 0 : _g.fetch,
|
|
188
|
+
logging: this._options.logging,
|
|
189
|
+
});
|
|
190
|
+
if (_response.ok) {
|
|
191
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
192
|
+
}
|
|
193
|
+
if (_response.error.reason === "status-code") {
|
|
194
|
+
switch (_response.error.statusCode) {
|
|
195
|
+
case 400:
|
|
196
|
+
throw new Pylon.BadRequestError(_response.error.body, _response.rawResponse);
|
|
197
|
+
case 401:
|
|
198
|
+
throw new Pylon.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
199
|
+
case 403:
|
|
200
|
+
throw new Pylon.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
201
|
+
case 429:
|
|
202
|
+
throw new Pylon.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
203
|
+
case 500:
|
|
204
|
+
throw new Pylon.InternalServerError(_response.error.body, _response.rawResponse);
|
|
205
|
+
default:
|
|
206
|
+
throw new errors.PylonError({
|
|
207
|
+
statusCode: _response.error.statusCode,
|
|
208
|
+
body: _response.error.body,
|
|
209
|
+
rawResponse: _response.rawResponse,
|
|
210
|
+
});
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/users/invite");
|
|
214
|
+
});
|
|
215
|
+
}
|
|
145
216
|
/**
|
|
146
217
|
* Filterable fields and their allowed operators:
|
|
147
218
|
*
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* email: "jane@example.com",
|
|
5
|
+
* name: "name"
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface UsersInviteRequest {
|
|
9
|
+
/** The email address to send the invitation to. */
|
|
10
|
+
email: string;
|
|
11
|
+
/** The name of the user to invite. */
|
|
12
|
+
name: string;
|
|
13
|
+
/** The ID of the role to give the user. See GET /user-roles. Defaults to the organization's default role. */
|
|
14
|
+
role_id?: string;
|
|
15
|
+
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { UsersGetRequest } from "./UsersGetRequest.js";
|
|
2
|
+
export type { UsersInviteRequest } from "./UsersInviteRequest.js";
|
|
2
3
|
export type { UsersListRequest } from "./UsersListRequest.js";
|
|
3
4
|
export type { UsersSearchRequest } from "./UsersSearchRequest.js";
|
|
4
5
|
export type { UsersUpdateRequest } from "./UsersUpdateRequest.js";
|
|
@@ -5,6 +5,11 @@ export interface ArticleVisibilityConfig {
|
|
|
5
5
|
/** List of AI agent IDs that may access this resource when ai_agent_access is set to "specific_agents". */
|
|
6
6
|
allowed_agent_ids?: string[] | undefined;
|
|
7
7
|
customer_visibility_condition?: Pylon.Filter | undefined;
|
|
8
|
+
/**
|
|
9
|
+
* Read-only. True when the article's customer visibility condition cannot be expressed in the
|
|
10
|
+
* API filter format. The condition still applies, but customer_visibility_condition is omitted.
|
|
11
|
+
*/
|
|
12
|
+
customer_visibility_condition_unsupported?: boolean | undefined;
|
|
8
13
|
/** The visibility setting. */
|
|
9
14
|
visibility?: ArticleVisibilityConfig.Visibility | undefined;
|
|
10
15
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export interface CustomerPortalAccessSettings {
|
|
2
|
+
/**
|
|
3
|
+
* Whether new contacts get portal access with the default role when they are created. Applies only to contacts whose email
|
|
4
|
+
* domain matches their account; other new contacts get no access unless invited.
|
|
5
|
+
*/
|
|
6
|
+
auto_grant_new_contacts: boolean;
|
|
7
|
+
/** Whether someone without a contact who logs in to the portal gets one created, if their email domain matches an existing account. */
|
|
8
|
+
create_contacts_on_login: boolean;
|
|
9
|
+
/**
|
|
10
|
+
* The portal role contacts get when they are granted access without an explicit role: `no_access`, `member`, `admin`, a custom
|
|
11
|
+
* role's slug, or a custom role's ID if it has no slug.
|
|
12
|
+
*/
|
|
13
|
+
default_role: string;
|
|
14
|
+
/** Whether contacts granted access automatically are emailed a portal invitation. */
|
|
15
|
+
invite_auto_granted_contacts: boolean;
|
|
16
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export interface CustomerPortalBranding {
|
|
2
|
+
/** The brand color as a 6-digit hex code, such as `#1A2B3C`. Empty when unset. */
|
|
3
|
+
brand_color: string;
|
|
4
|
+
/** The footer logo URL used in dark mode. Empty when unset. */
|
|
5
|
+
dark_mode_footer_logo_url: string;
|
|
6
|
+
/** The header logo URL used in dark mode. Empty when unset. */
|
|
7
|
+
dark_mode_logo_url: string;
|
|
8
|
+
/** The footer logo URL. Empty when unset. */
|
|
9
|
+
footer_logo_url: string;
|
|
10
|
+
/** Where the header logo links to. Empty when the logo is not a link. */
|
|
11
|
+
logo_link_url: string;
|
|
12
|
+
/** The header logo URL. Empty when unset. */
|
|
13
|
+
logo_url: string;
|
|
14
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export interface CustomerPortalDisplaySettings {
|
|
2
|
+
/** Whether the portal shows feature request descriptions. */
|
|
3
|
+
feature_request_descriptions: boolean;
|
|
4
|
+
/** Whether portal tasks show their linked issues. */
|
|
5
|
+
task_linked_issues: boolean;
|
|
6
|
+
/** Whether portal tasks show their linked tasks. */
|
|
7
|
+
task_linked_tasks: boolean;
|
|
8
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as Pylon from "../index.js";
|
|
2
|
+
export interface CustomerPortalNavigation {
|
|
3
|
+
/** The link groups in the portal footer, in order. */
|
|
4
|
+
footer_categories: Pylon.CustomerPortalFooterCategory[];
|
|
5
|
+
/** The links in the portal header, in order. */
|
|
6
|
+
header_links: Pylon.CustomerPortalLink[];
|
|
7
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Pylon from "../index.js";
|
|
2
|
+
export interface CustomerPortalSettings {
|
|
3
|
+
access: Pylon.CustomerPortalAccessSettings;
|
|
4
|
+
branding: Pylon.CustomerPortalBranding;
|
|
5
|
+
display: Pylon.CustomerPortalDisplaySettings;
|
|
6
|
+
/** Whether the customer portal is enabled. */
|
|
7
|
+
enabled: boolean;
|
|
8
|
+
navigation: Pylon.CustomerPortalNavigation;
|
|
9
|
+
portal_user_permissions: Pylon.CustomerPortalUserPermissions;
|
|
10
|
+
tabs: Pylon.CustomerPortalTabs;
|
|
11
|
+
}
|