telnyx 5.155.0 → 5.157.0

data/lib/telnyx/models/storage/cloudf_create_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Cloudfs#create
+      class CloudfCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute name
+        #   Filesystem name, unique within your organization. Names are trimmed and
+        #   lowercased; after normalization they may contain lowercase letters, numbers,
+        #   `.`, `_`, and `-` only.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute region
+        #   Region where the filesystem's storage and metadata are provisioned.
+        #
+        #   @return [Symbol, Telnyx::Models::Storage::CloudfCreateParams::Region]
+        required :region, enum: -> { Telnyx::Storage::CloudfCreateParams::Region }
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String]
+        required :idempotency_key, String
+
+        # @!method initialize(name:, region:, idempotency_key:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Storage::CloudfCreateParams} for more details.
+        #
+        #   @param name [String] Filesystem name, unique within your organization. Names are trimmed and lowercas
+        #
+        #   @param region [Symbol, Telnyx::Models::Storage::CloudfCreateParams::Region] Region where the filesystem's storage and metadata are provisioned.
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Region where the filesystem's storage and metadata are provisioned.
+        module Region
+          extend Telnyx::Internal::Type::Enum
+
+          US_CENTRAL_1 = :"us-central-1"
+          US_EAST_1 = :"us-east-1"
+          US_WEST_1 = :"us-west-1"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudf_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Cloudfs#delete
+      class CloudfDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudf_list_params.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Cloudfs#list
+      class CloudfListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute filter_name
+        #   Return only the filesystem whose name matches exactly.
+        #
+        #   @return [String, nil]
+        optional :filter_name, String
+
+        # @!attribute filter_region
+        #   Return only filesystems in this region.
+        #
+        #   @return [String, nil]
+        optional :filter_region, String
+
+        # @!attribute filter_status
+        #   Return only filesystems with this status. Unrecognized values are ignored.
+        #
+        #   @return [Symbol, Telnyx::Models::Storage::CloudfListParams::FilterStatus, nil]
+        optional :filter_status, enum: -> { Telnyx::Storage::CloudfListParams::FilterStatus }
+
+        # @!attribute page_after
+        #   Opaque cursor from a previous response's `meta.cursors.after`; returns the page
+        #   after it. Mutually exclusive with `page[before]`.
+        #
+        #   @return [String, nil]
+        optional :page_after, String
+
+        # @!attribute page_before
+        #   Opaque cursor from a previous response's `meta.cursors.before`; returns the page
+        #   before it. Mutually exclusive with `page[after]`.
+        #
+        #   @return [String, nil]
+        optional :page_before, String
+
+        # @!attribute page_limit
+        #   The number of filesystems to return per page. Values above 250 are treated
+        #   as 250.
+        #
+        #   @return [Integer, nil]
+        optional :page_limit, Integer
+
+        # @!attribute sort
+        #   Sort order for the results: a field name for ascending, or the field name
+        #   prefixed with `-` for descending.
+        #
+        #   @return [Symbol, Telnyx::Models::Storage::CloudfListParams::Sort, nil]
+        optional :sort, enum: -> { Telnyx::Storage::CloudfListParams::Sort }
+
+        # @!method initialize(filter_name: nil, filter_region: nil, filter_status: nil, page_after: nil, page_before: nil, page_limit: nil, sort: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Storage::CloudfListParams} for more details.
+        #
+        #   @param filter_name [String] Return only the filesystem whose name matches exactly.
+        #
+        #   @param filter_region [String] Return only filesystems in this region.
+        #
+        #   @param filter_status [Symbol, Telnyx::Models::Storage::CloudfListParams::FilterStatus] Return only filesystems with this status. Unrecognized values are ignored.
+        #
+        #   @param page_after [String] Opaque cursor from a previous response's `meta.cursors.after`; returns the page
+        #
+        #   @param page_before [String] Opaque cursor from a previous response's `meta.cursors.before`; returns the page
+        #
+        #   @param page_limit [Integer] The number of filesystems to return per page. Values above 250 are treated as 25
+        #
+        #   @param sort [Symbol, Telnyx::Models::Storage::CloudfListParams::Sort] Sort order for the results: a field name for ascending, or the field name prefix
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Return only filesystems with this status. Unrecognized values are ignored.
+        module FilterStatus
+          extend Telnyx::Internal::Type::Enum
+
+          PROVISIONING = :provisioning
+          READY = :ready
+          NEEDS_FORMAT = :needs_format
+          DELETING = :deleting
+          FAILED = :failed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Sort order for the results: a field name for ascending, or the field name
+        # prefixed with `-` for descending.
+        module Sort
+          extend Telnyx::Internal::Type::Enum
+
+          CREATED_AT = :created_at
+          CREATED_AT_DESC = :"-created_at"
+          UPDATED_AT = :updated_at
+          UPDATED_AT_DESC = :"-updated_at"
+          NAME = :name
+          NAME_DESC = :"-name"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudf_list_response.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Cloudfs#list
+      class CloudfListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::Storage::CloudfListResponse::Data>, nil]
+        optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Storage::CloudfListResponse::Data] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::Storage::CloudfListResponse::Meta, nil]
+        optional :meta, -> { Telnyx::Models::Storage::CloudfListResponse::Meta }
+
+        # @!method initialize(data: nil, meta: nil)
+        #   @param data [Array<Telnyx::Models::Storage::CloudfListResponse::Data>]
+        #   @param meta [Telnyx::Models::Storage::CloudfListResponse::Meta]
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute record_type
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+
+          # @!attribute region
+          #
+          #   @return [String, nil]
+          optional :region, String
+
+          # @!attribute s3_bucket
+          #   Name of the bucket that stores this filesystem's data. Created during
+          #   provisioning.
+          #
+          #   @return [String, nil]
+          optional :s3_bucket, String
+
+          # @!attribute s3_endpoint
+          #   URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+          #
+          #   @return [String, nil]
+          optional :s3_endpoint, String
+
+          # @!attribute status
+          #   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.
+          #
+          #   @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
+          optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
+
+          # @!attribute updated_at
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(id: nil, created_at: nil, name: nil, record_type: nil, region: nil, s3_bucket: nil, s3_endpoint: nil, status: nil, updated_at: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Storage::CloudfListResponse::Data} for more details.
+          #
+          #   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`.
+          #
+          #   @param id [String]
+          #
+          #   @param created_at [Time]
+          #
+          #   @param name [String]
+          #
+          #   @param record_type [String]
+          #
+          #   @param region [String]
+          #
+          #   @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
+          #
+          #   @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+          #
+          #   @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
+          #
+          #   @param updated_at [Time]
+        end
+
+        # @see Telnyx::Models::Storage::CloudfListResponse#meta
+        class Meta < Telnyx::Internal::Type::BaseModel
+          # @!attribute cursors
+          #   Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
+          #
+          #   @return [Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors, nil]
+          optional :cursors, -> { Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors }
+
+          # @!attribute next_
+          #   Relative URL (path and query) of the next page. Omitted when there are no
+          #   further results.
+          #
+          #   @return [String, nil]
+          optional :next_, String, api_name: :next
+
+          # @!attribute previous
+          #   Relative URL (path and query) of the previous page. Omitted on the first page.
+          #
+          #   @return [String, nil]
+          optional :previous, String
+
+          # @!method initialize(cursors: nil, next_: nil, previous: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Storage::CloudfListResponse::Meta} for more details.
+          #
+          #   @param cursors [Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors] Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
+          #
+          #   @param next_ [String] Relative URL (path and query) of the next page. Omitted when there are no furthe
+          #
+          #   @param previous [String] Relative URL (path and query) of the previous page. Omitted on the first page.
+
+          # @see Telnyx::Models::Storage::CloudfListResponse::Meta#cursors
+          class Cursors < Telnyx::Internal::Type::BaseModel
+            # @!attribute after
+            #   Cursor for the next page; pass it as `page[after]`. Omitted on the last page.
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute before
+            #   Cursor for the previous page; pass it as `page[before]`. Omitted on the first
+            #   page.
+            #
+            #   @return [String, nil]
+            optional :before, String
+
+            # @!method initialize(after: nil, before: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors} for more details.
+            #
+            #   Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
+            #
+            #   @param after [String] Cursor for the next page; pass it as `page[after]`. Omitted on the last page.
+            #
+            #   @param before [String] Cursor for the previous page; pass it as `page[before]`. Omitted on the first pa
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudf_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Cloudfs#retrieve
+      class CloudfRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudf_update_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Cloudfs#update
+      class CloudfUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   New filesystem name, unique within your organization. Names are trimmed and
+        #   lowercased; after normalization they may contain lowercase letters, numbers,
+        #   `.`, `_`, and `-` only.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(id:, name: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Storage::CloudfUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param name [String] New filesystem name, unique within your organization. Names are trimmed and lowe
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      module Cloudfs
+        # @see Telnyx::Resources::Storage::Cloudfs::Actions#rotate_meta_token
+        class ActionRotateMetaTokenParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String]
+          required :idempotency_key, String
+
+          # @!method initialize(id:, idempotency_key:, request_options: {})
+          #   @param id [String]
+          #   @param idempotency_key [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      # @see Telnyx::Resources::Storage::Cloudfs#retrieve
+      class CloudfsFilesystemDetailResponseWrapper < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   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.
+        #
+        #   @return [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data, nil]
+        optional :data, -> { Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data }
+
+        # @!method initialize(data: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper} for more
+        #   details.
+        #
+        #   @param data [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data] A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits th
+
+        # @see Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute error
+          #   Explanation of the most recent failed lifecycle action. Present only when the
+          #   filesystem is in a `failed` state.
+          #
+          #   @return [String, nil]
+          optional :error, String
+
+          # @!attribute meta_url
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :meta_url, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute record_type
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+
+          # @!attribute region
+          #
+          #   @return [String, nil]
+          optional :region, String
+
+          # @!attribute s3_bucket
+          #   Name of the bucket that stores this filesystem's data. Created during
+          #   provisioning.
+          #
+          #   @return [String, nil]
+          optional :s3_bucket, String
+
+          # @!attribute s3_endpoint
+          #   URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+          #
+          #   @return [String, nil]
+          optional :s3_endpoint, String
+
+          # @!attribute status
+          #   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.
+          #
+          #   @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
+          optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
+
+          # @!attribute updated_at
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(id: nil, created_at: nil, error: nil, meta_url: nil, name: nil, record_type: nil, region: nil, s3_bucket: nil, s3_endpoint: nil, status: nil, updated_at: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data} for more
+          #   details.
+          #
+          #   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.
+          #
+          #   @param id [String]
+          #
+          #   @param created_at [Time]
+          #
+          #   @param error [String] Explanation of the most recent failed lifecycle action. Present only when the fi
+          #
+          #   @param meta_url [String] PostgreSQL connection URL for the filesystem's metadata database, without the cr
+          #
+          #   @param name [String]
+          #
+          #   @param record_type [String]
+          #
+          #   @param region [String]
+          #
+          #   @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
+          #
+          #   @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+          #
+          #   @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
+          #
+          #   @param updated_at [Time]
+        end
+      end
+    end
+  end
+end