@vitable-inc/vitable-connect 0.2.1 → 1.0.0

package/dist/esm/api/resources/plans/client/requests/ListPlansRequest.d.mts

@@ -0,0 +1,14 @@
+import type * as VitableConnect from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         limit: 20,
+ *         page: 1
+ *     }
+ */
+export interface ListPlansRequest {
+    /** Items per page (default: 20, max: 100) */
+    limit?: VitableConnect.Limit;
+    /** Page number (default: 1) */
+    page?: VitableConnect.Page;
+}

package/dist/esm/api/resources/plans/client/requests/ListPlansRequest.mjs

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

package/dist/esm/api/resources/plans/client/requests/index.d.mts

@@ -0,0 +1 @@
+export type { ListPlansRequest } from "./ListPlansRequest.mjs";

package/dist/esm/api/resources/plans/client/requests/index.mjs

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

package/dist/esm/api/resources/plans/exports.d.mts

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

package/dist/esm/api/resources/plans/exports.mjs

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

package/dist/esm/api/resources/plans/index.d.mts

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

package/dist/esm/api/resources/plans/index.mjs

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

package/dist/esm/api/resources/webhookEvents/client/Client.d.mts

@@ -0,0 +1,88 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as VitableConnect from "../../../index.mjs";
+export declare namespace WebhookEventsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Inspect the events Vitable emits for your organization and the delivery attempts for each one. Rather than polling the API for changes, register a webhook endpoint and Vitable will `POST` event data to your URL as things happen.
+ */
+export declare class WebhookEventsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<WebhookEventsClient.Options>;
+    constructor(options?: WebhookEventsClient.Options);
+    /**
+     * Retrieves a paginated list of webhook events for the authenticated organization. Supports filtering by event name, resource type, resource ID, and date range.
+     *
+     * @param {VitableConnect.ListWebhookEventsRequest} request
+     * @param {WebhookEventsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link VitableConnect.BadRequestError}
+     * @throws {@link VitableConnect.UnauthorizedError}
+     * @throws {@link VitableConnect.ForbiddenError}
+     * @throws {@link VitableConnect.NotFoundError}
+     * @throws {@link VitableConnect.ConflictError}
+     * @throws {@link VitableConnect.TooManyRequestsError}
+     * @throws {@link VitableConnect.InternalServerError}
+     * @throws {@link VitableConnect.BadGatewayError}
+     * @throws {@link errors.VitableConnectError}
+     * @throws {@link errors.VitableConnectTimeoutError}
+     *
+     * @example
+     *     await client.webhookEvents.list({
+     *         limit: 20,
+     *         page: 1
+     *     })
+     */
+    list(request?: VitableConnect.ListWebhookEventsRequest, requestOptions?: WebhookEventsClient.RequestOptions): Promise<core.Page<VitableConnect.WebhookEvent, VitableConnect.WebhookEventListResponse>>;
+    /**
+     * Retrieves a single webhook event by its prefixed ID. Returns 404 if the event does not exist or belongs to a different organization.
+     *
+     * @param {VitableConnect.GetWebhookEventsRequest} request
+     * @param {WebhookEventsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link VitableConnect.BadRequestError}
+     * @throws {@link VitableConnect.UnauthorizedError}
+     * @throws {@link VitableConnect.ForbiddenError}
+     * @throws {@link VitableConnect.NotFoundError}
+     * @throws {@link VitableConnect.ConflictError}
+     * @throws {@link VitableConnect.TooManyRequestsError}
+     * @throws {@link VitableConnect.InternalServerError}
+     * @throws {@link VitableConnect.BadGatewayError}
+     * @throws {@link errors.VitableConnectError}
+     * @throws {@link errors.VitableConnectTimeoutError}
+     *
+     * @example
+     *     await client.webhookEvents.get({
+     *         event_id: "event_id"
+     *     })
+     */
+    get(request: VitableConnect.GetWebhookEventsRequest, requestOptions?: WebhookEventsClient.RequestOptions): core.HttpResponsePromise<VitableConnect.WebhookEventResponse>;
+    private __get;
+    /**
+     * Retrieves all delivery attempts for a webhook event. Returns up to 100 deliveries. Each delivery includes a computed status field (Pending, In Progress, Delivered, or Failed).
+     *
+     * @param {VitableConnect.ListDeliveriesWebhookEventsRequest} request
+     * @param {WebhookEventsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link VitableConnect.BadRequestError}
+     * @throws {@link VitableConnect.UnauthorizedError}
+     * @throws {@link VitableConnect.ForbiddenError}
+     * @throws {@link VitableConnect.NotFoundError}
+     * @throws {@link VitableConnect.ConflictError}
+     * @throws {@link VitableConnect.TooManyRequestsError}
+     * @throws {@link VitableConnect.InternalServerError}
+     * @throws {@link VitableConnect.BadGatewayError}
+     * @throws {@link errors.VitableConnectError}
+     * @throws {@link errors.VitableConnectTimeoutError}
+     *
+     * @example
+     *     await client.webhookEvents.listDeliveries({
+     *         event_id: "event_id"
+     *     })
+     */
+    listDeliveries(request: VitableConnect.ListDeliveriesWebhookEventsRequest, requestOptions?: WebhookEventsClient.RequestOptions): core.HttpResponsePromise<VitableConnect.ListWebhookEventDeliveriesResponse>;
+    private __listDeliveries;
+}

package/dist/esm/api/resources/webhookEvents/client/Client.mjs

@@ -0,0 +1,278 @@
+// 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.mjs";
+import { mergeHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as VitableConnect from "../../../index.mjs";
+/**
+ * Inspect the events Vitable emits for your organization and the delivery attempts for each one. Rather than polling the API for changes, register a webhook endpoint and Vitable will `POST` event data to your URL as things happen.
+ */
+export class WebhookEventsClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Retrieves a paginated list of webhook events for the authenticated organization. Supports filtering by event name, resource type, resource ID, and date range.
+     *
+     * @param {VitableConnect.ListWebhookEventsRequest} request
+     * @param {WebhookEventsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link VitableConnect.BadRequestError}
+     * @throws {@link VitableConnect.UnauthorizedError}
+     * @throws {@link VitableConnect.ForbiddenError}
+     * @throws {@link VitableConnect.NotFoundError}
+     * @throws {@link VitableConnect.ConflictError}
+     * @throws {@link VitableConnect.TooManyRequestsError}
+     * @throws {@link VitableConnect.InternalServerError}
+     * @throws {@link VitableConnect.BadGatewayError}
+     * @throws {@link errors.VitableConnectError}
+     * @throws {@link errors.VitableConnectTimeoutError}
+     *
+     * @example
+     *     await client.webhookEvents.list({
+     *         limit: 20,
+     *         page: 1
+     *     })
+     */
+    list() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+                const { created_after: createdAfter, created_before: createdBefore, event_name: eventName, limit, page, resource_id: resourceId, resource_type: resourceType, } = request;
+                const _queryParams = {
+                    created_after: createdAfter != null ? createdAfter : undefined,
+                    created_before: createdBefore != null ? createdBefore : undefined,
+                    event_name: eventName != null ? eventName : undefined,
+                    limit,
+                    page,
+                    resource_id: resourceId,
+                    resource_type: resourceType != null ? resourceType : undefined,
+                };
+                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 ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                    url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, "v1/webhook-events"),
+                    method: "GET",
+                    headers: _headers,
+                    queryString: core.url
+                        .queryBuilder()
+                        .addMany(_queryParams)
+                        .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                        .build(),
+                    timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                    maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                    abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.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 VitableConnect.BadRequestError(_response.error.body, _response.rawResponse);
+                        case 401:
+                            throw new VitableConnect.UnauthorizedError(_response.error.body, _response.rawResponse);
+                        case 403:
+                            throw new VitableConnect.ForbiddenError(_response.error.body, _response.rawResponse);
+                        case 404:
+                            throw new VitableConnect.NotFoundError(_response.error.body, _response.rawResponse);
+                        case 409:
+                            throw new VitableConnect.ConflictError(_response.error.body, _response.rawResponse);
+                        case 429:
+                            throw new VitableConnect.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                        case 500:
+                            throw new VitableConnect.InternalServerError(_response.error.body, _response.rawResponse);
+                        case 502:
+                            throw new VitableConnect.BadGatewayError(_response.error.body, _response.rawResponse);
+                        default:
+                            throw new errors.VitableConnectError({
+                                statusCode: _response.error.statusCode,
+                                body: _response.error.body,
+                                rawResponse: _response.rawResponse,
+                            });
+                    }
+                }
+                return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/webhook-events");
+            }));
+            let _offset = (request === null || request === void 0 ? void 0 : request.page) != null ? request === null || request === void 0 ? void 0 : request.page : 1;
+            const dataWithRawResponse = yield list(request).withRawResponse();
+            return new core.Page({
+                response: dataWithRawResponse.data,
+                rawResponse: dataWithRawResponse.rawResponse,
+                hasNextPage: (response) => { var _a; return ((_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : []).length > 0; },
+                getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : []; },
+                loadPage: (_response) => {
+                    _offset += 1;
+                    return list(core.setObjectProperty(request, "page", _offset));
+                },
+            });
+        });
+    }
+    /**
+     * Retrieves a single webhook event by its prefixed ID. Returns 404 if the event does not exist or belongs to a different organization.
+     *
+     * @param {VitableConnect.GetWebhookEventsRequest} request
+     * @param {WebhookEventsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link VitableConnect.BadRequestError}
+     * @throws {@link VitableConnect.UnauthorizedError}
+     * @throws {@link VitableConnect.ForbiddenError}
+     * @throws {@link VitableConnect.NotFoundError}
+     * @throws {@link VitableConnect.ConflictError}
+     * @throws {@link VitableConnect.TooManyRequestsError}
+     * @throws {@link VitableConnect.InternalServerError}
+     * @throws {@link VitableConnect.BadGatewayError}
+     * @throws {@link errors.VitableConnectError}
+     * @throws {@link errors.VitableConnectTimeoutError}
+     *
+     * @example
+     *     await client.webhookEvents.get({
+     *         event_id: "event_id"
+     *     })
+     */
+    get(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
+    }
+    __get(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const { event_id: eventId } = request;
+            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 ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/webhook-events/${core.url.encodePathParam(eventId)}`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.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 VitableConnect.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new VitableConnect.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new VitableConnect.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new VitableConnect.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new VitableConnect.ConflictError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new VitableConnect.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new VitableConnect.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new VitableConnect.BadGatewayError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.VitableConnectError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/webhook-events/{event_id}");
+        });
+    }
+    /**
+     * Retrieves all delivery attempts for a webhook event. Returns up to 100 deliveries. Each delivery includes a computed status field (Pending, In Progress, Delivered, or Failed).
+     *
+     * @param {VitableConnect.ListDeliveriesWebhookEventsRequest} request
+     * @param {WebhookEventsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link VitableConnect.BadRequestError}
+     * @throws {@link VitableConnect.UnauthorizedError}
+     * @throws {@link VitableConnect.ForbiddenError}
+     * @throws {@link VitableConnect.NotFoundError}
+     * @throws {@link VitableConnect.ConflictError}
+     * @throws {@link VitableConnect.TooManyRequestsError}
+     * @throws {@link VitableConnect.InternalServerError}
+     * @throws {@link VitableConnect.BadGatewayError}
+     * @throws {@link errors.VitableConnectError}
+     * @throws {@link errors.VitableConnectTimeoutError}
+     *
+     * @example
+     *     await client.webhookEvents.listDeliveries({
+     *         event_id: "event_id"
+     *     })
+     */
+    listDeliveries(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listDeliveries(request, requestOptions));
+    }
+    __listDeliveries(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const { event_id: eventId } = request;
+            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 ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/webhook-events/${core.url.encodePathParam(eventId)}/deliveries`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.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 VitableConnect.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new VitableConnect.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new VitableConnect.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new VitableConnect.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new VitableConnect.ConflictError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new VitableConnect.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new VitableConnect.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new VitableConnect.BadGatewayError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.VitableConnectError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/webhook-events/{event_id}/deliveries");
+        });
+    }
+}

package/dist/esm/api/resources/webhookEvents/client/index.d.mts

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

package/dist/esm/api/resources/webhookEvents/client/index.mjs

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

package/dist/esm/api/resources/webhookEvents/client/requests/GetWebhookEventsRequest.d.mts

@@ -0,0 +1,10 @@
+import type * as VitableConnect from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         event_id: "event_id"
+ *     }
+ */
+export interface GetWebhookEventsRequest {
+    event_id: VitableConnect.EventId;
+}

package/dist/esm/api/resources/webhookEvents/client/requests/GetWebhookEventsRequest.mjs

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

package/dist/esm/api/resources/webhookEvents/client/requests/ListDeliveriesWebhookEventsRequest.d.mts

@@ -0,0 +1,10 @@
+import type * as VitableConnect from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         event_id: "event_id"
+ *     }
+ */
+export interface ListDeliveriesWebhookEventsRequest {
+    event_id: VitableConnect.EventId;
+}

package/dist/esm/api/resources/webhookEvents/client/requests/ListDeliveriesWebhookEventsRequest.mjs

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

package/dist/esm/api/resources/webhookEvents/client/requests/ListWebhookEventsRequest.d.mts

@@ -0,0 +1,38 @@
+import type * as VitableConnect from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         limit: 20,
+ *         page: 1
+ *     }
+ */
+export interface ListWebhookEventsRequest {
+    created_after?: VitableConnect.CreatedAfter;
+    created_before?: VitableConnect.CreatedBefore;
+    /**
+     * * `enrollment.accepted` - Enrollment Accepted
+     * * `enrollment.terminated` - Enrollment Terminated
+     * * `enrollment.termination_rescheduled` - Enrollment Termination Rescheduled
+     * * `enrollment.elected` - Enrollment Elected
+     * * `enrollment.granted` - Enrollment Granted
+     * * `enrollment.waived` - Enrollment Waived
+     * * `enrollment.started` - Enrollment Started
+     * * `employee.eligibility_granted` - Employee Eligibility Granted
+     * * `employee.eligibility_terminated` - Employee Eligibility Terminated
+     * * `employee.deactivated` - Employee Deactivated
+     * * `employee.deduction_created` - Employee Deduction Created
+     */
+    event_name?: VitableConnect.EventName;
+    limit?: VitableConnect.Limit;
+    page?: VitableConnect.Page;
+    resource_id?: VitableConnect.ResourceId;
+    /**
+     * * `enrollment` - Enrollment
+     * * `employee` - Employee
+     * * `employer` - Employer
+     * * `dependent` - Dependent
+     * * `plan_year` - Plan Year
+     * * `payroll_deduction` - Payroll Deduction
+     */
+    resource_type?: VitableConnect.ResourceType;
+}

package/dist/esm/api/resources/webhookEvents/client/requests/ListWebhookEventsRequest.mjs

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

package/dist/esm/api/resources/webhookEvents/client/requests/index.d.mts

@@ -0,0 +1,3 @@
+export type { GetWebhookEventsRequest } from "./GetWebhookEventsRequest.mjs";
+export type { ListDeliveriesWebhookEventsRequest } from "./ListDeliveriesWebhookEventsRequest.mjs";
+export type { ListWebhookEventsRequest } from "./ListWebhookEventsRequest.mjs";

package/dist/esm/api/resources/webhookEvents/client/requests/index.mjs

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

package/dist/esm/api/resources/webhookEvents/exports.d.mts

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

package/dist/esm/api/resources/webhookEvents/exports.mjs

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

package/dist/esm/api/resources/webhookEvents/index.d.mts

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

package/dist/esm/api/resources/webhookEvents/index.mjs

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

package/dist/esm/api/types/AccessMethod.d.mts

@@ -0,0 +1,9 @@
+/**
+ * * `SELF_SETUP` - SELF_SETUP
+ * * `NEEDS_HELP` - NEEDS_HELP
+ */
+export declare const AccessMethod: {
+    readonly SelfSetup: "SELF_SETUP";
+    readonly NeedsHelp: "NEEDS_HELP";
+};
+export type AccessMethod = (typeof AccessMethod)[keyof typeof AccessMethod];

package/dist/esm/api/types/AccessMethod.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * * `SELF_SETUP` - SELF_SETUP
+ * * `NEEDS_HELP` - NEEDS_HELP
+ */
+export const AccessMethod = {
+    SelfSetup: "SELF_SETUP",
+    NeedsHelp: "NEEDS_HELP",
+};

package/dist/esm/api/types/AccessTokenResponse.d.mts

@@ -0,0 +1,11 @@
+import type * as VitableConnect from "../index.mjs";
+export interface AccessTokenResponse {
+    /** The issued access token (vit_at_*) */
+    access_token: string;
+    /** Token type, always 'Bearer' */
+    token_type: string;
+    /** Token lifetime in seconds */
+    expires_in: number;
+    /** Entity the token is bound to, if any */
+    bound_entity?: (VitableConnect.BoundEntityResponse | null) | undefined;
+}

package/dist/esm/api/types/AccessTokenResponse.mjs

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

package/dist/esm/api/types/AdditionalAccessMethod.d.mts

@@ -0,0 +1,9 @@
+/**
+ * * `SELF_SETUP` - SELF_SETUP
+ * * `NEEDS_HELP` - NEEDS_HELP
+ */
+export declare const AdditionalAccessMethod: {
+    readonly SelfSetup: "SELF_SETUP";
+    readonly NeedsHelp: "NEEDS_HELP";
+};
+export type AdditionalAccessMethod = (typeof AdditionalAccessMethod)[keyof typeof AdditionalAccessMethod];

package/dist/esm/api/types/AdditionalAccessMethod.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * * `SELF_SETUP` - SELF_SETUP
+ * * `NEEDS_HELP` - NEEDS_HELP
+ */
+export const AdditionalAccessMethod = {
+    SelfSetup: "SELF_SETUP",
+    NeedsHelp: "NEEDS_HELP",
+};

package/dist/esm/api/types/Address.d.mts

@@ -0,0 +1,19 @@
+/**
+ * Shared read serializer for a postal address on public API responses.
+ *
+ * One definition for the address block every public resource emits (employer, employee, …), so the
+ * 5-field shape isn't hand-rolled per endpoint. Read-only: it renders an already-built address
+ * value object (e.g. ``AddressDVO``) whose attributes map 1:1 to these fields.
+ */
+export interface Address {
+    /** Primary street address. */
+    address_line_1: string;
+    /** Secondary street address (apt, suite, etc.). */
+    address_line_2: string | null;
+    /** City name. */
+    city: string;
+    /** Two-letter state code (e.g. `CA`, `NY`). */
+    state: string;
+    /** ZIP code (5 or 9 digit). */
+    zipcode: string;
+}

package/dist/esm/api/types/Address.mjs

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

package/dist/esm/api/types/AddressRequest.d.mts

@@ -0,0 +1,12 @@
+export interface AddressRequest {
+    /** Street address, including house or building number. */
+    address_line_1: string;
+    /** Apartment, suite, unit, or floor. Omit if not applicable. */
+    address_line_2?: (string | null) | undefined;
+    /** City or town name. */
+    city: string;
+    /** Two-letter USPS state or territory code, e.g. `PA`. */
+    state: string;
+    /** US postal code, either five digits or ZIP+4. */
+    zipcode: string;
+}

package/dist/esm/api/types/AddressRequest.mjs

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

package/dist/esm/api/types/BenefitFamily.d.mts

@@ -0,0 +1,17 @@
+/**
+ * * `mec` - Mec
+ * * `mvp` - Mvp
+ * * `ichra` - Ichra
+ * * `vpc` - Vpc
+ * * `dental` - Dental
+ * * `vision` - Vision
+ */
+export declare const BenefitFamily: {
+    readonly Mec: "mec";
+    readonly Mvp: "mvp";
+    readonly Ichra: "ichra";
+    readonly Vpc: "vpc";
+    readonly Dental: "dental";
+    readonly Vision: "vision";
+};
+export type BenefitFamily = (typeof BenefitFamily)[keyof typeof BenefitFamily];