telnyx 5.162.0 → 5.164.0

data/rbi/telnyx/models/storage/cloudfs_filesystem.rbi

@@ -0,0 +1,176 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class CloudfsFilesystem < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Storage::CloudfsFilesystem, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Metadata access token, in cleartext. Returned only by create and
+        # rotate-meta-token and not retrievable afterwards — store it securely.
+        sig { returns(T.nilable(String)) }
+        attr_reader :meta_token
+
+        sig { params(meta_token: String).void }
+        attr_writer :meta_token
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :meta_url
+
+        sig { params(meta_url: String).void }
+        attr_writer :meta_url
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :region
+
+        sig { params(region: String).void }
+        attr_writer :region
+
+        # Name of the bucket that stores this filesystem's data. Created during
+        # provisioning.
+        sig { returns(T.nilable(String)) }
+        attr_reader :s3_bucket
+
+        sig { params(s3_bucket: String).void }
+        attr_writer :s3_bucket
+
+        # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+        sig { returns(T.nilable(String)) }
+        attr_reader :s3_endpoint
+
+        sig { params(s3_endpoint: String).void }
+        attr_writer :s3_endpoint
+
+        # 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.
+        sig do
+          returns(
+            T.nilable(Telnyx::Storage::CloudfsFilesystemStatus::TaggedSymbol)
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status: Telnyx::Storage::CloudfsFilesystemStatus::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: Time).void }
+        attr_writer :updated_at
+
+        # A CloudFS filesystem, including its metadata credential. This shape is returned
+        # only by create and rotate-meta-token.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            meta_token: String,
+            meta_url: String,
+            name: String,
+            record_type: String,
+            region: String,
+            s3_bucket: String,
+            s3_endpoint: String,
+            status: Telnyx::Storage::CloudfsFilesystemStatus::OrSymbol,
+            updated_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          created_at: nil,
+          # Metadata access token, in cleartext. Returned only by create and
+          # rotate-meta-token and not retrievable afterwards — store it securely.
+          meta_token: nil,
+          # 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: nil,
+          name: nil,
+          record_type: nil,
+          region: nil,
+          # Name of the bucket that stores this filesystem's data. Created during
+          # provisioning.
+          s3_bucket: nil,
+          # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+          s3_endpoint: nil,
+          # 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: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              meta_token: String,
+              meta_url: String,
+              name: String,
+              record_type: String,
+              region: String,
+              s3_bucket: String,
+              s3_endpoint: String,
+              status: Telnyx::Storage::CloudfsFilesystemStatus::TaggedSymbol,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/cloudfs_filesystem_detail.rbi

@@ -0,0 +1,174 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class CloudfsFilesystemDetail < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Storage::CloudfsFilesystemDetail,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Explanation of the most recent failed lifecycle action. Present only when the
+        # filesystem is in a `failed` state.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error
+
+        sig { params(error: String).void }
+        attr_writer :error
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :meta_url
+
+        sig { params(meta_url: String).void }
+        attr_writer :meta_url
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :region
+
+        sig { params(region: String).void }
+        attr_writer :region
+
+        # Name of the bucket that stores this filesystem's data. Created during
+        # provisioning.
+        sig { returns(T.nilable(String)) }
+        attr_reader :s3_bucket
+
+        sig { params(s3_bucket: String).void }
+        attr_writer :s3_bucket
+
+        # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+        sig { returns(T.nilable(String)) }
+        attr_reader :s3_endpoint
+
+        sig { params(s3_endpoint: String).void }
+        attr_writer :s3_endpoint
+
+        # 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.
+        sig do
+          returns(
+            T.nilable(Telnyx::Storage::CloudfsFilesystemStatus::TaggedSymbol)
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status: Telnyx::Storage::CloudfsFilesystemStatus::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: Time).void }
+        attr_writer :updated_at
+
+        # 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.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            error: String,
+            meta_url: String,
+            name: String,
+            record_type: String,
+            region: String,
+            s3_bucket: String,
+            s3_endpoint: String,
+            status: Telnyx::Storage::CloudfsFilesystemStatus::OrSymbol,
+            updated_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          created_at: nil,
+          # Explanation of the most recent failed lifecycle action. Present only when the
+          # filesystem is in a `failed` state.
+          error: nil,
+          # 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: nil,
+          name: nil,
+          record_type: nil,
+          region: nil,
+          # Name of the bucket that stores this filesystem's data. Created during
+          # provisioning.
+          s3_bucket: nil,
+          # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+          s3_endpoint: nil,
+          # 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: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              error: String,
+              meta_url: String,
+              name: String,
+              record_type: String,
+              region: String,
+              s3_bucket: String,
+              s3_endpoint: String,
+              status: Telnyx::Storage::CloudfsFilesystemStatus::TaggedSymbol,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi

@@ -15,27 +15,17 @@ module Telnyx
         # 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.
-        sig do
-          returns(
-            T.nilable(
-              Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data
-            )
-          )
-        end
+        sig { returns(T.nilable(Telnyx::Storage::CloudfsFilesystemDetail)) }
         attr_reader :data
 
         sig do
-          params(
-            data:
-              Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data::OrHash
-          ).void
+          params(data: Telnyx::Storage::CloudfsFilesystemDetail::OrHash).void
         end
         attr_writer :data
 
         sig do
           params(
-            data:
-              Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data::OrHash
+            data: Telnyx::Storage::CloudfsFilesystemDetail::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -47,182 +37,10 @@ module Telnyx
         end
 
         sig do
-          override.returns(
-            {
-              data:
-                Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data
-            }
-          )
+          override.returns({ data: Telnyx::Storage::CloudfsFilesystemDetail })
         end
         def to_hash
         end
-
-        class Data < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          sig { returns(T.nilable(Time)) }
-          attr_reader :created_at
-
-          sig { params(created_at: Time).void }
-          attr_writer :created_at
-
-          # Explanation of the most recent failed lifecycle action. Present only when the
-          # filesystem is in a `failed` state.
-          sig { returns(T.nilable(String)) }
-          attr_reader :error
-
-          sig { params(error: String).void }
-          attr_writer :error
-
-          # 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.
-          sig { returns(T.nilable(String)) }
-          attr_reader :meta_url
-
-          sig { params(meta_url: String).void }
-          attr_writer :meta_url
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
-
-          sig { params(name: String).void }
-          attr_writer :name
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :record_type
-
-          sig { params(record_type: String).void }
-          attr_writer :record_type
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :region
-
-          sig { params(region: String).void }
-          attr_writer :region
-
-          # Name of the bucket that stores this filesystem's data. Created during
-          # provisioning.
-          sig { returns(T.nilable(String)) }
-          attr_reader :s3_bucket
-
-          sig { params(s3_bucket: String).void }
-          attr_writer :s3_bucket
-
-          # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-          sig { returns(T.nilable(String)) }
-          attr_reader :s3_endpoint
-
-          sig { params(s3_endpoint: String).void }
-          attr_writer :s3_endpoint
-
-          # 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.
-          sig do
-            returns(
-              T.nilable(Telnyx::Storage::CloudfsFilesystemStatus::TaggedSymbol)
-            )
-          end
-          attr_reader :status
-
-          sig do
-            params(
-              status: Telnyx::Storage::CloudfsFilesystemStatus::OrSymbol
-            ).void
-          end
-          attr_writer :status
-
-          sig { returns(T.nilable(Time)) }
-          attr_reader :updated_at
-
-          sig { params(updated_at: Time).void }
-          attr_writer :updated_at
-
-          # 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.
-          sig do
-            params(
-              id: String,
-              created_at: Time,
-              error: String,
-              meta_url: String,
-              name: String,
-              record_type: String,
-              region: String,
-              s3_bucket: String,
-              s3_endpoint: String,
-              status: Telnyx::Storage::CloudfsFilesystemStatus::OrSymbol,
-              updated_at: Time
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            id: nil,
-            created_at: nil,
-            # Explanation of the most recent failed lifecycle action. Present only when the
-            # filesystem is in a `failed` state.
-            error: nil,
-            # 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: nil,
-            name: nil,
-            record_type: nil,
-            region: nil,
-            # Name of the bucket that stores this filesystem's data. Created during
-            # provisioning.
-            s3_bucket: nil,
-            # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-            s3_endpoint: nil,
-            # 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: nil,
-            updated_at: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                created_at: Time,
-                error: String,
-                meta_url: String,
-                name: String,
-                record_type: String,
-                region: String,
-                s3_bucket: String,
-                s3_endpoint: String,
-                status: Telnyx::Storage::CloudfsFilesystemStatus::TaggedSymbol,
-                updated_at: Time
-              }
-            )
-          end
-          def to_hash
-          end
-        end
       end
     end
   end