telnyx 5.2.2 → 5.4.0

package/src/resources/organizations/users/users.ts

@@ -0,0 +1,319 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ActionsAPI from './actions';
+import { ActionRemoveResponse, Actions } from './actions';
+import { APIPromise } from '../../../core/api-promise';
+import {
+  DefaultFlatPagination,
+  type DefaultFlatPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Users extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Returns a user in your organization.
+   */
+  retrieve(
+    id: string,
+    query: UserRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<UserRetrieveResponse> {
+    return this._client.get(path`/organizations/users/${id}`, { query, ...options });
+  }
+
+  /**
+   * Returns a list of the users in your organization.
+   */
+  list(
+    query: UserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<UserListResponsesDefaultFlatPagination, UserListResponse> {
+    return this._client.getAPIList('/organizations/users', DefaultFlatPagination<UserListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns a report of all users in your organization with their group memberships.
+   * This endpoint returns all users without pagination and always includes group
+   * information. The report can be retrieved in JSON or CSV format by sending
+   * specific content-type headers.
+   */
+  getGroupsReport(
+    params: UserGetGroupsReportParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<UserGetGroupsReportResponse> {
+    const { Accept } = params ?? {};
+    return this._client.get('/organizations/users/users_groups_report', {
+      ...options,
+      headers: buildHeaders([
+        { ...(Accept?.toString() != null ? { Accept: Accept?.toString() } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type UserListResponsesDefaultFlatPagination = DefaultFlatPagination<UserListResponse>;
+
+export interface UserRetrieveResponse {
+  data?: UserRetrieveResponse.Data;
+}
+
+export namespace UserRetrieveResponse {
+  export interface Data {
+    /**
+     * Identifies the specific resource.
+     */
+    id?: string;
+
+    /**
+     * ISO 8601 formatted date indicating when the resource was created.
+     */
+    created_at?: string;
+
+    /**
+     * The email address of the user.
+     */
+    email?: string;
+
+    /**
+     * The groups the user belongs to. Only included when include_groups parameter is
+     * true.
+     */
+    groups?: Array<Data.Group>;
+
+    /**
+     * ISO 8601 formatted date indicating when the resource last signed into the
+     * portal. Null if the user has never signed in.
+     */
+    last_sign_in_at?: string | null;
+
+    /**
+     * Indicates whether this user is allowed to bypass SSO and use password
+     * authentication.
+     */
+    organization_user_bypasses_sso?: boolean;
+
+    /**
+     * Identifies the type of the resource. Can be 'organization_owner' or
+     * 'organization_sub_user'.
+     */
+    record_type?: string;
+
+    /**
+     * The status of the account.
+     */
+    user_status?: 'enabled' | 'disabled' | 'blocked';
+  }
+
+  export namespace Data {
+    /**
+     * A reference to a group that a user belongs to.
+     */
+    export interface Group {
+      /**
+       * The unique identifier of the group.
+       */
+      id: string;
+
+      /**
+       * The name of the group.
+       */
+      name: string;
+    }
+  }
+}
+
+export interface UserListResponse {
+  /**
+   * Identifies the specific resource.
+   */
+  id?: string;
+
+  /**
+   * ISO 8601 formatted date indicating when the resource was created.
+   */
+  created_at?: string;
+
+  /**
+   * The email address of the user.
+   */
+  email?: string;
+
+  /**
+   * The groups the user belongs to. Only included when include_groups parameter is
+   * true.
+   */
+  groups?: Array<UserListResponse.Group>;
+
+  /**
+   * ISO 8601 formatted date indicating when the resource last signed into the
+   * portal. Null if the user has never signed in.
+   */
+  last_sign_in_at?: string | null;
+
+  /**
+   * Indicates whether this user is allowed to bypass SSO and use password
+   * authentication.
+   */
+  organization_user_bypasses_sso?: boolean;
+
+  /**
+   * Identifies the type of the resource. Can be 'organization_owner' or
+   * 'organization_sub_user'.
+   */
+  record_type?: string;
+
+  /**
+   * The status of the account.
+   */
+  user_status?: 'enabled' | 'disabled' | 'blocked';
+}
+
+export namespace UserListResponse {
+  /**
+   * A reference to a group that a user belongs to.
+   */
+  export interface Group {
+    /**
+     * The unique identifier of the group.
+     */
+    id: string;
+
+    /**
+     * The name of the group.
+     */
+    name: string;
+  }
+}
+
+export interface UserGetGroupsReportResponse {
+  data?: Array<UserGetGroupsReportResponse.Data>;
+}
+
+export namespace UserGetGroupsReportResponse {
+  /**
+   * An organization user with their group memberships always included.
+   */
+  export interface Data {
+    /**
+     * Identifies the specific resource.
+     */
+    id: string;
+
+    /**
+     * ISO 8601 formatted date indicating when the resource was created.
+     */
+    created_at: string;
+
+    /**
+     * The email address of the user.
+     */
+    email: string;
+
+    /**
+     * The groups the user belongs to.
+     */
+    groups: Array<Data.Group>;
+
+    /**
+     * Identifies the type of the resource. Can be 'organization_owner' or
+     * 'organization_sub_user'.
+     */
+    record_type: string;
+
+    /**
+     * The status of the account.
+     */
+    user_status: 'enabled' | 'disabled' | 'blocked';
+
+    /**
+     * ISO 8601 formatted date indicating when the resource last signed into the
+     * portal. Null if the user has never signed in.
+     */
+    last_sign_in_at?: string | null;
+
+    /**
+     * Indicates whether this user is allowed to bypass SSO and use password
+     * authentication.
+     */
+    organization_user_bypasses_sso?: boolean;
+  }
+
+  export namespace Data {
+    /**
+     * A reference to a group that a user belongs to.
+     */
+    export interface Group {
+      /**
+       * The unique identifier of the group.
+       */
+      id: string;
+
+      /**
+       * The name of the group.
+       */
+      name: string;
+    }
+  }
+}
+
+export interface UserRetrieveParams {
+  /**
+   * When set to true, includes the groups array for each user in the response. The
+   * groups array contains objects with id and name for each group the user belongs
+   * to.
+   */
+  include_groups?: boolean;
+}
+
+export interface UserListParams extends DefaultFlatPaginationParams {
+  /**
+   * Filter by email address (partial match)
+   */
+  'filter[email]'?: string;
+
+  /**
+   * Filter by user status
+   */
+  'filter[user_status]'?: 'enabled' | 'disabled' | 'blocked';
+
+  /**
+   * When set to true, includes the groups array for each user in the response. The
+   * groups array contains objects with id and name for each group the user belongs
+   * to.
+   */
+  include_groups?: boolean;
+}
+
+export interface UserGetGroupsReportParams {
+  /**
+   * Specify the response format. Use 'application/json' for JSON format or
+   * 'text/csv' for CSV format.
+   */
+  Accept?: 'application/json' | 'text/csv';
+}
+
+Users.Actions = Actions;
+
+export declare namespace Users {
+  export {
+    type UserRetrieveResponse as UserRetrieveResponse,
+    type UserListResponse as UserListResponse,
+    type UserGetGroupsReportResponse as UserGetGroupsReportResponse,
+    type UserListResponsesDefaultFlatPagination as UserListResponsesDefaultFlatPagination,
+    type UserRetrieveParams as UserRetrieveParams,
+    type UserListParams as UserListParams,
+    type UserGetGroupsReportParams as UserGetGroupsReportParams,
+  };
+
+  export { Actions as Actions, type ActionRemoveResponse as ActionRemoveResponse };
+}

package/src/resources/organizations/users.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './users/index';

package/src/resources/organizations.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './organizations/index';

package/src/resources/virtual-cross-connects.ts

@@ -119,7 +119,8 @@ export interface VirtualCrossConnectCreateResponse {
 
 export namespace VirtualCrossConnectCreateResponse {
   export interface Data
-    extends GlobalIPAssignmentsAPI.Record,
+    extends
+      GlobalIPAssignmentsAPI.Record,
       PublicInternetGatewaysAPI.NetworkInterface,
       PublicInternetGatewaysAPI.NetworkInterfaceRegion {
     /**
@@ -257,7 +258,8 @@ export interface VirtualCrossConnectRetrieveResponse {
 
 export namespace VirtualCrossConnectRetrieveResponse {
   export interface Data
-    extends GlobalIPAssignmentsAPI.Record,
+    extends
+      GlobalIPAssignmentsAPI.Record,
       PublicInternetGatewaysAPI.NetworkInterface,
       PublicInternetGatewaysAPI.NetworkInterfaceRegion {
     /**
@@ -395,7 +397,8 @@ export interface VirtualCrossConnectUpdateResponse {
 
 export namespace VirtualCrossConnectUpdateResponse {
   export interface Data
-    extends GlobalIPAssignmentsAPI.Record,
+    extends
+      GlobalIPAssignmentsAPI.Record,
       PublicInternetGatewaysAPI.NetworkInterface,
       PublicInternetGatewaysAPI.NetworkInterfaceRegion {
     /**
@@ -528,7 +531,8 @@ export namespace VirtualCrossConnectUpdateResponse {
 }
 
 export interface VirtualCrossConnectListResponse
-  extends GlobalIPAssignmentsAPI.Record,
+  extends
+    GlobalIPAssignmentsAPI.Record,
     PublicInternetGatewaysAPI.NetworkInterface,
     PublicInternetGatewaysAPI.NetworkInterfaceRegion {
   /**
@@ -665,7 +669,8 @@ export interface VirtualCrossConnectDeleteResponse {
 
 export namespace VirtualCrossConnectDeleteResponse {
   export interface Data
-    extends GlobalIPAssignmentsAPI.Record,
+    extends
+      GlobalIPAssignmentsAPI.Record,
       PublicInternetGatewaysAPI.NetworkInterface,
       PublicInternetGatewaysAPI.NetworkInterfaceRegion {
     /**

package/src/resources/webhooks.ts

@@ -4566,18 +4566,6 @@ export namespace ReplacedLinkClickWebhookEvent {
   }
 }
 
-export interface StreamingFailedWebhookEvent {
-  data?: CallStreamingFailed;
-}
-
-export interface StreamingStartedWebhookEvent {
-  data?: CallStreamingStarted;
-}
-
-export interface StreamingStoppedWebhookEvent {
-  data?: CallStreamingStopped;
-}
-
 export interface TranscriptionWebhookEvent {
   data?: TranscriptionWebhookEvent.Data;
 }
@@ -8994,18 +8982,6 @@ export namespace ReplacedLinkClickWebhookEvent {
   }
 }
 
-export interface StreamingFailedWebhookEvent {
-  data?: CallStreamingFailed;
-}
-
-export interface StreamingStartedWebhookEvent {
-  data?: CallStreamingStarted;
-}
-
-export interface StreamingStoppedWebhookEvent {
-  data?: CallStreamingStopped;
-}
-
 export interface TranscriptionWebhookEvent {
   data?: TranscriptionWebhookEvent.Data;
 }
@@ -9155,9 +9131,6 @@ export type UnsafeUnwrapWebhookEvent =
   | InboundMessageWebhookEvent
   | NumberOrderStatusUpdateWebhookEvent
   | ReplacedLinkClickWebhookEvent
-  | StreamingFailedWebhookEvent
-  | StreamingStartedWebhookEvent
-  | StreamingStoppedWebhookEvent
   | TranscriptionWebhookEvent;
 
 export type UnwrapWebhookEvent =
@@ -9220,9 +9193,6 @@ export type UnwrapWebhookEvent =
   | InboundMessageWebhookEvent
   | NumberOrderStatusUpdateWebhookEvent
   | ReplacedLinkClickWebhookEvent
-  | StreamingFailedWebhookEvent
-  | StreamingStartedWebhookEvent
-  | StreamingStoppedWebhookEvent
   | TranscriptionWebhookEvent;
 
 export declare namespace Webhooks {
@@ -9289,9 +9259,6 @@ export declare namespace Webhooks {
     type InboundMessageWebhookEvent as InboundMessageWebhookEvent,
     type NumberOrderStatusUpdateWebhookEvent as NumberOrderStatusUpdateWebhookEvent,
     type ReplacedLinkClickWebhookEvent as ReplacedLinkClickWebhookEvent,
-    type StreamingFailedWebhookEvent as StreamingFailedWebhookEvent,
-    type StreamingStartedWebhookEvent as StreamingStartedWebhookEvent,
-    type StreamingStoppedWebhookEvent as StreamingStoppedWebhookEvent,
     type TranscriptionWebhookEvent as TranscriptionWebhookEvent,
     type UnsafeUnwrapWebhookEvent as UnsafeUnwrapWebhookEvent,
     type UnwrapWebhookEvent as UnwrapWebhookEvent,

package/src/resources/wireguard-interfaces.ts

@@ -183,8 +183,7 @@ export namespace WireguardInterfaceRetrieveResponse {
 }
 
 export interface WireguardInterfaceListResponse
-  extends GlobalIPAssignmentsAPI.Record,
-    PublicInternetGatewaysAPI.NetworkInterface {
+  extends GlobalIPAssignmentsAPI.Record, PublicInternetGatewaysAPI.NetworkInterface {
   /**
    * Enable SIP traffic forwarding over VPN interface.
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.2.2'; // x-release-please-version
+export const VERSION = '5.4.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.2.2";
+export declare const VERSION = "5.4.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.2.2";
+export declare const VERSION = "5.4.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '5.2.2'; // x-release-please-version
+exports.VERSION = '5.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '5.2.2'; // x-release-please-version
+export const VERSION = '5.4.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map