telnyx 5.156.0 → 5.158.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 (154) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -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_answered.rb +35 -3
  18. data/lib/telnyx/models/call_dial_params.rb +13 -1
  19. data/lib/telnyx/models/call_hangup.rb +35 -3
  20. data/lib/telnyx/models/call_initiated.rb +35 -3
  21. data/lib/telnyx/models/calls/transcription_config.rb +8 -4
  22. data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -1
  23. data/lib/telnyx/models/doc_reqs_requirement.rb +29 -4
  24. data/lib/telnyx/models/inbound_message.rb +278 -28
  25. data/lib/telnyx/models/inbound_message_webhook_event.rb +70 -3
  26. data/lib/telnyx/models/managed_account_list_params.rb +45 -3
  27. data/lib/telnyx/models/requirement_list_params.rb +10 -1
  28. data/lib/telnyx/models/requirement_retrieve_params.rb +14 -1
  29. data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -1
  30. data/lib/telnyx/models/storage/cloudf_create_params.rb +56 -0
  31. data/lib/telnyx/models/storage/cloudf_delete_params.rb +22 -0
  32. data/lib/telnyx/models/storage/cloudf_list_params.rb +109 -0
  33. data/lib/telnyx/models/storage/cloudf_list_response.rb +165 -0
  34. data/lib/telnyx/models/storage/cloudf_retrieve_params.rb +22 -0
  35. data/lib/telnyx/models/storage/cloudf_update_params.rb +36 -0
  36. data/lib/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rb +30 -0
  37. data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb +129 -0
  38. data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb +129 -0
  39. data/lib/telnyx/models/storage/cloudfs_filesystem_status.rb +28 -0
  40. data/lib/telnyx/models/verify_profile.rb +2 -2
  41. data/lib/telnyx/models/verify_profile_create_params.rb +2 -2
  42. data/lib/telnyx/models/verify_profile_update_params.rb +2 -2
  43. data/lib/telnyx/resources/ai/anthropic/v1.rb +91 -0
  44. data/lib/telnyx/resources/ai/anthropic.rb +20 -0
  45. data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
  46. data/lib/telnyx/resources/ai/assistants.rb +2 -2
  47. data/lib/telnyx/resources/ai/conversations/conversation_insights.rb +55 -0
  48. data/lib/telnyx/resources/ai/conversations.rb +5 -0
  49. data/lib/telnyx/resources/ai/tools.rb +5 -2
  50. data/lib/telnyx/resources/ai.rb +4 -0
  51. data/lib/telnyx/resources/calls.rb +3 -1
  52. data/lib/telnyx/resources/requirements.rb +13 -3
  53. data/lib/telnyx/resources/storage/cloudfs/actions.rb +54 -0
  54. data/lib/telnyx/resources/storage/cloudfs.rb +187 -0
  55. data/lib/telnyx/resources/storage.rb +6 -0
  56. data/lib/telnyx/version.rb +1 -1
  57. data/lib/telnyx.rb +20 -0
  58. data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +314 -0
  59. data/rbi/telnyx/models/ai/anthropic/v1_messages_response.rbi +15 -0
  60. data/rbi/telnyx/models/ai/assistant_create_params.rbi +8 -4
  61. data/rbi/telnyx/models/ai/assistant_tool.rbi +37 -1
  62. data/rbi/telnyx/models/ai/assistant_update_params.rbi +8 -4
  63. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +8 -4
  64. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbi +188 -0
  65. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbi +94 -0
  66. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -6
  67. data/rbi/telnyx/models/ai/pay_tool_params.rbi +71 -0
  68. data/rbi/telnyx/models/ai/tool_create_params.rbi +9 -0
  69. data/rbi/telnyx/models/ai/tool_update_params.rbi +9 -0
  70. data/rbi/telnyx/models/ai/transcription_settings.rbi +5 -5
  71. data/rbi/telnyx/models/call_answered.rbi +92 -4
  72. data/rbi/telnyx/models/call_dial_params.rbi +19 -0
  73. data/rbi/telnyx/models/call_hangup.rbi +90 -4
  74. data/rbi/telnyx/models/call_initiated.rbi +94 -4
  75. data/rbi/telnyx/models/calls/transcription_config.rbi +15 -7
  76. data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +2 -2
  77. data/rbi/telnyx/models/doc_reqs_requirement.rbi +38 -9
  78. data/rbi/telnyx/models/inbound_message.rbi +324 -58
  79. data/rbi/telnyx/models/inbound_message_webhook_event.rbi +173 -4
  80. data/rbi/telnyx/models/managed_account_list_params.rbi +130 -6
  81. data/rbi/telnyx/models/requirement_list_params.rbi +13 -0
  82. data/rbi/telnyx/models/requirement_retrieve_params.rbi +21 -2
  83. data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +2 -2
  84. data/rbi/telnyx/models/storage/cloudf_create_params.rbi +103 -0
  85. data/rbi/telnyx/models/storage/cloudf_delete_params.rbi +40 -0
  86. data/rbi/telnyx/models/storage/cloudf_list_params.rbi +232 -0
  87. data/rbi/telnyx/models/storage/cloudf_list_response.rbi +327 -0
  88. data/rbi/telnyx/models/storage/cloudf_retrieve_params.rbi +40 -0
  89. data/rbi/telnyx/models/storage/cloudf_update_params.rbi +61 -0
  90. data/rbi/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbi +50 -0
  91. data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi +229 -0
  92. data/rbi/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbi +227 -0
  93. data/rbi/telnyx/models/storage/cloudfs_filesystem_status.rbi +57 -0
  94. data/rbi/telnyx/models/verify_profile.rbi +2 -2
  95. data/rbi/telnyx/models/verify_profile_create_params.rbi +2 -2
  96. data/rbi/telnyx/models/verify_profile_update_params.rbi +2 -2
  97. data/rbi/telnyx/resources/ai/anthropic/v1.rbi +106 -0
  98. data/rbi/telnyx/resources/ai/anthropic.rbi +17 -0
  99. data/rbi/telnyx/resources/ai/assistants/versions.rbi +2 -1
  100. data/rbi/telnyx/resources/ai/assistants.rbi +4 -2
  101. data/rbi/telnyx/resources/ai/conversations/conversation_insights.rbi +68 -0
  102. data/rbi/telnyx/resources/ai/conversations.rbi +6 -0
  103. data/rbi/telnyx/resources/ai/tools.rbi +4 -0
  104. data/rbi/telnyx/resources/ai.rbi +3 -0
  105. data/rbi/telnyx/resources/calls.rbi +7 -0
  106. data/rbi/telnyx/resources/managed_accounts.rbi +1 -1
  107. data/rbi/telnyx/resources/requirements.rbi +8 -0
  108. data/rbi/telnyx/resources/storage/cloudfs/actions.rbi +46 -0
  109. data/rbi/telnyx/resources/storage/cloudfs.rbi +152 -0
  110. data/rbi/telnyx/resources/storage.rbi +5 -0
  111. data/sig/telnyx/models/ai/anthropic/v1_messages_params.rbs +175 -0
  112. data/sig/telnyx/models/ai/anthropic/v1_messages_response.rbs +11 -0
  113. data/sig/telnyx/models/ai/assistant_tool.rbs +13 -0
  114. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbs +74 -0
  115. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbs +34 -0
  116. data/sig/telnyx/models/ai/pay_tool_params.rbs +41 -0
  117. data/sig/telnyx/models/ai/tool_create_params.rbs +7 -0
  118. data/sig/telnyx/models/ai/tool_update_params.rbs +7 -0
  119. data/sig/telnyx/models/ai/transcription_settings.rbs +2 -2
  120. data/sig/telnyx/models/call_answered.rbs +39 -6
  121. data/sig/telnyx/models/call_dial_params.rbs +7 -0
  122. data/sig/telnyx/models/call_hangup.rbs +39 -6
  123. data/sig/telnyx/models/call_initiated.rbs +39 -6
  124. data/sig/telnyx/models/calls/transcription_config.rbs +2 -2
  125. data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +2 -2
  126. data/sig/telnyx/models/doc_reqs_requirement.rbs +25 -8
  127. data/sig/telnyx/models/inbound_message.rbs +204 -35
  128. data/sig/telnyx/models/inbound_message_webhook_event.rbs +81 -5
  129. data/sig/telnyx/models/managed_account_list_params.rbs +47 -3
  130. data/sig/telnyx/models/requirement_list_params.rbs +8 -1
  131. data/sig/telnyx/models/requirement_retrieve_params.rbs +12 -2
  132. data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -2
  133. data/sig/telnyx/models/storage/cloudf_create_params.rbs +50 -0
  134. data/sig/telnyx/models/storage/cloudf_delete_params.rbs +22 -0
  135. data/sig/telnyx/models/storage/cloudf_list_params.rbs +112 -0
  136. data/sig/telnyx/models/storage/cloudf_list_response.rbs +163 -0
  137. data/sig/telnyx/models/storage/cloudf_retrieve_params.rbs +22 -0
  138. data/sig/telnyx/models/storage/cloudf_update_params.rbs +32 -0
  139. data/sig/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbs +32 -0
  140. data/sig/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbs +115 -0
  141. data/sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs +115 -0
  142. data/sig/telnyx/models/storage/cloudfs_filesystem_status.rbs +21 -0
  143. data/sig/telnyx/resources/ai/anthropic/v1.rbs +35 -0
  144. data/sig/telnyx/resources/ai/anthropic.rbs +11 -0
  145. data/sig/telnyx/resources/ai/conversations/conversation_insights.rbs +20 -0
  146. data/sig/telnyx/resources/ai/conversations.rbs +2 -0
  147. data/sig/telnyx/resources/ai/tools.rbs +2 -0
  148. data/sig/telnyx/resources/ai.rbs +2 -0
  149. data/sig/telnyx/resources/calls.rbs +1 -0
  150. data/sig/telnyx/resources/requirements.rbs +2 -0
  151. data/sig/telnyx/resources/storage/cloudfs/actions.rbs +17 -0
  152. data/sig/telnyx/resources/storage/cloudfs.rbs +45 -0
  153. data/sig/telnyx/resources/storage.rbs +2 -0
  154. metadata +62 -2
@@ -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
@@ -0,0 +1,129 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # @see Telnyx::Resources::Storage::Cloudfs#retrieve
7
+ class CloudfsFilesystemDetailResponseWrapper < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ # A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits
10
+ # the credential and there is no `meta_token` field — the token is only returned
11
+ # by create and rotate-meta-token.
12
+ #
13
+ # @return [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data, nil]
14
+ optional :data, -> { Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data }
15
+
16
+ # @!method initialize(data: nil)
17
+ # Some parameter documentations has been truncated, see
18
+ # {Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper} for more
19
+ # details.
20
+ #
21
+ # @param data [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data] A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits th
22
+
23
+ # @see Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper#data
24
+ class Data < Telnyx::Internal::Type::BaseModel
25
+ # @!attribute id
26
+ #
27
+ # @return [String, nil]
28
+ optional :id, String
29
+
30
+ # @!attribute created_at
31
+ #
32
+ # @return [Time, nil]
33
+ optional :created_at, Time
34
+
35
+ # @!attribute error
36
+ # Explanation of the most recent failed lifecycle action. Present only when the
37
+ # filesystem is in a `failed` state.
38
+ #
39
+ # @return [String, nil]
40
+ optional :error, String
41
+
42
+ # @!attribute meta_url
43
+ # PostgreSQL connection URL for the filesystem's metadata database, without the
44
+ # credential. Combine it with your stored metadata token, or issue a new token
45
+ # with rotate-meta-token.
46
+ #
47
+ # @return [String, nil]
48
+ optional :meta_url, String
49
+
50
+ # @!attribute name
51
+ #
52
+ # @return [String, nil]
53
+ optional :name, String
54
+
55
+ # @!attribute record_type
56
+ #
57
+ # @return [String, nil]
58
+ optional :record_type, String
59
+
60
+ # @!attribute region
61
+ #
62
+ # @return [String, nil]
63
+ optional :region, String
64
+
65
+ # @!attribute s3_bucket
66
+ # Name of the bucket that stores this filesystem's data. Created during
67
+ # provisioning.
68
+ #
69
+ # @return [String, nil]
70
+ optional :s3_bucket, String
71
+
72
+ # @!attribute s3_endpoint
73
+ # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
74
+ #
75
+ # @return [String, nil]
76
+ optional :s3_endpoint, String
77
+
78
+ # @!attribute status
79
+ # Lifecycle status of the filesystem. `ready` means it is fully provisioned and
80
+ # usable. `needs_format` means the storage bucket and metadata database were
81
+ # provisioned but the filesystem has not yet been formatted — run `juicefs format`
82
+ # with the filesystem's `meta_url` before mounting. `failed` means the last
83
+ # lifecycle action failed — see the filesystem's `error` message. `deleted`
84
+ # appears only in the delete response: deleted filesystems are excluded from list
85
+ # results and return a `404` on retrieval.
86
+ #
87
+ # @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
88
+ optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
89
+
90
+ # @!attribute updated_at
91
+ #
92
+ # @return [Time, nil]
93
+ optional :updated_at, Time
94
+
95
+ # @!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)
96
+ # Some parameter documentations has been truncated, see
97
+ # {Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data} for more
98
+ # details.
99
+ #
100
+ # A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits
101
+ # the credential and there is no `meta_token` field — the token is only returned
102
+ # by create and rotate-meta-token.
103
+ #
104
+ # @param id [String]
105
+ #
106
+ # @param created_at [Time]
107
+ #
108
+ # @param error [String] Explanation of the most recent failed lifecycle action. Present only when the fi
109
+ #
110
+ # @param meta_url [String] PostgreSQL connection URL for the filesystem's metadata database, without the cr
111
+ #
112
+ # @param name [String]
113
+ #
114
+ # @param record_type [String]
115
+ #
116
+ # @param region [String]
117
+ #
118
+ # @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
119
+ #
120
+ # @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
121
+ #
122
+ # @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
123
+ #
124
+ # @param updated_at [Time]
125
+ end
126
+ end
127
+ end
128
+ end
129
+ end
@@ -0,0 +1,129 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # @see Telnyx::Resources::Storage::Cloudfs#create
7
+ class CloudfsFilesystemResponseWrapper < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ # A CloudFS filesystem, including its metadata credential. This shape is returned
10
+ # only by create and rotate-meta-token.
11
+ #
12
+ # @return [Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper::Data, nil]
13
+ optional :data, -> { Telnyx::Storage::CloudfsFilesystemResponseWrapper::Data }
14
+
15
+ # @!method initialize(data: nil)
16
+ # Some parameter documentations has been truncated, see
17
+ # {Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper} for more details.
18
+ #
19
+ # @param data [Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper::Data] A CloudFS filesystem, including its metadata credential. This shape is returned
20
+
21
+ # @see Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper#data
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 meta_token
34
+ # Metadata access token, in cleartext. Returned only by create and
35
+ # rotate-meta-token and not retrievable afterwards — store it securely.
36
+ #
37
+ # @return [String, nil]
38
+ optional :meta_token, String
39
+
40
+ # @!attribute meta_url
41
+ # PostgreSQL connection URL for the filesystem's metadata database. In create and
42
+ # rotate-meta-token responses it embeds the metadata token as the password:
43
+ # `postgres://<database>:<meta_token>@us-east-1.telnyxcloudfs.com:5432/<database>?sslmode=require`
44
+ # (the example below is shown without the credential; the actual response includes
45
+ # it). Pass it to `juicefs mount`: the storage configuration is baked in at
46
+ # provisioning, so the metadata URL is all a client needs to mount the filesystem.
47
+ #
48
+ # @return [String, nil]
49
+ optional :meta_url, String
50
+
51
+ # @!attribute name
52
+ #
53
+ # @return [String, nil]
54
+ optional :name, String
55
+
56
+ # @!attribute record_type
57
+ #
58
+ # @return [String, nil]
59
+ optional :record_type, String
60
+
61
+ # @!attribute region
62
+ #
63
+ # @return [String, nil]
64
+ optional :region, String
65
+
66
+ # @!attribute s3_bucket
67
+ # Name of the bucket that stores this filesystem's data. Created during
68
+ # provisioning.
69
+ #
70
+ # @return [String, nil]
71
+ optional :s3_bucket, String
72
+
73
+ # @!attribute s3_endpoint
74
+ # URL of the Telnyx Cloud Storage endpoint backing this filesystem.
75
+ #
76
+ # @return [String, nil]
77
+ optional :s3_endpoint, String
78
+
79
+ # @!attribute status
80
+ # Lifecycle status of the filesystem. `ready` means it is fully provisioned and
81
+ # usable. `needs_format` means the storage bucket and metadata database were
82
+ # provisioned but the filesystem has not yet been formatted — run `juicefs format`
83
+ # with the filesystem's `meta_url` before mounting. `failed` means the last
84
+ # lifecycle action failed — see the filesystem's `error` message. `deleted`
85
+ # appears only in the delete response: deleted filesystems are excluded from list
86
+ # results and return a `404` on retrieval.
87
+ #
88
+ # @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
89
+ optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
90
+
91
+ # @!attribute updated_at
92
+ #
93
+ # @return [Time, nil]
94
+ optional :updated_at, Time
95
+
96
+ # @!method initialize(id: nil, created_at: nil, meta_token: nil, meta_url: nil, name: nil, record_type: nil, region: nil, s3_bucket: nil, s3_endpoint: nil, status: nil, updated_at: nil)
97
+ # Some parameter documentations has been truncated, see
98
+ # {Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper::Data} for more
99
+ # details.
100
+ #
101
+ # A CloudFS filesystem, including its metadata credential. This shape is returned
102
+ # only by create and rotate-meta-token.
103
+ #
104
+ # @param id [String]
105
+ #
106
+ # @param created_at [Time]
107
+ #
108
+ # @param meta_token [String] Metadata access token, in cleartext. Returned only by create and rotate-meta-tok
109
+ #
110
+ # @param meta_url [String] PostgreSQL connection URL for the filesystem's metadata database. In create and
111
+ #
112
+ # @param name [String]
113
+ #
114
+ # @param record_type [String]
115
+ #
116
+ # @param region [String]
117
+ #
118
+ # @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
119
+ #
120
+ # @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
121
+ #
122
+ # @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
123
+ #
124
+ # @param updated_at [Time]
125
+ end
126
+ end
127
+ end
128
+ end
129
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Storage
6
+ # Lifecycle status of the filesystem. `ready` means it is fully provisioned and
7
+ # usable. `needs_format` means the storage bucket and metadata database were
8
+ # provisioned but the filesystem has not yet been formatted — run `juicefs format`
9
+ # with the filesystem's `meta_url` before mounting. `failed` means the last
10
+ # lifecycle action failed — see the filesystem's `error` message. `deleted`
11
+ # appears only in the delete response: deleted filesystems are excluded from list
12
+ # results and return a `404` on retrieval.
13
+ module CloudfsFilesystemStatus
14
+ extend Telnyx::Internal::Type::Enum
15
+
16
+ PROVISIONING = :provisioning
17
+ READY = :ready
18
+ NEEDS_FORMAT = :needs_format
19
+ DELETING = :deleting
20
+ FAILED = :failed
21
+ DELETED = :deleted
22
+
23
+ # @!method self.values
24
+ # @return [Array<Symbol>]
25
+ end
26
+ end
27
+ end
28
+ end
@@ -301,7 +301,7 @@ module Telnyx
301
301
  optional :sender_phone_number, String, nil?: true
302
302
 
303
303
  # @!attribute template_id
304
- # Customer pre-approved authentication template name registered on Meta
304
+ # Customer pre-approved authentication template ID registered on Meta
305
305
  #
306
306
  # @return [String, nil]
307
307
  optional :template_id, String, nil?: true
@@ -336,7 +336,7 @@ module Telnyx
336
336
  #
337
337
  # @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
338
338
  #
339
- # @param template_id [String, nil] Customer pre-approved authentication template name registered on Meta
339
+ # @param template_id [String, nil] Customer pre-approved authentication template ID registered on Meta
340
340
  #
341
341
  # @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
342
342
  #