telnyx 7.16.0 → 7.18.0

package/src/resources/storage/cloudfs/cloudfs.ts

@@ -1,10 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as CloudfsAPI from './cloudfs';
 import * as ActionsAPI from './actions';
 import { ActionRotateMetaTokenParams, Actions } from './actions';
 import { APIPromise } from '../../../core/api-promise';
+import {
+  CloudfsCursorPagination,
+  type CloudfsCursorPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
@@ -22,14 +26,20 @@ export class Cloudfs extends APIResource {
    *
    * @example
    * ```ts
-   * const cloudfs = await client.storage.cloudfs.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const cloudfListResponse of client.storage.cloudfs.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: CloudfListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CloudfListResponse> {
-    return this._client.get('/storage/cloudfs', { query, ...options });
+  ): PagePromise<CloudfListResponsesCloudfsCursorPagination, CloudfListResponse> {
+    return this._client.getAPIList('/storage/cloudfs', CloudfsCursorPagination<CloudfListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -122,135 +132,133 @@ export class Cloudfs extends APIResource {
   }
 }
 
-export interface CloudfsFilesystemDetailResponseWrapper {
+export type CloudfListResponsesCloudfsCursorPagination = CloudfsCursorPagination<CloudfListResponse>;
+
+/**
+ * A CloudFS filesystem, including its metadata credential. This shape is returned
+ * only by create and rotate-meta-token.
+ */
+export interface CloudfsFilesystem {
+  id?: string;
+
+  created_at?: string;
+
   /**
-   * A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits
-   * the credential and there is no `meta_token` field — the token is only returned
-   * by create and rotate-meta-token.
+   * Metadata access token, in cleartext. Returned only by create and
+   * rotate-meta-token and not retrievable afterwards — store it securely.
+   */
+  meta_token?: string;
+
+  /**
+   * PostgreSQL connection URL for the filesystem's metadata database. In create and
+   * rotate-meta-token responses it embeds the metadata token as the password:
+   * `postgres://<database>:<meta_token>@us-east-1.telnyxcloudfs.com:5432/<database>?sslmode=require`
+   * (the example below is shown without the credential; the actual response includes
+   * it). Pass it to `juicefs mount`: the storage configuration is baked in at
+   * provisioning, so the metadata URL is all a client needs to mount the filesystem.
+   */
+  meta_url?: string;
+
+  name?: string;
+
+  record_type?: string;
+
+  region?: string;
+
+  /**
+   * Name of the bucket that stores this filesystem's data. Created during
+   * provisioning.
+   */
+  s3_bucket?: string;
+
+  /**
+   * URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+   */
+  s3_endpoint?: string;
+
+  /**
+   * Lifecycle status of the filesystem. `ready` means it is fully provisioned and
+   * usable. `needs_format` means the storage bucket and metadata database were
+   * provisioned but the filesystem has not yet been formatted — run `juicefs format`
+   * with the filesystem's `meta_url` before mounting. `failed` means the last
+   * lifecycle action failed — see the filesystem's `error` message. `deleted`
+   * appears only in the delete response: deleted filesystems are excluded from list
+   * results and return a `404` on retrieval.
    */
-  data?: CloudfsFilesystemDetailResponseWrapper.Data;
+  status?: CloudfsFilesystemStatus;
+
+  updated_at?: string;
 }
 
-export namespace CloudfsFilesystemDetailResponseWrapper {
+/**
+ * A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits
+ * the credential and there is no `meta_token` field — the token is only returned
+ * by create and rotate-meta-token.
+ */
+export interface CloudfsFilesystemDetail {
+  id?: string;
+
+  created_at?: string;
+
   /**
-   * A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits
-   * the credential and there is no `meta_token` field — the token is only returned
-   * by create and rotate-meta-token.
+   * Explanation of the most recent failed lifecycle action. Present only when the
+   * filesystem is in a `failed` state.
    */
-  export interface Data {
-    id?: string;
-
-    created_at?: string;
-
-    /**
-     * Explanation of the most recent failed lifecycle action. Present only when the
-     * filesystem is in a `failed` state.
-     */
-    error?: string;
-
-    /**
-     * PostgreSQL connection URL for the filesystem's metadata database, without the
-     * credential. Combine it with your stored metadata token, or issue a new token
-     * with rotate-meta-token.
-     */
-    meta_url?: string;
-
-    name?: string;
-
-    record_type?: string;
-
-    region?: string;
-
-    /**
-     * Name of the bucket that stores this filesystem's data. Created during
-     * provisioning.
-     */
-    s3_bucket?: string;
-
-    /**
-     * URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-     */
-    s3_endpoint?: string;
-
-    /**
-     * Lifecycle status of the filesystem. `ready` means it is fully provisioned and
-     * usable. `needs_format` means the storage bucket and metadata database were
-     * provisioned but the filesystem has not yet been formatted — run `juicefs format`
-     * with the filesystem's `meta_url` before mounting. `failed` means the last
-     * lifecycle action failed — see the filesystem's `error` message. `deleted`
-     * appears only in the delete response: deleted filesystems are excluded from list
-     * results and return a `404` on retrieval.
-     */
-    status?: CloudfsAPI.CloudfsFilesystemStatus;
-
-    updated_at?: string;
-  }
+  error?: string;
+
+  /**
+   * PostgreSQL connection URL for the filesystem's metadata database, without the
+   * credential. Combine it with your stored metadata token, or issue a new token
+   * with rotate-meta-token.
+   */
+  meta_url?: string;
+
+  name?: string;
+
+  record_type?: string;
+
+  region?: string;
+
+  /**
+   * Name of the bucket that stores this filesystem's data. Created during
+   * provisioning.
+   */
+  s3_bucket?: string;
+
+  /**
+   * URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+   */
+  s3_endpoint?: string;
+
+  /**
+   * Lifecycle status of the filesystem. `ready` means it is fully provisioned and
+   * usable. `needs_format` means the storage bucket and metadata database were
+   * provisioned but the filesystem has not yet been formatted — run `juicefs format`
+   * with the filesystem's `meta_url` before mounting. `failed` means the last
+   * lifecycle action failed — see the filesystem's `error` message. `deleted`
+   * appears only in the delete response: deleted filesystems are excluded from list
+   * results and return a `404` on retrieval.
+   */
+  status?: CloudfsFilesystemStatus;
+
+  updated_at?: string;
 }
 
-export interface CloudfsFilesystemResponseWrapper {
+export interface CloudfsFilesystemDetailResponseWrapper {
   /**
-   * A CloudFS filesystem, including its metadata credential. This shape is returned
-   * only by create and rotate-meta-token.
+   * A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits
+   * the credential and there is no `meta_token` field — the token is only returned
+   * by create and rotate-meta-token.
    */
-  data?: CloudfsFilesystemResponseWrapper.Data;
+  data?: CloudfsFilesystemDetail;
 }
 
-export namespace CloudfsFilesystemResponseWrapper {
+export interface CloudfsFilesystemResponseWrapper {
   /**
    * A CloudFS filesystem, including its metadata credential. This shape is returned
    * only by create and rotate-meta-token.
    */
-  export interface Data {
-    id?: string;
-
-    created_at?: string;
-
-    /**
-     * Metadata access token, in cleartext. Returned only by create and
-     * rotate-meta-token and not retrievable afterwards — store it securely.
-     */
-    meta_token?: string;
-
-    /**
-     * PostgreSQL connection URL for the filesystem's metadata database. In create and
-     * rotate-meta-token responses it embeds the metadata token as the password:
-     * `postgres://<database>:<meta_token>@us-east-1.telnyxcloudfs.com:5432/<database>?sslmode=require`
-     * (the example below is shown without the credential; the actual response includes
-     * it). Pass it to `juicefs mount`: the storage configuration is baked in at
-     * provisioning, so the metadata URL is all a client needs to mount the filesystem.
-     */
-    meta_url?: string;
-
-    name?: string;
-
-    record_type?: string;
-
-    region?: string;
-
-    /**
-     * Name of the bucket that stores this filesystem's data. Created during
-     * provisioning.
-     */
-    s3_bucket?: string;
-
-    /**
-     * URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-     */
-    s3_endpoint?: string;
-
-    /**
-     * Lifecycle status of the filesystem. `ready` means it is fully provisioned and
-     * usable. `needs_format` means the storage bucket and metadata database were
-     * provisioned but the filesystem has not yet been formatted — run `juicefs format`
-     * with the filesystem's `meta_url` before mounting. `failed` means the last
-     * lifecycle action failed — see the filesystem's `error` message. `deleted`
-     * appears only in the delete response: deleted filesystems are excluded from list
-     * results and return a `404` on retrieval.
-     */
-    status?: CloudfsAPI.CloudfsFilesystemStatus;
-
-    updated_at?: string;
-  }
+  data?: CloudfsFilesystem;
 }
 
 /**
@@ -270,92 +278,48 @@ export type CloudfsFilesystemStatus =
   | 'failed'
   | 'deleted';
 
+/**
+ * A CloudFS filesystem as returned in list results. Connection details
+ * (`meta_url`, `meta_token`) are omitted — retrieve the filesystem by ID for its
+ * redacted `meta_url`.
+ */
 export interface CloudfListResponse {
-  data?: Array<CloudfListResponse.Data>;
+  id?: string;
 
-  meta?: CloudfListResponse.Meta;
-}
+  created_at?: string;
 
-export namespace CloudfListResponse {
-  /**
-   * A CloudFS filesystem as returned in list results. Connection details
-   * (`meta_url`, `meta_token`) are omitted — retrieve the filesystem by ID for its
-   * redacted `meta_url`.
-   */
-  export interface Data {
-    id?: string;
-
-    created_at?: string;
-
-    name?: string;
-
-    record_type?: string;
-
-    region?: string;
+  name?: string;
 
-    /**
-     * Name of the bucket that stores this filesystem's data. Created during
-     * provisioning.
-     */
-    s3_bucket?: string;
+  record_type?: string;
 
-    /**
-     * URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-     */
-    s3_endpoint?: string;
+  region?: string;
 
-    /**
-     * Lifecycle status of the filesystem. `ready` means it is fully provisioned and
-     * usable. `needs_format` means the storage bucket and metadata database were
-     * provisioned but the filesystem has not yet been formatted — run `juicefs format`
-     * with the filesystem's `meta_url` before mounting. `failed` means the last
-     * lifecycle action failed — see the filesystem's `error` message. `deleted`
-     * appears only in the delete response: deleted filesystems are excluded from list
-     * results and return a `404` on retrieval.
-     */
-    status?: CloudfsAPI.CloudfsFilesystemStatus;
+  /**
+   * Name of the bucket that stores this filesystem's data. Created during
+   * provisioning.
+   */
+  s3_bucket?: string;
 
-    updated_at?: string;
-  }
+  /**
+   * URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+   */
+  s3_endpoint?: string;
 
-  export interface Meta {
-    /**
-     * Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
-     */
-    cursors?: Meta.Cursors;
-
-    /**
-     * Relative URL (path and query) of the next page. Omitted when there are no
-     * further results.
-     */
-    next?: string;
-
-    /**
-     * Relative URL (path and query) of the previous page. Omitted on the first page.
-     */
-    previous?: string;
-  }
+  /**
+   * Lifecycle status of the filesystem. `ready` means it is fully provisioned and
+   * usable. `needs_format` means the storage bucket and metadata database were
+   * provisioned but the filesystem has not yet been formatted — run `juicefs format`
+   * with the filesystem's `meta_url` before mounting. `failed` means the last
+   * lifecycle action failed — see the filesystem's `error` message. `deleted`
+   * appears only in the delete response: deleted filesystems are excluded from list
+   * results and return a `404` on retrieval.
+   */
+  status?: CloudfsFilesystemStatus;
 
-  export namespace Meta {
-    /**
-     * Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
-     */
-    export interface Cursors {
-      /**
-       * Cursor for the next page; pass it as `page[after]`. Omitted on the last page.
-       */
-      after?: string;
-
-      /**
-       * Cursor for the previous page; pass it as `page[before]`. Omitted on the first
-       * page.
-       */
-      before?: string;
-    }
-  }
+  updated_at?: string;
 }
 
-export interface CloudfListParams {
+export interface CloudfListParams extends CloudfsCursorPaginationParams {
   /**
    * Return only the filesystem whose name matches exactly.
    */
@@ -371,24 +335,12 @@ export interface CloudfListParams {
    */
   'filter[status]'?: 'provisioning' | 'ready' | 'needs_format' | 'deleting' | 'failed';
 
-  /**
-   * Opaque cursor from a previous response's `meta.cursors.after`; returns the page
-   * after it. Mutually exclusive with `page[before]`.
-   */
-  'page[after]'?: string;
-
   /**
    * Opaque cursor from a previous response's `meta.cursors.before`; returns the page
    * before it. Mutually exclusive with `page[after]`.
    */
   'page[before]'?: string;
 
-  /**
-   * The number of filesystems to return per page. Values above 250 are treated
-   * as 250.
-   */
-  'page[limit]'?: number;
-
   /**
    * Sort order for the results: a field name for ascending, or the field name
    * prefixed with `-` for descending.
@@ -433,10 +385,13 @@ Cloudfs.Actions = Actions;
 
 export declare namespace Cloudfs {
   export {
+    type CloudfsFilesystem as CloudfsFilesystem,
+    type CloudfsFilesystemDetail as CloudfsFilesystemDetail,
     type CloudfsFilesystemDetailResponseWrapper as CloudfsFilesystemDetailResponseWrapper,
     type CloudfsFilesystemResponseWrapper as CloudfsFilesystemResponseWrapper,
     type CloudfsFilesystemStatus as CloudfsFilesystemStatus,
     type CloudfListResponse as CloudfListResponse,
+    type CloudfListResponsesCloudfsCursorPagination as CloudfListResponsesCloudfsCursorPagination,
     type CloudfListParams as CloudfListParams,
     type CloudfCreateParams as CloudfCreateParams,
     type CloudfUpdateParams as CloudfUpdateParams,

package/src/resources/storage/cloudfs/index.ts

@@ -3,6 +3,8 @@
 export { Actions, type ActionRotateMetaTokenParams } from './actions';
 export {
   Cloudfs,
+  type CloudfsFilesystem,
+  type CloudfsFilesystemDetail,
   type CloudfsFilesystemDetailResponseWrapper,
   type CloudfsFilesystemResponseWrapper,
   type CloudfsFilesystemStatus,
@@ -10,4 +12,5 @@ export {
   type CloudfListParams,
   type CloudfCreateParams,
   type CloudfUpdateParams,
+  type CloudfListResponsesCloudfsCursorPagination,
 } from './cloudfs';

package/src/resources/storage/index.ts

@@ -7,6 +7,8 @@ export {
 } from './buckets/index';
 export {
   Cloudfs,
+  type CloudfsFilesystem,
+  type CloudfsFilesystemDetail,
   type CloudfsFilesystemDetailResponseWrapper,
   type CloudfsFilesystemResponseWrapper,
   type CloudfsFilesystemStatus,
@@ -14,6 +16,7 @@ export {
   type CloudfListParams,
   type CloudfCreateParams,
   type CloudfUpdateParams,
+  type CloudfListResponsesCloudfsCursorPagination,
 } from './cloudfs/index';
 export {
   Kvs,

package/src/resources/storage/migrations/actions.ts

@@ -11,7 +11,8 @@ import { path } from '../../../internal/utils/path';
  */
 export class Actions extends APIResource {
   /**
-   * Stop an in-progress storage migration.
+   * Stops the specified in-progress storage migration and returns the updated
+   * migration.
    *
    * @example
    * ```ts

package/src/resources/storage/storage.ts

@@ -19,8 +19,11 @@ import {
   CloudfCreateParams,
   CloudfListParams,
   CloudfListResponse,
+  CloudfListResponsesCloudfsCursorPagination,
   CloudfUpdateParams,
   Cloudfs,
+  CloudfsFilesystem,
+  CloudfsFilesystemDetail,
   CloudfsFilesystemDetailResponseWrapper,
   CloudfsFilesystemResponseWrapper,
   CloudfsFilesystemStatus,
@@ -153,10 +156,13 @@ export declare namespace Storage {
 
   export {
     Cloudfs as Cloudfs,
+    type CloudfsFilesystem as CloudfsFilesystem,
+    type CloudfsFilesystemDetail as CloudfsFilesystemDetail,
     type CloudfsFilesystemDetailResponseWrapper as CloudfsFilesystemDetailResponseWrapper,
     type CloudfsFilesystemResponseWrapper as CloudfsFilesystemResponseWrapper,
     type CloudfsFilesystemStatus as CloudfsFilesystemStatus,
     type CloudfListResponse as CloudfListResponse,
+    type CloudfListResponsesCloudfsCursorPagination as CloudfListResponsesCloudfsCursorPagination,
     type CloudfListParams as CloudfListParams,
     type CloudfCreateParams as CloudfCreateParams,
     type CloudfUpdateParams as CloudfUpdateParams,