telnyx 5.156.0 → 5.157.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +209 -0
  5. data/lib/telnyx/models/ai/anthropic/v1_messages_response.rb +12 -0
  6. data/lib/telnyx/models/ai/assistant_create_params.rb +2 -2
  7. data/lib/telnyx/models/ai/assistant_tool.rb +25 -1
  8. data/lib/telnyx/models/ai/assistant_update_params.rb +2 -2
  9. data/lib/telnyx/models/ai/assistants/update_assistant.rb +2 -2
  10. data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rb +103 -0
  11. data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rb +54 -0
  12. data/lib/telnyx/models/ai/inference_embedding.rb +6 -6
  13. data/lib/telnyx/models/ai/pay_tool_params.rb +46 -0
  14. data/lib/telnyx/models/ai/tool_create_params.rb +7 -1
  15. data/lib/telnyx/models/ai/tool_update_params.rb +7 -1
  16. data/lib/telnyx/models/ai/transcription_settings.rb +3 -3
  17. data/lib/telnyx/models/call_dial_params.rb +13 -1
  18. data/lib/telnyx/models/calls/transcription_config.rb +8 -4
  19. data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -1
  20. data/lib/telnyx/models/doc_reqs_requirement.rb +29 -4
  21. data/lib/telnyx/models/inbound_message.rb +278 -28
  22. data/lib/telnyx/models/inbound_message_webhook_event.rb +70 -3
  23. data/lib/telnyx/models/managed_account_list_params.rb +45 -3
  24. data/lib/telnyx/models/requirement_list_params.rb +10 -1
  25. data/lib/telnyx/models/requirement_retrieve_params.rb +14 -1
  26. data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -1
  27. data/lib/telnyx/models/storage/cloudf_create_params.rb +56 -0
  28. data/lib/telnyx/models/storage/cloudf_delete_params.rb +22 -0
  29. data/lib/telnyx/models/storage/cloudf_list_params.rb +109 -0
  30. data/lib/telnyx/models/storage/cloudf_list_response.rb +165 -0
  31. data/lib/telnyx/models/storage/cloudf_retrieve_params.rb +22 -0
  32. data/lib/telnyx/models/storage/cloudf_update_params.rb +36 -0
  33. data/lib/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rb +30 -0
  34. data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb +129 -0
  35. data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb +129 -0
  36. data/lib/telnyx/models/storage/cloudfs_filesystem_status.rb +28 -0
  37. data/lib/telnyx/models/verify_profile.rb +2 -2
  38. data/lib/telnyx/models/verify_profile_create_params.rb +2 -2
  39. data/lib/telnyx/models/verify_profile_update_params.rb +2 -2
  40. data/lib/telnyx/resources/ai/anthropic/v1.rb +91 -0
  41. data/lib/telnyx/resources/ai/anthropic.rb +20 -0
  42. data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
  43. data/lib/telnyx/resources/ai/assistants.rb +2 -2
  44. data/lib/telnyx/resources/ai/conversations/conversation_insights.rb +55 -0
  45. data/lib/telnyx/resources/ai/conversations.rb +5 -0
  46. data/lib/telnyx/resources/ai/tools.rb +5 -2
  47. data/lib/telnyx/resources/ai.rb +4 -0
  48. data/lib/telnyx/resources/calls.rb +3 -1
  49. data/lib/telnyx/resources/requirements.rb +13 -3
  50. data/lib/telnyx/resources/storage/cloudfs/actions.rb +54 -0
  51. data/lib/telnyx/resources/storage/cloudfs.rb +187 -0
  52. data/lib/telnyx/resources/storage.rb +6 -0
  53. data/lib/telnyx/version.rb +1 -1
  54. data/lib/telnyx.rb +20 -0
  55. data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +314 -0
  56. data/rbi/telnyx/models/ai/anthropic/v1_messages_response.rbi +15 -0
  57. data/rbi/telnyx/models/ai/assistant_create_params.rbi +8 -4
  58. data/rbi/telnyx/models/ai/assistant_tool.rbi +37 -1
  59. data/rbi/telnyx/models/ai/assistant_update_params.rbi +8 -4
  60. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +8 -4
  61. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbi +188 -0
  62. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbi +94 -0
  63. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -6
  64. data/rbi/telnyx/models/ai/pay_tool_params.rbi +71 -0
  65. data/rbi/telnyx/models/ai/tool_create_params.rbi +9 -0
  66. data/rbi/telnyx/models/ai/tool_update_params.rbi +9 -0
  67. data/rbi/telnyx/models/ai/transcription_settings.rbi +5 -5
  68. data/rbi/telnyx/models/call_dial_params.rbi +19 -0
  69. data/rbi/telnyx/models/calls/transcription_config.rbi +15 -7
  70. data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +2 -2
  71. data/rbi/telnyx/models/doc_reqs_requirement.rbi +38 -9
  72. data/rbi/telnyx/models/inbound_message.rbi +324 -58
  73. data/rbi/telnyx/models/inbound_message_webhook_event.rbi +173 -4
  74. data/rbi/telnyx/models/managed_account_list_params.rbi +130 -6
  75. data/rbi/telnyx/models/requirement_list_params.rbi +13 -0
  76. data/rbi/telnyx/models/requirement_retrieve_params.rbi +21 -2
  77. data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +2 -2
  78. data/rbi/telnyx/models/storage/cloudf_create_params.rbi +103 -0
  79. data/rbi/telnyx/models/storage/cloudf_delete_params.rbi +40 -0
  80. data/rbi/telnyx/models/storage/cloudf_list_params.rbi +232 -0
  81. data/rbi/telnyx/models/storage/cloudf_list_response.rbi +327 -0
  82. data/rbi/telnyx/models/storage/cloudf_retrieve_params.rbi +40 -0
  83. data/rbi/telnyx/models/storage/cloudf_update_params.rbi +61 -0
  84. data/rbi/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbi +50 -0
  85. data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi +229 -0
  86. data/rbi/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbi +227 -0
  87. data/rbi/telnyx/models/storage/cloudfs_filesystem_status.rbi +57 -0
  88. data/rbi/telnyx/models/verify_profile.rbi +2 -2
  89. data/rbi/telnyx/models/verify_profile_create_params.rbi +2 -2
  90. data/rbi/telnyx/models/verify_profile_update_params.rbi +2 -2
  91. data/rbi/telnyx/resources/ai/anthropic/v1.rbi +106 -0
  92. data/rbi/telnyx/resources/ai/anthropic.rbi +17 -0
  93. data/rbi/telnyx/resources/ai/assistants/versions.rbi +2 -1
  94. data/rbi/telnyx/resources/ai/assistants.rbi +4 -2
  95. data/rbi/telnyx/resources/ai/conversations/conversation_insights.rbi +68 -0
  96. data/rbi/telnyx/resources/ai/conversations.rbi +6 -0
  97. data/rbi/telnyx/resources/ai/tools.rbi +4 -0
  98. data/rbi/telnyx/resources/ai.rbi +3 -0
  99. data/rbi/telnyx/resources/calls.rbi +7 -0
  100. data/rbi/telnyx/resources/managed_accounts.rbi +1 -1
  101. data/rbi/telnyx/resources/requirements.rbi +8 -0
  102. data/rbi/telnyx/resources/storage/cloudfs/actions.rbi +46 -0
  103. data/rbi/telnyx/resources/storage/cloudfs.rbi +152 -0
  104. data/rbi/telnyx/resources/storage.rbi +5 -0
  105. data/sig/telnyx/models/ai/anthropic/v1_messages_params.rbs +175 -0
  106. data/sig/telnyx/models/ai/anthropic/v1_messages_response.rbs +11 -0
  107. data/sig/telnyx/models/ai/assistant_tool.rbs +13 -0
  108. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbs +74 -0
  109. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbs +34 -0
  110. data/sig/telnyx/models/ai/pay_tool_params.rbs +41 -0
  111. data/sig/telnyx/models/ai/tool_create_params.rbs +7 -0
  112. data/sig/telnyx/models/ai/tool_update_params.rbs +7 -0
  113. data/sig/telnyx/models/ai/transcription_settings.rbs +2 -2
  114. data/sig/telnyx/models/call_dial_params.rbs +7 -0
  115. data/sig/telnyx/models/calls/transcription_config.rbs +2 -2
  116. data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +2 -2
  117. data/sig/telnyx/models/doc_reqs_requirement.rbs +25 -8
  118. data/sig/telnyx/models/inbound_message.rbs +204 -35
  119. data/sig/telnyx/models/inbound_message_webhook_event.rbs +81 -5
  120. data/sig/telnyx/models/managed_account_list_params.rbs +47 -3
  121. data/sig/telnyx/models/requirement_list_params.rbs +8 -1
  122. data/sig/telnyx/models/requirement_retrieve_params.rbs +12 -2
  123. data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -2
  124. data/sig/telnyx/models/storage/cloudf_create_params.rbs +50 -0
  125. data/sig/telnyx/models/storage/cloudf_delete_params.rbs +22 -0
  126. data/sig/telnyx/models/storage/cloudf_list_params.rbs +112 -0
  127. data/sig/telnyx/models/storage/cloudf_list_response.rbs +163 -0
  128. data/sig/telnyx/models/storage/cloudf_retrieve_params.rbs +22 -0
  129. data/sig/telnyx/models/storage/cloudf_update_params.rbs +32 -0
  130. data/sig/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbs +32 -0
  131. data/sig/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbs +115 -0
  132. data/sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs +115 -0
  133. data/sig/telnyx/models/storage/cloudfs_filesystem_status.rbs +21 -0
  134. data/sig/telnyx/resources/ai/anthropic/v1.rbs +35 -0
  135. data/sig/telnyx/resources/ai/anthropic.rbs +11 -0
  136. data/sig/telnyx/resources/ai/conversations/conversation_insights.rbs +20 -0
  137. data/sig/telnyx/resources/ai/conversations.rbs +2 -0
  138. data/sig/telnyx/resources/ai/tools.rbs +2 -0
  139. data/sig/telnyx/resources/ai.rbs +2 -0
  140. data/sig/telnyx/resources/calls.rbs +1 -0
  141. data/sig/telnyx/resources/requirements.rbs +2 -0
  142. data/sig/telnyx/resources/storage/cloudfs/actions.rbs +17 -0
  143. data/sig/telnyx/resources/storage/cloudfs.rbs +45 -0
  144. data/sig/telnyx/resources/storage.rbs +2 -0
  145. metadata +62 -2
@@ -10,7 +10,7 @@ module Telnyx
10
10
  # @!attribute filter
11
11
  # Consolidated filter parameter (deepObject style). Originally:
12
12
  # filter[email][contains], filter[email][eq], filter[organization_name][contains],
13
- # filter[organization_name][eq]
13
+ # filter[organization_name][eq], filter[status][eq]
14
14
  #
15
15
  # @return [Telnyx::Models::ManagedAccountListParams::Filter, nil]
16
16
  optional :filter, -> { Telnyx::ManagedAccountListParams::Filter }
@@ -77,13 +77,19 @@ module Telnyx
77
77
  # @return [Telnyx::Models::ManagedAccountListParams::Filter::OrganizationName, nil]
78
78
  optional :organization_name, -> { Telnyx::ManagedAccountListParams::Filter::OrganizationName }
79
79
 
80
- # @!method initialize(email: nil, organization_name: nil)
80
+ # @!attribute status
81
+ #
82
+ # @return [Telnyx::Models::ManagedAccountListParams::Filter::Status, nil]
83
+ optional :status, -> { Telnyx::ManagedAccountListParams::Filter::Status }
84
+
85
+ # @!method initialize(email: nil, organization_name: nil, status: nil)
81
86
  # Consolidated filter parameter (deepObject style). Originally:
82
87
  # filter[email][contains], filter[email][eq], filter[organization_name][contains],
83
- # filter[organization_name][eq]
88
+ # filter[organization_name][eq], filter[status][eq]
84
89
  #
85
90
  # @param email [Telnyx::Models::ManagedAccountListParams::Filter::Email]
86
91
  # @param organization_name [Telnyx::Models::ManagedAccountListParams::Filter::OrganizationName]
92
+ # @param status [Telnyx::Models::ManagedAccountListParams::Filter::Status]
87
93
 
88
94
  # @see Telnyx::Models::ManagedAccountListParams::Filter#email
89
95
  class Email < Telnyx::Internal::Type::BaseModel
@@ -136,6 +142,42 @@ module Telnyx
136
142
  #
137
143
  # @param eq [String] If present, only returns results with the <code>organization_name</code> matchin
138
144
  end
145
+
146
+ # @see Telnyx::Models::ManagedAccountListParams::Filter#status
147
+ class Status < Telnyx::Internal::Type::BaseModel
148
+ # @!attribute eq
149
+ # If present, only returns managed accounts with the <code>status</code> matching
150
+ # exactly the value given. Use <code>enabled</code> or <code>disabled</code> to
151
+ # filter accounts by whether they are currently able to use Telnyx services.
152
+ #
153
+ # @return [Symbol, Telnyx::Models::ManagedAccountListParams::Filter::Status::Eq, nil]
154
+ optional :eq, enum: -> { Telnyx::ManagedAccountListParams::Filter::Status::Eq }
155
+
156
+ # @!method initialize(eq: nil)
157
+ # Some parameter documentations has been truncated, see
158
+ # {Telnyx::Models::ManagedAccountListParams::Filter::Status} for more details.
159
+ #
160
+ # @param eq [Symbol, Telnyx::Models::ManagedAccountListParams::Filter::Status::Eq] If present, only returns managed accounts with the <code>status</code> matching
161
+
162
+ # If present, only returns managed accounts with the <code>status</code> matching
163
+ # exactly the value given. Use <code>enabled</code> or <code>disabled</code> to
164
+ # filter accounts by whether they are currently able to use Telnyx services.
165
+ #
166
+ # @see Telnyx::Models::ManagedAccountListParams::Filter::Status#eq
167
+ module Eq
168
+ extend Telnyx::Internal::Type::Enum
169
+
170
+ ALL = :all
171
+ ACTIVE = :active
172
+ ENABLED = :enabled
173
+ CANCELLED = :cancelled
174
+ DISABLED = :disabled
175
+ BLOCKED = :blocked
176
+
177
+ # @!method self.values
178
+ # @return [Array<Symbol>]
179
+ end
180
+ end
139
181
  end
140
182
 
141
183
  # Specifies the sort order for results. By default sorting direction is ascending.
@@ -31,7 +31,14 @@ module Telnyx
31
31
  # @return [Array<Symbol, Telnyx::Models::RequirementListParams::Sort>, nil]
32
32
  optional :sort, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::RequirementListParams::Sort] }
33
33
 
34
- # @!method initialize(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
34
+ # @!attribute version
35
+ # Filter by requirement version number. When omitted, returns the currently-active
36
+ # version.
37
+ #
38
+ # @return [Integer, nil]
39
+ optional :version, Integer
40
+
41
+ # @!method initialize(filter: nil, page_number: nil, page_size: nil, sort: nil, version: nil, request_options: {})
35
42
  # Some parameter documentations has been truncated, see
36
43
  # {Telnyx::Models::RequirementListParams} for more details.
37
44
  #
@@ -43,6 +50,8 @@ module Telnyx
43
50
  #
44
51
  # @param sort [Array<Symbol, Telnyx::Models::RequirementListParams::Sort>] Consolidated sort parameter for requirements (deepObject style). Originally: sor
45
52
  #
53
+ # @param version [Integer] Filter by requirement version number. When omitted, returns the currently-active
54
+ #
46
55
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
47
56
 
48
57
  class Filter < Telnyx::Internal::Type::BaseModel
@@ -12,8 +12,21 @@ module Telnyx
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!method initialize(id:, request_options: {})
15
+ # @!attribute version
16
+ # Filter by requirement version number. When omitted, returns the currently-active
17
+ # version.
18
+ #
19
+ # @return [Integer, nil]
20
+ optional :version, Integer
21
+
22
+ # @!method initialize(id:, version: nil, request_options: {})
23
+ # Some parameter documentations has been truncated, see
24
+ # {Telnyx::Models::RequirementRetrieveParams} for more details.
25
+ #
16
26
  # @param id [String]
27
+ #
28
+ # @param version [Integer] Filter by requirement version number. When omitted, returns the currently-active
29
+ #
17
30
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
18
31
  end
19
32
  end
@@ -141,7 +141,7 @@ module Telnyx
141
141
  XAI_GROK_STT = :"xai/grok-stt"
142
142
  SPEECHMATICS_STANDARD = :"speechmatics/standard"
143
143
  SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
144
- PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
144
+ NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
145
145
 
146
146
  # @!method self.values
147
147
  # @return [Array<Symbol>]
@@ -0,0 +1,56 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # @see Telnyx::Resources::Storage::Cloudfs#create
7
+ class CloudfCreateParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute name
12
+ # Filesystem name, unique within your organization. Names are trimmed and
13
+ # lowercased; after normalization they may contain lowercase letters, numbers,
14
+ # `.`, `_`, and `-` only.
15
+ #
16
+ # @return [String]
17
+ required :name, String
18
+
19
+ # @!attribute region
20
+ # Region where the filesystem's storage and metadata are provisioned.
21
+ #
22
+ # @return [Symbol, Telnyx::Models::Storage::CloudfCreateParams::Region]
23
+ required :region, enum: -> { Telnyx::Storage::CloudfCreateParams::Region }
24
+
25
+ # @!attribute idempotency_key
26
+ #
27
+ # @return [String]
28
+ required :idempotency_key, String
29
+
30
+ # @!method initialize(name:, region:, idempotency_key:, request_options: {})
31
+ # Some parameter documentations has been truncated, see
32
+ # {Telnyx::Models::Storage::CloudfCreateParams} for more details.
33
+ #
34
+ # @param name [String] Filesystem name, unique within your organization. Names are trimmed and lowercas
35
+ #
36
+ # @param region [Symbol, Telnyx::Models::Storage::CloudfCreateParams::Region] Region where the filesystem's storage and metadata are provisioned.
37
+ #
38
+ # @param idempotency_key [String]
39
+ #
40
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
41
+
42
+ # Region where the filesystem's storage and metadata are provisioned.
43
+ module Region
44
+ extend Telnyx::Internal::Type::Enum
45
+
46
+ US_CENTRAL_1 = :"us-central-1"
47
+ US_EAST_1 = :"us-east-1"
48
+ US_WEST_1 = :"us-west-1"
49
+
50
+ # @!method self.values
51
+ # @return [Array<Symbol>]
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # @see Telnyx::Resources::Storage::Cloudfs#delete
7
+ class CloudfDeleteParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!method initialize(id:, request_options: {})
17
+ # @param id [String]
18
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,109 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # @see Telnyx::Resources::Storage::Cloudfs#list
7
+ class CloudfListParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute filter_name
12
+ # Return only the filesystem whose name matches exactly.
13
+ #
14
+ # @return [String, nil]
15
+ optional :filter_name, String
16
+
17
+ # @!attribute filter_region
18
+ # Return only filesystems in this region.
19
+ #
20
+ # @return [String, nil]
21
+ optional :filter_region, String
22
+
23
+ # @!attribute filter_status
24
+ # Return only filesystems with this status. Unrecognized values are ignored.
25
+ #
26
+ # @return [Symbol, Telnyx::Models::Storage::CloudfListParams::FilterStatus, nil]
27
+ optional :filter_status, enum: -> { Telnyx::Storage::CloudfListParams::FilterStatus }
28
+
29
+ # @!attribute page_after
30
+ # Opaque cursor from a previous response's `meta.cursors.after`; returns the page
31
+ # after it. Mutually exclusive with `page[before]`.
32
+ #
33
+ # @return [String, nil]
34
+ optional :page_after, String
35
+
36
+ # @!attribute page_before
37
+ # Opaque cursor from a previous response's `meta.cursors.before`; returns the page
38
+ # before it. Mutually exclusive with `page[after]`.
39
+ #
40
+ # @return [String, nil]
41
+ optional :page_before, String
42
+
43
+ # @!attribute page_limit
44
+ # The number of filesystems to return per page. Values above 250 are treated
45
+ # as 250.
46
+ #
47
+ # @return [Integer, nil]
48
+ optional :page_limit, Integer
49
+
50
+ # @!attribute sort
51
+ # Sort order for the results: a field name for ascending, or the field name
52
+ # prefixed with `-` for descending.
53
+ #
54
+ # @return [Symbol, Telnyx::Models::Storage::CloudfListParams::Sort, nil]
55
+ optional :sort, enum: -> { Telnyx::Storage::CloudfListParams::Sort }
56
+
57
+ # @!method initialize(filter_name: nil, filter_region: nil, filter_status: nil, page_after: nil, page_before: nil, page_limit: nil, sort: nil, request_options: {})
58
+ # Some parameter documentations has been truncated, see
59
+ # {Telnyx::Models::Storage::CloudfListParams} for more details.
60
+ #
61
+ # @param filter_name [String] Return only the filesystem whose name matches exactly.
62
+ #
63
+ # @param filter_region [String] Return only filesystems in this region.
64
+ #
65
+ # @param filter_status [Symbol, Telnyx::Models::Storage::CloudfListParams::FilterStatus] Return only filesystems with this status. Unrecognized values are ignored.
66
+ #
67
+ # @param page_after [String] Opaque cursor from a previous response's `meta.cursors.after`; returns the page
68
+ #
69
+ # @param page_before [String] Opaque cursor from a previous response's `meta.cursors.before`; returns the page
70
+ #
71
+ # @param page_limit [Integer] The number of filesystems to return per page. Values above 250 are treated as 25
72
+ #
73
+ # @param sort [Symbol, Telnyx::Models::Storage::CloudfListParams::Sort] Sort order for the results: a field name for ascending, or the field name prefix
74
+ #
75
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
76
+
77
+ # Return only filesystems with this status. Unrecognized values are ignored.
78
+ module FilterStatus
79
+ extend Telnyx::Internal::Type::Enum
80
+
81
+ PROVISIONING = :provisioning
82
+ READY = :ready
83
+ NEEDS_FORMAT = :needs_format
84
+ DELETING = :deleting
85
+ FAILED = :failed
86
+
87
+ # @!method self.values
88
+ # @return [Array<Symbol>]
89
+ end
90
+
91
+ # Sort order for the results: a field name for ascending, or the field name
92
+ # prefixed with `-` for descending.
93
+ module Sort
94
+ extend Telnyx::Internal::Type::Enum
95
+
96
+ CREATED_AT = :created_at
97
+ CREATED_AT_DESC = :"-created_at"
98
+ UPDATED_AT = :updated_at
99
+ UPDATED_AT_DESC = :"-updated_at"
100
+ NAME = :name
101
+ NAME_DESC = :"-name"
102
+
103
+ # @!method self.values
104
+ # @return [Array<Symbol>]
105
+ end
106
+ end
107
+ end
108
+ end
109
+ end
@@ -0,0 +1,165 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # @see Telnyx::Resources::Storage::Cloudfs#list
7
+ class CloudfListResponse < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [Array<Telnyx::Models::Storage::CloudfListResponse::Data>, nil]
11
+ optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Storage::CloudfListResponse::Data] }
12
+
13
+ # @!attribute meta
14
+ #
15
+ # @return [Telnyx::Models::Storage::CloudfListResponse::Meta, nil]
16
+ optional :meta, -> { Telnyx::Models::Storage::CloudfListResponse::Meta }
17
+
18
+ # @!method initialize(data: nil, meta: nil)
19
+ # @param data [Array<Telnyx::Models::Storage::CloudfListResponse::Data>]
20
+ # @param meta [Telnyx::Models::Storage::CloudfListResponse::Meta]
21
+
22
+ class Data < Telnyx::Internal::Type::BaseModel
23
+ # @!attribute id
24
+ #
25
+ # @return [String, nil]
26
+ optional :id, String
27
+
28
+ # @!attribute created_at
29
+ #
30
+ # @return [Time, nil]
31
+ optional :created_at, Time
32
+
33
+ # @!attribute name
34
+ #
35
+ # @return [String, nil]
36
+ optional :name, String
37
+
38
+ # @!attribute record_type
39
+ #
40
+ # @return [String, nil]
41
+ optional :record_type, String
42
+
43
+ # @!attribute region
44
+ #
45
+ # @return [String, nil]
46
+ optional :region, String
47
+
48
+ # @!attribute s3_bucket
49
+ # Name of the bucket that stores this filesystem's data. Created during
50
+ # provisioning.
51
+ #
52
+ # @return [String, nil]
53
+ optional :s3_bucket, String
54
+
55
+ # @!attribute s3_endpoint
56
+ # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
57
+ #
58
+ # @return [String, nil]
59
+ optional :s3_endpoint, String
60
+
61
+ # @!attribute status
62
+ # Lifecycle status of the filesystem. `ready` means it is fully provisioned and
63
+ # usable. `needs_format` means the storage bucket and metadata database were
64
+ # provisioned but the filesystem has not yet been formatted — run `juicefs format`
65
+ # with the filesystem's `meta_url` before mounting. `failed` means the last
66
+ # lifecycle action failed — see the filesystem's `error` message. `deleted`
67
+ # appears only in the delete response: deleted filesystems are excluded from list
68
+ # results and return a `404` on retrieval.
69
+ #
70
+ # @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
71
+ optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
72
+
73
+ # @!attribute updated_at
74
+ #
75
+ # @return [Time, nil]
76
+ optional :updated_at, Time
77
+
78
+ # @!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)
79
+ # Some parameter documentations has been truncated, see
80
+ # {Telnyx::Models::Storage::CloudfListResponse::Data} for more details.
81
+ #
82
+ # A CloudFS filesystem as returned in list results. Connection details
83
+ # (`meta_url`, `meta_token`) are omitted — retrieve the filesystem by ID for its
84
+ # redacted `meta_url`.
85
+ #
86
+ # @param id [String]
87
+ #
88
+ # @param created_at [Time]
89
+ #
90
+ # @param name [String]
91
+ #
92
+ # @param record_type [String]
93
+ #
94
+ # @param region [String]
95
+ #
96
+ # @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
97
+ #
98
+ # @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
99
+ #
100
+ # @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
101
+ #
102
+ # @param updated_at [Time]
103
+ end
104
+
105
+ # @see Telnyx::Models::Storage::CloudfListResponse#meta
106
+ class Meta < Telnyx::Internal::Type::BaseModel
107
+ # @!attribute cursors
108
+ # Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
109
+ #
110
+ # @return [Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors, nil]
111
+ optional :cursors, -> { Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors }
112
+
113
+ # @!attribute next_
114
+ # Relative URL (path and query) of the next page. Omitted when there are no
115
+ # further results.
116
+ #
117
+ # @return [String, nil]
118
+ optional :next_, String, api_name: :next
119
+
120
+ # @!attribute previous
121
+ # Relative URL (path and query) of the previous page. Omitted on the first page.
122
+ #
123
+ # @return [String, nil]
124
+ optional :previous, String
125
+
126
+ # @!method initialize(cursors: nil, next_: nil, previous: nil)
127
+ # Some parameter documentations has been truncated, see
128
+ # {Telnyx::Models::Storage::CloudfListResponse::Meta} for more details.
129
+ #
130
+ # @param cursors [Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors] Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
131
+ #
132
+ # @param next_ [String] Relative URL (path and query) of the next page. Omitted when there are no furthe
133
+ #
134
+ # @param previous [String] Relative URL (path and query) of the previous page. Omitted on the first page.
135
+
136
+ # @see Telnyx::Models::Storage::CloudfListResponse::Meta#cursors
137
+ class Cursors < Telnyx::Internal::Type::BaseModel
138
+ # @!attribute after
139
+ # Cursor for the next page; pass it as `page[after]`. Omitted on the last page.
140
+ #
141
+ # @return [String, nil]
142
+ optional :after, String
143
+
144
+ # @!attribute before
145
+ # Cursor for the previous page; pass it as `page[before]`. Omitted on the first
146
+ # page.
147
+ #
148
+ # @return [String, nil]
149
+ optional :before, String
150
+
151
+ # @!method initialize(after: nil, before: nil)
152
+ # Some parameter documentations has been truncated, see
153
+ # {Telnyx::Models::Storage::CloudfListResponse::Meta::Cursors} for more details.
154
+ #
155
+ # Opaque cursors for the adjacent pages. Empty when there are no adjacent pages.
156
+ #
157
+ # @param after [String] Cursor for the next page; pass it as `page[after]`. Omitted on the last page.
158
+ #
159
+ # @param before [String] Cursor for the previous page; pass it as `page[before]`. Omitted on the first pa
160
+ end
161
+ end
162
+ end
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # @see Telnyx::Resources::Storage::Cloudfs#retrieve
7
+ class CloudfRetrieveParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!method initialize(id:, request_options: {})
17
+ # @param id [String]
18
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # @see Telnyx::Resources::Storage::Cloudfs#update
7
+ class CloudfUpdateParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute name
17
+ # New filesystem name, unique within your organization. Names are trimmed and
18
+ # lowercased; after normalization they may contain lowercase letters, numbers,
19
+ # `.`, `_`, and `-` only.
20
+ #
21
+ # @return [String, nil]
22
+ optional :name, String
23
+
24
+ # @!method initialize(id:, name: nil, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {Telnyx::Models::Storage::CloudfUpdateParams} for more details.
27
+ #
28
+ # @param id [String]
29
+ #
30
+ # @param name [String] New filesystem name, unique within your organization. Names are trimmed and lowe
31
+ #
32
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ module Cloudfs
7
+ # @see Telnyx::Resources::Storage::Cloudfs::Actions#rotate_meta_token
8
+ class ActionRotateMetaTokenParams < Telnyx::Internal::Type::BaseModel
9
+ extend Telnyx::Internal::Type::RequestParameters::Converter
10
+ include Telnyx::Internal::Type::RequestParameters
11
+
12
+ # @!attribute id
13
+ #
14
+ # @return [String]
15
+ required :id, String
16
+
17
+ # @!attribute idempotency_key
18
+ #
19
+ # @return [String]
20
+ required :idempotency_key, String
21
+
22
+ # @!method initialize(id:, idempotency_key:, request_options: {})
23
+ # @param id [String]
24
+ # @param idempotency_key [String]
25
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end