@fonoster/types 0.5.4 → 0.6.2-alpha.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Fonoster Inc
+Copyright (c) 2024 Fonoster Inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+<a href="https://gitpod.io/#https://github.com/fonoster/fonoster"> <img src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod" alt="Contribute with Gitpod" />
+
+This module is part of the [Fonoster](https://fonoster.com) project. By itself, it does not do much. It is intended to be used as a dependency for other modules. For more information about the project, please visit [https://github.com/fonoster/fonoster](https://github.com/fonoster/fonoster)(../apiserver/README.md)

package/dist/acls.types.d.ts

@@ -0,0 +1,37 @@
+import { BaseApiObject } from "./common";
+type AclExtended = {
+    ref: string;
+    name: string;
+    allow: string[];
+    deny: string[];
+    extended?: Record<string, unknown>;
+    createdAt?: number;
+    updatedAt?: number;
+};
+type CreateAclRequestExtended = {
+    name: string;
+    allow: string[];
+    deny: string[];
+    extended: {
+        accessKeyId: string;
+    };
+};
+type UpdateAclRequest = BaseApiObject & Omit<Partial<CreateAclRequestExtended>, "extended">;
+type ListAclsRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ListAclsResponse = {
+    items: Acl[];
+    nextPageToken: string;
+};
+type Acl = Omit<AclExtended, "extended">;
+type CreateAclRequest = Omit<CreateAclRequestExtended, "extended">;
+type AclsApi = {
+    createACL(request: CreateAclRequestExtended): Promise<BaseApiObject>;
+    updateACL(request: UpdateAclRequest): Promise<BaseApiObject>;
+    getACL(ref: string): Promise<AclExtended>;
+    deleteACL(ref: string): Promise<void>;
+    listACLs(request: ListAclsRequest): Promise<ListAclsResponse>;
+};
+export { Acl, AclExtended, CreateAclRequest, CreateAclRequestExtended, UpdateAclRequest, ListAclsRequest, ListAclsResponse, AclsApi };

package/dist/acls.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/agents.types.d.ts

@@ -0,0 +1,50 @@
+import { BaseApiObject } from "./common";
+import { Domain } from "./domains.types";
+declare enum Privacy {
+    PRIVATE = "ID",
+    NONE = "NONE"
+}
+type AgentExtended = {
+    ref: string;
+    name: string;
+    username: string;
+    privacy: Privacy;
+    enabled: boolean;
+    maxContacts?: number;
+    expires?: number;
+    domain?: Domain;
+    extended?: Record<string, unknown>;
+    createdAt?: number;
+    updatedAt?: number;
+};
+type CreateAgentRequestExtended = {
+    name: string;
+    username: string;
+    privacy: Privacy;
+    enabled: boolean;
+    maxContacts: number;
+    expires?: number;
+    domainRef: string;
+    extended: {
+        accessKeyId: string;
+    };
+};
+type UpdateAgentRequest = BaseApiObject & Omit<Partial<CreateAgentRequestExtended>, "username" | "extended">;
+type ListAgentsRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ListAgentsResponse = {
+    items: Agent[];
+    nextPageToken: string;
+};
+type AgentsApi = {
+    createAgent(request: CreateAgentRequestExtended): Promise<BaseApiObject>;
+    updateAgent(request: UpdateAgentRequest): Promise<BaseApiObject>;
+    getAgent(ref: string): Promise<AgentExtended>;
+    deleteAgent(ref: string): Promise<void>;
+    listAgents(request: ListAgentsRequest): Promise<ListAgentsResponse>;
+};
+type Agent = Omit<AgentExtended, "extended">;
+type CreateAgentRequest = Omit<CreateAgentRequestExtended, "extended">;
+export { AgentExtended, Agent, CreateAgentRequestExtended, CreateAgentRequest, UpdateAgentRequest, ListAgentsRequest, ListAgentsResponse, AgentsApi, Privacy };

package/dist/agents.types.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Privacy = void 0;
+var Privacy;
+(function (Privacy) {
+    Privacy["PRIVATE"] = "ID";
+    Privacy["NONE"] = "NONE";
+})(Privacy || (exports.Privacy = Privacy = {}));

package/dist/applications.types.d.ts

@@ -0,0 +1,57 @@
+import { BaseApiObject } from "./common";
+declare enum ApplicationType {
+    PROGRAMMABLE_VOICE = "PROGRAMMABLE_VOICE"
+}
+type Application = {
+    ref: string;
+    name: string;
+    type: ApplicationType;
+    appEndpoint: string;
+    textToSpeech: {
+        productRef: string;
+        config: Record<string, unknown>;
+    };
+    speechToText: {
+        productRef: string;
+        config: Record<string, unknown>;
+    };
+    intelligence: {
+        productRef: string;
+        config: Record<string, unknown>;
+    };
+    createdAt: Date;
+    updatedAt: Date;
+};
+type CreateApplicationRequest = {
+    name: string;
+    type: ApplicationType;
+    appEndpoint?: string;
+    textToSpeech?: {
+        productRef: string;
+        config: Record<string, unknown>;
+    };
+    speechToText?: {
+        productRef: string;
+        config: Record<string, unknown>;
+    };
+    intelligence?: {
+        productRef: string;
+        credentials: Record<string, unknown>;
+        config: Record<string, unknown>;
+    };
+};
+type CreateApplicationResponse = BaseApiObject;
+type UpdateApplicationRequest = BaseApiObject & Partial<CreateApplicationRequest>;
+type GetApplicationRequest = BaseApiObject;
+type UpdateApplicationResponse = BaseApiObject;
+type DeleteApplicationRequest = BaseApiObject;
+type DeleteApplicationResponse = BaseApiObject;
+type ListApplicationsRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ListApplicationsResponse = {
+    nextPageToken?: string;
+    items: Application[];
+};
+export { Application, CreateApplicationRequest, CreateApplicationResponse, UpdateApplicationRequest, UpdateApplicationResponse, DeleteApplicationRequest, DeleteApplicationResponse, ListApplicationsRequest, ListApplicationsResponse, GetApplicationRequest, ApplicationType };

package/dist/applications.types.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationType = void 0;
+var ApplicationType;
+(function (ApplicationType) {
+    ApplicationType["PROGRAMMABLE_VOICE"] = "PROGRAMMABLE_VOICE";
+})(ApplicationType || (exports.ApplicationType = ApplicationType = {}));

package/dist/calls.types.d.ts

@@ -0,0 +1,87 @@
+declare const CALL_DETAIL_RECORD_MEASUREMENT = "cdr";
+declare enum CallType {
+    PROGRAMMABLE = "PROGRAMMABLE",
+    SIP_TRUNKING = "SIP_TRUNKING"
+}
+declare enum HangupCause {
+    NORMAL_CLEARING = "NORMAL_CLEARING",
+    CALL_REJECTED = "CALL_REJECTED",
+    UNALLOCATED = "UNALLOCATED",
+    NO_USER_RESPONSE = "NO_USER_RESPONSE",
+    NO_ROUTE_DESTINATION = "NO_ROUTE_DESTINATION",
+    NO_ANSWER = "NO_ANSWER",
+    USER_BUSY = "USER_BUSY",
+    NOT_ACCEPTABLE_HERE = "NOT_ACCEPTABLE_HERE",
+    SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
+    INVALID_NUMBER_FORMAT = "INVALID_NUMBER_FORMAT"
+}
+declare enum CallStatus {
+    QUEUED = "QUEUED",
+    RINGING = "RINGING",
+    IN_PROGRESS = "IN_PROGRESS",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    BUSY = "BUSY",
+    NO_ANSWER = "NO_ANSWER",
+    CANCELED = "CANCELED",
+    REJECTED = "REJECTED",
+    TIMEOUT = "TIMEOUT",
+    UNKNOWN = "UNKNOWN"
+}
+declare enum CallDirection {
+    INBOUND = "INBOUND",
+    OUTBOUND = "OUTBOUND"
+}
+type CallDetailRecord = {
+    ref: string;
+    type: CallType;
+    status: CallStatus;
+    hangupCause: HangupCause;
+    from: string;
+    to: string;
+    duration: number;
+    direction: CallDirection;
+    startedAt: number;
+    endedAt: number;
+};
+type ListCallsRequest = {
+    after?: string;
+    before?: string;
+    type?: CallType;
+    status?: CallStatus;
+    hangupCause?: HangupCause;
+    from?: string;
+    to?: string;
+    pageSize?: number;
+    pageToken?: string;
+};
+type ListCallsResponse = {
+    nextPageToken?: string;
+    items: CallDetailRecord[];
+};
+type GetCallRequest = {
+    ref: string;
+};
+type CreateCallRequest = {
+    from: string;
+    to: string;
+    appRef?: string;
+};
+type CreateCallResponse = {
+    ref: string;
+};
+type CallPublisher = {
+    publishCall: (event: CreateCallRequest & {
+        ref: string;
+    }) => void;
+};
+type TrackCallResponse = {
+    ref: string;
+    status: CallStatus;
+};
+type TrackCallSubscriber = {
+    events: {
+        on: (event: string, cb: (data: TrackCallResponse | Error) => void) => void;
+    };
+};
+export { CALL_DETAIL_RECORD_MEASUREMENT, CallDetailRecord, ListCallsRequest, ListCallsResponse, GetCallRequest, CallType, CallStatus, CallDirection, CreateCallRequest, CreateCallResponse, CallPublisher, TrackCallResponse, TrackCallSubscriber, HangupCause };

package/dist/calls.types.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HangupCause = exports.CallDirection = exports.CallStatus = exports.CallType = exports.CALL_DETAIL_RECORD_MEASUREMENT = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const CALL_DETAIL_RECORD_MEASUREMENT = "cdr";
+exports.CALL_DETAIL_RECORD_MEASUREMENT = CALL_DETAIL_RECORD_MEASUREMENT;
+var CallType;
+(function (CallType) {
+    CallType["PROGRAMMABLE"] = "PROGRAMMABLE";
+    CallType["SIP_TRUNKING"] = "SIP_TRUNKING";
+})(CallType || (exports.CallType = CallType = {}));
+var HangupCause;
+(function (HangupCause) {
+    HangupCause["NORMAL_CLEARING"] = "NORMAL_CLEARING";
+    HangupCause["CALL_REJECTED"] = "CALL_REJECTED";
+    HangupCause["UNALLOCATED"] = "UNALLOCATED";
+    HangupCause["NO_USER_RESPONSE"] = "NO_USER_RESPONSE";
+    HangupCause["NO_ROUTE_DESTINATION"] = "NO_ROUTE_DESTINATION";
+    HangupCause["NO_ANSWER"] = "NO_ANSWER";
+    HangupCause["USER_BUSY"] = "USER_BUSY";
+    HangupCause["NOT_ACCEPTABLE_HERE"] = "NOT_ACCEPTABLE_HERE";
+    HangupCause["SERVICE_UNAVAILABLE"] = "SERVICE_UNAVAILABLE";
+    HangupCause["INVALID_NUMBER_FORMAT"] = "INVALID_NUMBER_FORMAT";
+})(HangupCause || (exports.HangupCause = HangupCause = {}));
+var CallStatus;
+(function (CallStatus) {
+    CallStatus["QUEUED"] = "QUEUED";
+    CallStatus["RINGING"] = "RINGING";
+    CallStatus["IN_PROGRESS"] = "IN_PROGRESS";
+    CallStatus["COMPLETED"] = "COMPLETED";
+    CallStatus["FAILED"] = "FAILED";
+    CallStatus["BUSY"] = "BUSY";
+    CallStatus["NO_ANSWER"] = "NO_ANSWER";
+    CallStatus["CANCELED"] = "CANCELED";
+    CallStatus["REJECTED"] = "REJECTED";
+    CallStatus["TIMEOUT"] = "TIMEOUT";
+    CallStatus["UNKNOWN"] = "UNKNOWN";
+})(CallStatus || (exports.CallStatus = CallStatus = {}));
+var CallDirection;
+(function (CallDirection) {
+    CallDirection["INBOUND"] = "INBOUND";
+    CallDirection["OUTBOUND"] = "OUTBOUND";
+})(CallDirection || (exports.CallDirection = CallDirection = {}));

package/dist/common.d.ts

@@ -0,0 +1,8 @@
+type BaseApiObject = {
+    ref: string;
+};
+type NumberPreconditionsCheck = (request: {
+    appRef?: string;
+    agentAor?: string;
+}) => Promise<void>;
+export { NumberPreconditionsCheck, BaseApiObject };

package/dist/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/credentials.types.d.ts

@@ -0,0 +1,37 @@
+import { BaseApiObject } from "./common";
+type CredentialsExtended = {
+    ref: string;
+    name: string;
+    username: string;
+    password: string;
+    extended?: Record<string, unknown>;
+    createdAt?: number;
+    updatedAt?: number;
+};
+type CreateCredentialsRequestExtended = {
+    name: string;
+    username: string;
+    password: string;
+    extended: {
+        accessKeyId: string;
+    };
+};
+type UpdateCredentialsRequest = BaseApiObject & Omit<Partial<CreateCredentialsRequest>, "username" | "extended">;
+type ListCredentialsRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ListCredentialsResponse = {
+    items: Credentials[];
+    nextPageToken: string;
+};
+type CredentialsApi = {
+    createCredentials(request: CreateCredentialsRequestExtended): Promise<BaseApiObject>;
+    updateCredentials(request: UpdateCredentialsRequest): Promise<BaseApiObject>;
+    getCredentials(ref: string): Promise<CredentialsExtended>;
+    deleteCredentials(ref: string): Promise<void>;
+    listCredentials(request: ListCredentialsRequest): Promise<ListCredentialsResponse>;
+};
+type Credentials = Omit<CredentialsExtended, "extended">;
+type CreateCredentialsRequest = Omit<CreateCredentialsRequestExtended, "extended">;
+export { Credentials, CredentialsExtended, CreateCredentialsRequest, CreateCredentialsRequestExtended, UpdateCredentialsRequest, ListCredentialsRequest, ListCredentialsResponse, CredentialsApi };

package/dist/credentials.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/domains.types.d.ts

@@ -0,0 +1,45 @@
+import { BaseApiObject } from "./common";
+type DomainExtended = {
+    ref: string;
+    name: string;
+    domainUri: string;
+    accessControlListRef?: string;
+    egressPolicies?: {
+        rule: string;
+        numberRef: string;
+    }[];
+    extended?: Record<string, unknown>;
+    createdAt?: number;
+    updatedAt?: number;
+};
+type CreateDomainRequestExtended = {
+    name: string;
+    domainUri: string;
+    accessControlListRef?: string;
+    egressPolicies?: {
+        rule: string;
+        numberRef: string;
+    }[];
+    extended: {
+        accessKeyId: string;
+    };
+};
+type UpdateDomainRequest = BaseApiObject & Omit<Partial<CreateDomainRequest>, "domainUri" | "extended">;
+type ListDomainsRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ListDomainsResponse = {
+    items: Domain[];
+    nextPageToken: string;
+};
+type DomainsApi = {
+    createDomain: (request: CreateDomainRequest) => Promise<BaseApiObject>;
+    updateDomain: (request: UpdateDomainRequest) => Promise<BaseApiObject>;
+    getDomain: (ref: string) => Promise<Domain>;
+    listDomains: (request: ListDomainsRequest) => Promise<ListDomainsResponse>;
+    deleteDomain: (ref: string) => Promise<void>;
+};
+type Domain = Omit<DomainExtended, "extended">;
+type CreateDomainRequest = Omit<CreateDomainRequestExtended, "extended">;
+export { Domain, DomainExtended, DomainsApi, CreateDomainRequestExtended, CreateDomainRequest, UpdateDomainRequest, ListDomainsRequest, ListDomainsResponse };

package/dist/domains.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/identity.types.d.ts

@@ -0,0 +1,54 @@
+declare enum ApiRoleEnum {
+    WORKSPACE_ADMIN = "WORKSPACE_ADMIN"
+}
+type User = {
+    ref: string;
+    email: string;
+    name: string;
+    avatar: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type CreateUserRequest = {
+    name: string;
+    email: string;
+    password: string;
+    avatar: string;
+};
+type CreateApiKeyResponse = {
+    ref: string;
+    accessKeyId: string;
+    accessKeySecret: string;
+};
+type UpdateUserRequest = {
+    ref: string;
+    name?: string;
+    password?: string;
+    avatar?: string;
+};
+type CreateApiKeyRequest = {
+    role: ApiRoleEnum;
+    expiresAt?: number;
+};
+type RegenerateApiKeyResponse = {
+    ref: string;
+    accessKeyId: string;
+    accessKeySecret: string;
+};
+type ListApiKeysRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ApiKey = {
+    ref: string;
+    accessKeyId: string;
+    role: ApiRoleEnum;
+    expiresAt: Date;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type ListApiKeysResponse = {
+    items: ApiKey[];
+    nextPageToken?: string;
+};
+export { ApiRoleEnum, User, CreateUserRequest, UpdateUserRequest, CreateApiKeyRequest, CreateApiKeyResponse, RegenerateApiKeyResponse, ListApiKeysRequest, ListApiKeysResponse };

package/dist/identity.types.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiRoleEnum = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var ApiRoleEnum;
+(function (ApiRoleEnum) {
+    ApiRoleEnum["WORKSPACE_ADMIN"] = "WORKSPACE_ADMIN";
+})(ApiRoleEnum || (exports.ApiRoleEnum = ApiRoleEnum = {}));

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./agents.types";
+export * from "./acls.types";
+export * from "./credentials.types";
+export * from "./domains.types";
+export * from "./trunks.types";
+export * from "./numbers.types";
+export * from "./applications.types";
+export * from "./common";
+export * from "./calls.types";
+export * from "./identity.types";
+export * from "./secrets.types";
+export * from "./workspaces.types";

package/dist/index.js

@@ -1 +1,46 @@
-// Deprecated
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+__exportStar(require("./agents.types"), exports);
+__exportStar(require("./acls.types"), exports);
+__exportStar(require("./credentials.types"), exports);
+__exportStar(require("./domains.types"), exports);
+__exportStar(require("./trunks.types"), exports);
+__exportStar(require("./numbers.types"), exports);
+__exportStar(require("./applications.types"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./calls.types"), exports);
+__exportStar(require("./identity.types"), exports);
+__exportStar(require("./secrets.types"), exports);
+__exportStar(require("./workspaces.types"), exports);

package/dist/numbers.types.d.ts

@@ -0,0 +1,72 @@
+import { BaseApiObject } from "./common";
+import { TrunkExtended } from "./trunks.types";
+type INumberExtended = {
+    ref: string;
+    name: string;
+    telUrl: string;
+    aorLink: string;
+    city: string;
+    country: string;
+    countryIsoCode: string;
+    sessionAffinityHeader: string;
+    extraHeaders: {
+        name: string;
+        value: string;
+    }[];
+    trunk?: TrunkExtended;
+    extended?: Record<string, unknown>;
+    createdAt?: number;
+    updatedAt?: number;
+};
+type CreateNumberRequestExtended = {
+    name: string;
+    telUrl: string;
+    aorLink: string;
+    city: string;
+    country: string;
+    countryIsoCode: string;
+    sessionAffinityHeader: string;
+    extraHeaders: {
+        name: string;
+        value: string;
+    }[];
+    extended: {
+        accessKeyId: string;
+    };
+};
+type UpdateNumberRequest = {
+    ref: string;
+} & Omit<Partial<CreateNumberRequest>, "telUrl" | "city" | "country" | "countryIsoCode" | "extended">;
+type ListNumbersRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ListNumbersResponse = {
+    items: INumber[];
+    nextPageToken: string;
+};
+type INumber = Omit<INumberExtended, "extended">;
+type CreateNumberRequest = Omit<CreateNumberRequestExtended, "extended" | "sessionAffinityHeader">;
+type FCreateNumberRequest = {
+    name: string;
+    telUrl: string;
+    city: string;
+    country: string;
+    countryIsoCode: string;
+    appRef?: string;
+    agentAor?: string;
+};
+type FUpdateNumberRequest = {
+    ref: string;
+    name?: string;
+    appRef?: string;
+    agentAor?: string;
+};
+type NumbersApi = {
+    createNumber(request: CreateNumberRequestExtended): Promise<BaseApiObject>;
+    updateNumber(request: UpdateNumberRequest): Promise<BaseApiObject>;
+    getNumber(ref: string): Promise<INumberExtended>;
+    deleteNumber(ref: string): Promise<void>;
+    listNumbers(request: ListNumbersRequest): Promise<ListNumbersResponse>;
+};
+export { INumber, INumberExtended, NumbersApi, CreateNumberRequest, CreateNumberRequestExtended, UpdateNumberRequest, ListNumbersRequest, ListNumbersResponse, FCreateNumberRequest, FUpdateNumberRequest };

package/dist/numbers.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/secrets.types.d.ts

@@ -0,0 +1,22 @@
+import { BaseApiObject } from "./common";
+type Secret = {
+    ref: string;
+    name: string;
+    secret: string;
+    createdAt: number;
+    updatedAt: number;
+};
+type CreateSecretRequest = {
+    name: string;
+    secret: string;
+};
+type UpdateSecretRequest = BaseApiObject & Partial<CreateSecretRequest>;
+type ListSecretsRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ListSecretsResponse = {
+    nextPageToken?: string;
+    items: Secret[];
+};
+export { Secret, CreateSecretRequest, UpdateSecretRequest, ListSecretsRequest, ListSecretsResponse };

package/dist/secrets.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/trunks.types.d.ts

@@ -0,0 +1,77 @@
+import { Acl } from "./acls.types";
+import { CredentialsExtended } from "./credentials.types";
+declare enum Transport {
+    UDP = "UDP",
+    TCP = "TCP",
+    TLS = "TLS",
+    SCTP = "SCTP",
+    WS = "WS",
+    WSS = "WSS"
+}
+type TrunkURI = {
+    host: string;
+    port: number;
+    transport: Transport;
+    user: string;
+    weight: number;
+    priority: number;
+    enabled: boolean;
+};
+type TrunkExtended = {
+    ref: string;
+    name: string;
+    sendRegister: boolean;
+    inboundUri?: string;
+    accessControlList?: Acl;
+    inboundCredentials?: CredentialsExtended;
+    outboundCredentials?: CredentialsExtended;
+    uris?: TrunkURI[];
+    extended?: unknown;
+    createdAt?: number;
+    updatedAt?: number;
+};
+type CreateTrunkRequestExtended = {
+    name: string;
+    sendRegister: boolean;
+    inboundUri: string;
+    accessControlList?: Acl;
+    inboundCredentials?: CredentialsExtended;
+    outboundCredentials?: CredentialsExtended;
+    uris?: TrunkURI[];
+    extended?: {
+        accessKeyId: string;
+    };
+};
+type UpdateTrunkRequest = {
+    ref: string;
+} & Omit<Partial<CreateTrunkRequest>, "extended">;
+type CreateTrunkResponse = {
+    ref: string;
+};
+type UpdateTrunkResponse = {
+    ref: string;
+};
+type GetTrunkRequest = {
+    ref: string;
+};
+type DeleteTrunkRequest = {
+    ref: string;
+};
+type ListTrunksRequest = {
+    pageSize: number;
+    pageToken: string;
+};
+type ListTrunksResponse = {
+    items: Trunk[];
+    nextPageToken: string;
+};
+type Trunk = Omit<TrunkExtended, "extended">;
+type CreateTrunkRequest = Omit<CreateTrunkRequestExtended, "extended">;
+type TrunkApi = {
+    createTrunk(request: CreateTrunkRequest): Promise<CreateTrunkResponse>;
+    updateTrunk(request: UpdateTrunkRequest): Promise<UpdateTrunkResponse>;
+    getTrunk(ref: string): Promise<Trunk>;
+    deleteTrunk(ref: string): Promise<void>;
+    listTrunks(request: ListTrunksRequest): Promise<ListTrunksResponse>;
+};
+export { Trunk, TrunkExtended, CreateTrunkRequest, CreateTrunkRequestExtended, UpdateTrunkRequest, CreateTrunkResponse, UpdateTrunkResponse, GetTrunkRequest, DeleteTrunkRequest, ListTrunksRequest, ListTrunksResponse, TrunkApi };

package/dist/trunks.types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Transport;
+(function (Transport) {
+    Transport["UDP"] = "UDP";
+    Transport["TCP"] = "TCP";
+    Transport["TLS"] = "TLS";
+    Transport["SCTP"] = "SCTP";
+    Transport["WS"] = "WS";
+    Transport["WSS"] = "WSS";
+})(Transport || (Transport = {}));

package/dist/workspaces.types.d.ts

@@ -0,0 +1,49 @@
+declare enum WorkspaceRoleEnum {
+    OWNER = "OWNER",
+    ADMIN = "ADMIN",
+    USER = "USER"
+}
+declare enum WorkspaceMemberStatus {
+    PENDING = "PENDING",
+    ACTIVE = "ACTIVE"
+}
+type Workspace = {
+    ref: string;
+    name: string;
+    ownerRef: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type CreateWorkspaceRequest = {
+    name: string;
+};
+type UpdateWorkspaceRequest = {
+    ref: string;
+    name: string;
+};
+type ListWorkspacesResponse = {
+    workspaces: Workspace[];
+};
+type InviteUserToWorkspaceResponse = {
+    workspaceRef: string;
+    userRef: string;
+};
+type InviteUserToWorkspaceRequest = {
+    email: string;
+    name: string;
+    role: WorkspaceRoleEnum;
+    password: string;
+};
+type RemoveUserFromWorkspaceRequest = {
+    userRef: string;
+};
+type RemoveUserFromWorkspaceResponse = {
+    userRef: string;
+};
+type ResendWorkspaceMembershipInvitationRequest = {
+    userRef: string;
+};
+type ResendWorkspaceMembershipInvitationResponse = {
+    userRef: string;
+};
+export { InviteUserToWorkspaceResponse, CreateWorkspaceRequest, Workspace, WorkspaceRoleEnum, InviteUserToWorkspaceRequest, UpdateWorkspaceRequest, RemoveUserFromWorkspaceRequest, RemoveUserFromWorkspaceResponse, ListWorkspacesResponse, WorkspaceMemberStatus, ResendWorkspaceMembershipInvitationRequest, ResendWorkspaceMembershipInvitationResponse };

package/dist/workspaces.types.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceMemberStatus = exports.WorkspaceRoleEnum = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var WorkspaceRoleEnum;
+(function (WorkspaceRoleEnum) {
+    WorkspaceRoleEnum["OWNER"] = "OWNER";
+    WorkspaceRoleEnum["ADMIN"] = "ADMIN";
+    WorkspaceRoleEnum["USER"] = "USER";
+})(WorkspaceRoleEnum || (exports.WorkspaceRoleEnum = WorkspaceRoleEnum = {}));
+var WorkspaceMemberStatus;
+(function (WorkspaceMemberStatus) {
+    WorkspaceMemberStatus["PENDING"] = "PENDING";
+    WorkspaceMemberStatus["ACTIVE"] = "ACTIVE";
+})(WorkspaceMemberStatus || (exports.WorkspaceMemberStatus = WorkspaceMemberStatus = {}));

package/package.json

@@ -1,20 +1,21 @@
 {
   "name": "@fonoster/types",
-  "version": "0.5.4",
-  "description": "Handles Fonoster types",
+  "version": "0.6.2-alpha.0",
+  "description": "Common types for Fonoster projects",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
   "license": "MIT",
   "main": "dist/index",
   "types": "dist/index",
-  "scripts": {
-    "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
-    "build": "tsc -b tsconfig.json"
-  },
   "directories": {
     "src": "src",
     "test": "test"
   },
+  "scripts": {
+    "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
+    "build": "tsc -b tsconfig.json",
+    "clean": "rimraf ./dist node_modules tsconfig.tsbuildinfo"
+  },
   "files": [
     "dist"
   ],
@@ -28,5 +29,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/fonoster/issues"
   },
-  "gitHead": "a1dae664944ab191e925e49346e0916f8c8347a1"
+  "gitHead": "16ee05408eb3680afbf5ad2d313e889e89e3ef6d"
 }