@usepylon/sdk 0.1.0-beta.1 → 0.1.0-beta.2

package/dist/esm/BaseClient.js

@@ -5,7 +5,7 @@ import * as core from "./core/index.js";
 export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
-        "User-Agent": "@usepylon/sdk/0.1.0-beta.1",
+        "User-Agent": "@usepylon/sdk/0.1.0-beta.2",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/Client.d.ts

@@ -5,6 +5,7 @@ import { AttachmentsClient } from "./api/resources/attachments/client/Client.js"
 import { AuditLogsClient } from "./api/resources/auditLogs/client/Client.js";
 import { CallRecordingsClient } from "./api/resources/callRecordings/client/Client.js";
 import { ContactsClient } from "./api/resources/contacts/client/Client.js";
+import { CustomerPortalClient } from "./api/resources/customerPortal/client/Client.js";
 import { CustomFieldsClient } from "./api/resources/customFields/client/Client.js";
 import { CustomObjectsClient } from "./api/resources/customObjects/client/Client.js";
 import { EmailSuppressionsClient } from "./api/resources/emailSuppressions/client/Client.js";
@@ -47,6 +48,7 @@ export declare class PylonClient {
     protected _contacts: ContactsClient | undefined;
     protected _customFields: CustomFieldsClient | undefined;
     protected _customObjects: CustomObjectsClient | undefined;
+    protected _customerPortal: CustomerPortalClient | undefined;
     protected _emailSuppressions: EmailSuppressionsClient | undefined;
     protected _featureRequests: FeatureRequestsClient | undefined;
     protected _issueGroups: IssueGroupsClient | undefined;
@@ -78,6 +80,7 @@ export declare class PylonClient {
     get contacts(): ContactsClient;
     get customFields(): CustomFieldsClient;
     get customObjects(): CustomObjectsClient;
+    get customerPortal(): CustomerPortalClient;
     get emailSuppressions(): EmailSuppressionsClient;
     get featureRequests(): FeatureRequestsClient;
     get issueGroups(): IssueGroupsClient;

package/dist/esm/Client.js

@@ -15,6 +15,7 @@ import { AttachmentsClient } from "./api/resources/attachments/client/Client.js"
 import { AuditLogsClient } from "./api/resources/auditLogs/client/Client.js";
 import { CallRecordingsClient } from "./api/resources/callRecordings/client/Client.js";
 import { ContactsClient } from "./api/resources/contacts/client/Client.js";
+import { CustomerPortalClient } from "./api/resources/customerPortal/client/Client.js";
 import { CustomFieldsClient } from "./api/resources/customFields/client/Client.js";
 import { CustomObjectsClient } from "./api/resources/customObjects/client/Client.js";
 import { EmailSuppressionsClient } from "./api/resources/emailSuppressions/client/Client.js";
@@ -80,6 +81,10 @@ export class PylonClient {
         var _a;
         return ((_a = this._customObjects) !== null && _a !== void 0 ? _a : (this._customObjects = new CustomObjectsClient(this._options)));
     }
+    get customerPortal() {
+        var _a;
+        return ((_a = this._customerPortal) !== null && _a !== void 0 ? _a : (this._customerPortal = new CustomerPortalClient(this._options)));
+    }
     get emailSuppressions() {
         var _a;
         return ((_a = this._emailSuppressions) !== null && _a !== void 0 ? _a : (this._emailSuppressions = new EmailSuppressionsClient(this._options)));

package/dist/esm/api/resources/customerPortal/client/Client.d.ts

@@ -0,0 +1,53 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pylon from "../../../index.js";
+export declare namespace CustomerPortalClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class CustomerPortalClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<CustomerPortalClient.Options>;
+    constructor(options: CustomerPortalClient.Options);
+    /**
+     * Returns the organization's customer portal settings.
+     *
+     * **Rate limit:** 120 requests per minute
+     *
+     * @param {CustomerPortalClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customerPortal.getSettings()
+     */
+    getSettings(requestOptions?: CustomerPortalClient.RequestOptions): core.HttpResponsePromise<Pylon.GetCustomerPortalSettingsResponseBody>;
+    private __getSettings;
+    /**
+     * Updates the organization's customer portal settings. Only provided fields are modified.
+     *
+     * **Rate limit:** 30 requests per minute
+     *
+     * @param {Pylon.CustomerPortalUpdateSettingsRequest} request
+     * @param {CustomerPortalClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customerPortal.updateSettings()
+     */
+    updateSettings(request?: Pylon.CustomerPortalUpdateSettingsRequest, requestOptions?: CustomerPortalClient.RequestOptions): core.HttpResponsePromise<Pylon.GetCustomerPortalSettingsResponseBody>;
+    private __updateSettings;
+}

package/dist/esm/api/resources/customerPortal/client/Client.js

@@ -0,0 +1,156 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders } from "../../../../core/headers.js";
+import * as core from "../../../../core/index.js";
+import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.js";
+import * as environments from "../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../errors/index.js";
+import * as Pylon from "../../../index.js";
+export class CustomerPortalClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Returns the organization's customer portal settings.
+     *
+     * **Rate limit:** 120 requests per minute
+     *
+     * @param {CustomerPortalClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customerPortal.getSettings()
+     */
+    getSettings(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getSettings(requestOptions));
+    }
+    __getSettings(requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                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, "customer-portal/settings"),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 401:
+                        throw new Pylon.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pylon.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Pylon.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pylon.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PylonError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/customer-portal/settings");
+        });
+    }
+    /**
+     * Updates the organization's customer portal settings. Only provided fields are modified.
+     *
+     * **Rate limit:** 30 requests per minute
+     *
+     * @param {Pylon.CustomerPortalUpdateSettingsRequest} request
+     * @param {CustomerPortalClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customerPortal.updateSettings()
+     */
+    updateSettings(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateSettings(request, requestOptions));
+    }
+    __updateSettings() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                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, "customer-portal/settings"),
+                method: "PATCH",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: mergeAdditionalBodyParameters(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pylon.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pylon.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pylon.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Pylon.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pylon.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PylonError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/customer-portal/settings");
+        });
+    }
+}

package/dist/esm/api/resources/customerPortal/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/dist/esm/api/resources/customerPortal/client/index.js

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/dist/esm/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.d.ts

@@ -0,0 +1,15 @@
+import type * as Pylon from "../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface CustomerPortalUpdateSettingsRequest {
+    access?: Pylon.UpdateCustomerPortalAccessSettings;
+    branding?: Pylon.UpdateCustomerPortalBranding;
+    display?: Pylon.UpdateCustomerPortalDisplaySettings;
+    /** Whether the customer portal is enabled. Enabling it requires a plan that includes the customer portal. */
+    enabled?: boolean;
+    navigation?: Pylon.UpdateCustomerPortalNavigation;
+    portal_user_permissions?: Pylon.UpdateCustomerPortalUserPermissions;
+    tabs?: Pylon.UpdateCustomerPortalTabs;
+}

package/dist/esm/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/customerPortal/client/requests/index.d.ts

@@ -0,0 +1 @@
+export type { CustomerPortalUpdateSettingsRequest } from "./CustomerPortalUpdateSettingsRequest.js";

package/dist/esm/api/resources/customerPortal/client/requests/index.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/customerPortal/exports.d.ts

@@ -0,0 +1,2 @@
+export { CustomerPortalClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/esm/api/resources/customerPortal/exports.js

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { CustomerPortalClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/esm/api/resources/customerPortal/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/esm/api/resources/customerPortal/index.js

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/esm/api/resources/index.d.ts

@@ -11,6 +11,8 @@ export * from "./callRecordings/client/requests/index.js";
 export * as callRecordings from "./callRecordings/index.js";
 export * from "./contacts/client/requests/index.js";
 export * as contacts from "./contacts/index.js";
+export * from "./customerPortal/client/requests/index.js";
+export * as customerPortal from "./customerPortal/index.js";
 export * from "./customFields/client/requests/index.js";
 export * as customFields from "./customFields/index.js";
 export * from "./customFields/types/index.js";

package/dist/esm/api/resources/index.js

@@ -11,6 +11,8 @@ export * from "./callRecordings/client/requests/index.js";
 export * as callRecordings from "./callRecordings/index.js";
 export * from "./contacts/client/requests/index.js";
 export * as contacts from "./contacts/index.js";
+export * from "./customerPortal/client/requests/index.js";
+export * as customerPortal from "./customerPortal/index.js";
 export * from "./customFields/client/requests/index.js";
 export * as customFields from "./customFields/index.js";
 export * from "./customFields/types/index.js";

package/dist/esm/api/resources/users/client/Client.d.ts

@@ -32,6 +32,31 @@ export declare class UsersClient {
      */
     list(request?: Pylon.UsersListRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Pylon.GetUsersResponseBody>;
     private __list;
+    /**
+     * Creates a user and emails them an invitation to join the organization. If a user with this email already exists,
+     * they are reactivated if needed and sent a new invitation, and any pending invitation is canceled. Requires admin permissions.
+     *
+     * **Rate limit:** 30 requests per minute
+     *
+     * @param {Pylon.UsersInviteRequest} request
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.users.invite({
+     *         email: "jane@example.com",
+     *         name: "name"
+     *     })
+     */
+    invite(request: Pylon.UsersInviteRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Pylon.GetUserResponseBody>;
+    private __invite;
     /**
      * Filterable fields and their allowed operators:
      *

package/dist/esm/api/resources/users/client/Client.js

@@ -106,6 +106,77 @@ export class UsersClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/users");
         });
     }
+    /**
+     * Creates a user and emails them an invitation to join the organization. If a user with this email already exists,
+     * they are reactivated if needed and sent a new invitation, and any pending invitation is canceled. Requires admin permissions.
+     *
+     * **Rate limit:** 30 requests per minute
+     *
+     * @param {Pylon.UsersInviteRequest} request
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.users.invite({
+     *         email: "jane@example.com",
+     *         name: "name"
+     *     })
+     */
+    invite(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__invite(request, requestOptions));
+    }
+    __invite(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                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"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: mergeAdditionalBodyParameters(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                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,
+                maxRetries: 0,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_g = this._options) === null || _g === void 0 ? void 0 : _g.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pylon.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pylon.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pylon.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Pylon.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pylon.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PylonError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/users/invite");
+        });
+    }
     /**
      * Filterable fields and their allowed operators:
      *

package/dist/esm/api/resources/users/client/requests/UsersInviteRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         email: "jane@example.com",
+ *         name: "name"
+ *     }
+ */
+export interface UsersInviteRequest {
+    /** The email address to send the invitation to. */
+    email: string;
+    /** The name of the user to invite. */
+    name: string;
+    /** The ID of the role to give the user. See GET /user-roles. Defaults to the organization's default role. */
+    role_id?: string;
+}

package/dist/esm/api/resources/users/client/requests/UsersInviteRequest.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/users/client/requests/index.d.ts

@@ -1,4 +1,5 @@
 export type { UsersGetRequest } from "./UsersGetRequest.js";
+export type { UsersInviteRequest } from "./UsersInviteRequest.js";
 export type { UsersListRequest } from "./UsersListRequest.js";
 export type { UsersSearchRequest } from "./UsersSearchRequest.js";
 export type { UsersUpdateRequest } from "./UsersUpdateRequest.js";

package/dist/esm/api/types/CustomerPortalAccessSettings.d.ts

@@ -0,0 +1,16 @@
+export interface CustomerPortalAccessSettings {
+    /**
+     * Whether new contacts get portal access with the default role when they are created. Applies only to contacts whose email
+     * domain matches their account; other new contacts get no access unless invited.
+     */
+    auto_grant_new_contacts: boolean;
+    /** Whether someone without a contact who logs in to the portal gets one created, if their email domain matches an existing account. */
+    create_contacts_on_login: boolean;
+    /**
+     * The portal role contacts get when they are granted access without an explicit role: `no_access`, `member`, `admin`, a custom
+     * role's slug, or a custom role's ID if it has no slug.
+     */
+    default_role: string;
+    /** Whether contacts granted access automatically are emailed a portal invitation. */
+    invite_auto_granted_contacts: boolean;
+}

package/dist/esm/api/types/CustomerPortalAccessSettings.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerPortalBranding.d.ts

@@ -0,0 +1,14 @@
+export interface CustomerPortalBranding {
+    /** The brand color as a 6-digit hex code, such as `#1A2B3C`. Empty when unset. */
+    brand_color: string;
+    /** The footer logo URL used in dark mode. Empty when unset. */
+    dark_mode_footer_logo_url: string;
+    /** The header logo URL used in dark mode. Empty when unset. */
+    dark_mode_logo_url: string;
+    /** The footer logo URL. Empty when unset. */
+    footer_logo_url: string;
+    /** Where the header logo links to. Empty when the logo is not a link. */
+    logo_link_url: string;
+    /** The header logo URL. Empty when unset. */
+    logo_url: string;
+}

package/dist/esm/api/types/CustomerPortalBranding.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerPortalDisplaySettings.d.ts

@@ -0,0 +1,8 @@
+export interface CustomerPortalDisplaySettings {
+    /** Whether the portal shows feature request descriptions. */
+    feature_request_descriptions: boolean;
+    /** Whether portal tasks show their linked issues. */
+    task_linked_issues: boolean;
+    /** Whether portal tasks show their linked tasks. */
+    task_linked_tasks: boolean;
+}

package/dist/esm/api/types/CustomerPortalDisplaySettings.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerPortalFooterCategory.d.ts

@@ -0,0 +1,7 @@
+import type * as Pylon from "../index.js";
+export interface CustomerPortalFooterCategory {
+    /** The links in the group, in order. */
+    links: Pylon.CustomerPortalLink[];
+    /** The heading of the link group. */
+    title: string;
+}

package/dist/esm/api/types/CustomerPortalFooterCategory.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerPortalLink.d.ts

@@ -0,0 +1,6 @@
+export interface CustomerPortalLink {
+    /** The link text. */
+    text: string;
+    /** The link URL. Must be an http or https URL. */
+    url: string;
+}

package/dist/esm/api/types/CustomerPortalLink.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerPortalNavigation.d.ts

@@ -0,0 +1,7 @@
+import type * as Pylon from "../index.js";
+export interface CustomerPortalNavigation {
+    /** The link groups in the portal footer, in order. */
+    footer_categories: Pylon.CustomerPortalFooterCategory[];
+    /** The links in the portal header, in order. */
+    header_links: Pylon.CustomerPortalLink[];
+}

package/dist/esm/api/types/CustomerPortalNavigation.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerPortalSettings.d.ts

@@ -0,0 +1,11 @@
+import type * as Pylon from "../index.js";
+export interface CustomerPortalSettings {
+    access: Pylon.CustomerPortalAccessSettings;
+    branding: Pylon.CustomerPortalBranding;
+    display: Pylon.CustomerPortalDisplaySettings;
+    /** Whether the customer portal is enabled. */
+    enabled: boolean;
+    navigation: Pylon.CustomerPortalNavigation;
+    portal_user_permissions: Pylon.CustomerPortalUserPermissions;
+    tabs: Pylon.CustomerPortalTabs;
+}

package/dist/esm/api/types/CustomerPortalSettings.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerPortalTabs.d.ts

@@ -0,0 +1,8 @@
+export interface CustomerPortalTabs {
+    /** Whether the portal shows the feature requests tab. */
+    feature_requests: boolean;
+    /** Whether the portal shows the issues tab. */
+    issues: boolean;
+    /** Whether the portal shows the projects and tasks tab. */
+    projects_and_tasks: boolean;
+}

package/dist/esm/api/types/CustomerPortalTabs.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerPortalUserPermissions.d.ts

@@ -0,0 +1,8 @@
+export interface CustomerPortalUserPermissions {
+    /** Whether portal users can edit their own profile. */
+    edit_profile: boolean;
+    /** Whether portal users can edit the CC list on their replies. */
+    edit_reply_ccs: boolean;
+    /** Whether portal users can export their issues as CSV. */
+    export_issues_csv: boolean;
+}

package/dist/esm/api/types/CustomerPortalUserPermissions.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};