telnyx 5.156.0 → 5.157.0

data/rbi/telnyx/models/storage/cloudf_list_response.rbi

@@ -0,0 +1,327 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class CloudfListResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Storage::CloudfListResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Telnyx::Models::Storage::CloudfListResponse::Data]
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              T::Array[
+                Telnyx::Models::Storage::CloudfListResponse::Data::OrHash
+              ]
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          returns(T.nilable(Telnyx::Models::Storage::CloudfListResponse::Meta))
+        end
+        attr_reader :meta
+
+        sig do
+          params(
+            meta: Telnyx::Models::Storage::CloudfListResponse::Meta::OrHash
+          ).void
+        end
+        attr_writer :meta
+
+        sig do
+          params(
+            data:
+              T::Array[
+                Telnyx::Models::Storage::CloudfListResponse::Data::OrHash
+              ],
+            meta: Telnyx::Models::Storage::CloudfListResponse::Meta::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil, meta: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T::Array[Telnyx::Models::Storage::CloudfListResponse::Data],
+              meta: Telnyx::Models::Storage::CloudfListResponse::Meta
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Storage::CloudfListResponse::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
+
+          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 in list results. Connection details
+          # (`meta_url`, `meta_token`) are omitted — retrieve the filesystem by ID for its
+          # redacted `meta_url`.
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              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,
+            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,
+                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
+
+        class Meta < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Storage::CloudfListResponse::Meta,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors
+              )
+            )
+          end
+          attr_reader :cursors
+
+          sig do
+            params(
+              cursors:
+                Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors::OrHash
+            ).void
+          end
+          attr_writer :cursors
+
+          # Relative URL (path and query) of the next page. Omitted when there are no
+          # further results.
+          sig { returns(T.nilable(String)) }
+          attr_reader :next_
+
+          sig { params(next_: String).void }
+          attr_writer :next_
+
+          # Relative URL (path and query) of the previous page. Omitted on the first page.
+          sig { returns(T.nilable(String)) }
+          attr_reader :previous
+
+          sig { params(previous: String).void }
+          attr_writer :previous
+
+          sig do
+            params(
+              cursors:
+                Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors::OrHash,
+              next_: String,
+              previous: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
+            cursors: nil,
+            # Relative URL (path and query) of the next page. Omitted when there are no
+            # further results.
+            next_: nil,
+            # Relative URL (path and query) of the previous page. Omitted on the first page.
+            previous: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                cursors:
+                  Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors,
+                next_: String,
+                previous: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Cursors < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Cursor for the next page; pass it as `page[after]`. Omitted on the last page.
+            sig { returns(T.nilable(String)) }
+            attr_reader :after
+
+            sig { params(after: String).void }
+            attr_writer :after
+
+            # Cursor for the previous page; pass it as `page[before]`. Omitted on the first
+            # page.
+            sig { returns(T.nilable(String)) }
+            attr_reader :before
+
+            sig { params(before: String).void }
+            attr_writer :before
+
+            # Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
+            sig do
+              params(after: String, before: String).returns(T.attached_class)
+            end
+            def self.new(
+              # Cursor for the next page; pass it as `page[after]`. Omitted on the last page.
+              after: nil,
+              # Cursor for the previous page; pass it as `page[before]`. Omitted on the first
+              # page.
+              before: nil
+            )
+            end
+
+            sig { override.returns({ after: String, before: String }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/cloudf_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class CloudfRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Storage::CloudfRetrieveParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/cloudf_update_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class CloudfUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Storage::CloudfUpdateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # New filesystem name, unique within your organization. Names are trimmed and
+        # lowercased; after normalization they may contain lowercase letters, numbers,
+        # `.`, `_`, and `-` only.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig do
+          params(
+            id: String,
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # New filesystem name, unique within your organization. Names are trimmed and
+          # lowercased; after normalization they may contain lowercase letters, numbers,
+          # `.`, `_`, and `-` only.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              name: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      module Cloudfs
+        class ActionRotateMetaTokenParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Storage::Cloudfs::ActionRotateMetaTokenParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :idempotency_key
+
+          sig do
+            params(
+              id: String,
+              idempotency_key: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(id:, idempotency_key:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                idempotency_key: String,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,229 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class CloudfsFilesystemDetailResponseWrapper < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # 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
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data
+            }
+          )
+        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
+end