telnyx 5.150.0 → 5.152.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 (186) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -531
  3. data/README.md +10 -1
  4. data/lib/telnyx/models/advanced_order_create_params.rb +1 -86
  5. data/lib/telnyx/models/advanced_order_update_requirement_group_params.rb +1 -88
  6. data/lib/telnyx/models/ai_retrieve_conversation_histories_params.rb +22 -48
  7. data/lib/telnyx/models/ai_retrieve_conversation_histories_response.rb +10 -50
  8. data/lib/telnyx/models/calls/deepgram_nova2_config.rb +23 -1
  9. data/lib/telnyx/models/calls/deepgram_nova3_config.rb +22 -1
  10. data/lib/telnyx/models/calls/transcription_start_request.rb +5 -3
  11. data/lib/telnyx/models/dir/email_verification_status_wrapped.rb +82 -0
  12. data/lib/telnyx/models/dir/reference.rb +125 -0
  13. data/lib/telnyx/models/dir/reference_create_params.rb +43 -0
  14. data/lib/telnyx/models/dir/reference_input.rb +74 -0
  15. data/lib/telnyx/models/dir/reference_list.rb +18 -0
  16. data/lib/telnyx/models/dir/{phone_number_delete_all_params.rb → reference_list_params.rb} +3 -9
  17. data/lib/telnyx/models/dir/reference_update_params.rb +103 -0
  18. data/lib/telnyx/models/dir/reference_update_response.rb +23 -0
  19. data/lib/telnyx/models/dir/verify_email_confirm_params.rb +31 -0
  20. data/lib/telnyx/models/dir/verify_email_create_params.rb +22 -0
  21. data/lib/telnyx/models/dir/verify_email_list_params.rb +22 -0
  22. data/lib/telnyx/models/dir_update_infringement_params.rb +6 -2
  23. data/lib/telnyx/models/enterprises/dir_create_params.rb +10 -10
  24. data/lib/telnyx/models/public_internet_gateway.rb +24 -1
  25. data/lib/telnyx/models/storage/kv_create_params.rb +24 -0
  26. data/lib/telnyx/models/storage/kv_delete_params.rb +22 -0
  27. data/lib/telnyx/models/storage/kv_list_params.rb +32 -0
  28. data/lib/telnyx/models/storage/kv_namespace.rb +75 -0
  29. data/lib/telnyx/models/storage/kv_namespace_response_wrapper.rb +18 -0
  30. data/lib/telnyx/models/storage/kv_retrieve_params.rb +22 -0
  31. data/lib/telnyx/models/storage/kvs/key_delete_params.rb +30 -0
  32. data/lib/telnyx/models/storage/kvs/key_list_params.rb +49 -0
  33. data/lib/telnyx/models/storage/kvs/key_list_response.rb +82 -0
  34. data/lib/telnyx/models/storage/kvs/key_retrieve_params.rb +30 -0
  35. data/lib/telnyx/models/storage/kvs/key_update_params.rb +53 -0
  36. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +9 -69
  37. data/lib/telnyx/models/virtual_cross_connect_create.rb +176 -2
  38. data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rb +31 -0
  39. data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rb +54 -0
  40. data/lib/telnyx/models/wireguard_interface.rb +24 -1
  41. data/lib/telnyx/resources/ai.rb +20 -21
  42. data/lib/telnyx/resources/calls/actions.rb +1 -1
  43. data/lib/telnyx/resources/dir/references.rb +139 -0
  44. data/lib/telnyx/resources/dir/verify_email.rb +91 -0
  45. data/lib/telnyx/resources/dir.rb +17 -1
  46. data/lib/telnyx/resources/documents.rb +1 -1
  47. data/lib/telnyx/resources/enterprises/dir.rb +3 -3
  48. data/lib/telnyx/resources/storage/kvs/keys.rb +154 -0
  49. data/lib/telnyx/resources/storage/kvs.rb +115 -0
  50. data/lib/telnyx/resources/storage.rb +5 -0
  51. data/lib/telnyx/resources/whatsapp/phone_numbers.rb +27 -0
  52. data/lib/telnyx/version.rb +1 -1
  53. data/lib/telnyx.rb +29 -2
  54. data/rbi/telnyx/models/advanced_order_create_params.rbi +4 -198
  55. data/rbi/telnyx/models/advanced_order_update_requirement_group_params.rbi +2 -219
  56. data/rbi/telnyx/models/ai/assistant_get_texml_response.rbi +1 -1
  57. data/rbi/telnyx/models/ai/assistants/instruction_enhance_response.rbi +1 -1
  58. data/rbi/telnyx/models/ai_retrieve_conversation_histories_params.rbi +30 -97
  59. data/rbi/telnyx/models/ai_retrieve_conversation_histories_response.rbi +10 -85
  60. data/rbi/telnyx/models/calls/deepgram_nova2_config.rbi +34 -0
  61. data/rbi/telnyx/models/calls/deepgram_nova3_config.rbi +32 -0
  62. data/rbi/telnyx/models/calls/transcription_start_request.rbi +5 -0
  63. data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi +184 -0
  64. data/rbi/telnyx/models/dir/reference.rbi +162 -0
  65. data/rbi/telnyx/models/dir/reference_create_params.rbi +66 -0
  66. data/rbi/telnyx/models/dir/reference_input.rbi +93 -0
  67. data/rbi/telnyx/models/dir/reference_list.rbi +29 -0
  68. data/rbi/telnyx/models/dir/reference_list_params.rbi +37 -0
  69. data/rbi/telnyx/models/dir/reference_update_params.rbi +154 -0
  70. data/rbi/telnyx/models/dir/reference_update_response.rbi +39 -0
  71. data/rbi/telnyx/models/dir/{phone_number_delete_all_params.rbi → verify_email_confirm_params.rbi} +13 -7
  72. data/rbi/telnyx/models/dir/verify_email_create_params.rbi +40 -0
  73. data/rbi/telnyx/models/dir/verify_email_list_params.rbi +37 -0
  74. data/rbi/telnyx/models/dir_update_infringement_params.rbi +4 -2
  75. data/rbi/telnyx/models/enterprises/dir_create_params.rbi +10 -13
  76. data/rbi/telnyx/models/messaging_profiles/autoresp_config_delete_response.rbi +1 -1
  77. data/rbi/telnyx/models/public_internet_gateway.rbi +45 -3
  78. data/rbi/telnyx/models/storage/kv_create_params.rbi +42 -0
  79. data/rbi/telnyx/models/storage/kv_delete_params.rbi +37 -0
  80. data/rbi/telnyx/models/storage/kv_list_params.rbi +59 -0
  81. data/rbi/telnyx/models/storage/kv_namespace.rbi +131 -0
  82. data/rbi/telnyx/models/storage/kv_namespace_response_wrapper.rbi +35 -0
  83. data/rbi/telnyx/models/storage/kv_retrieve_params.rbi +37 -0
  84. data/rbi/telnyx/models/storage/kvs/key_delete_params.rbi +50 -0
  85. data/rbi/telnyx/models/storage/kvs/key_list_params.rbi +81 -0
  86. data/rbi/telnyx/models/storage/kvs/key_list_response.rbi +179 -0
  87. data/rbi/telnyx/models/storage/kvs/key_retrieve_params.rbi +50 -0
  88. data/rbi/telnyx/models/storage/kvs/key_update_params.rbi +77 -0
  89. data/rbi/telnyx/models/sub_number_orders_report_download_response.rbi +1 -1
  90. data/rbi/telnyx/models/telephony_credential_create_token_response.rbi +1 -1
  91. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +12 -189
  92. data/rbi/telnyx/models/virtual_cross_connect_create.rbi +265 -7
  93. data/rbi/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rbi +54 -0
  94. data/rbi/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbi +125 -0
  95. data/rbi/telnyx/models/wireguard_interface.rbi +48 -3
  96. data/rbi/telnyx/models/wireguard_peer_retrieve_config_response.rbi +1 -1
  97. data/rbi/telnyx/models.rbi +0 -7
  98. data/rbi/telnyx/resources/ai.rbi +21 -28
  99. data/rbi/telnyx/resources/calls/actions.rbi +1 -0
  100. data/rbi/telnyx/resources/dir/references.rbi +114 -0
  101. data/rbi/telnyx/resources/dir/verify_email.rbi +70 -0
  102. data/rbi/telnyx/resources/dir.rbi +13 -1
  103. data/rbi/telnyx/resources/enterprises/dir.rbi +4 -4
  104. data/rbi/telnyx/resources/storage/kvs/keys.rbi +115 -0
  105. data/rbi/telnyx/resources/storage/kvs.rbi +87 -0
  106. data/rbi/telnyx/resources/storage.rbi +4 -0
  107. data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +21 -0
  108. data/sig/telnyx/models/advanced_order_create_params.rbs +3 -99
  109. data/sig/telnyx/models/advanced_order_update_requirement_group_params.rbs +3 -94
  110. data/sig/telnyx/models/ai_retrieve_conversation_histories_params.rbs +15 -34
  111. data/sig/telnyx/models/ai_retrieve_conversation_histories_response.rbs +0 -24
  112. data/sig/telnyx/models/calls/deepgram_nova2_config.rbs +14 -0
  113. data/sig/telnyx/models/calls/deepgram_nova3_config.rbs +14 -0
  114. data/sig/telnyx/models/calls/transcription_start_request.rbs +1 -0
  115. data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs +69 -0
  116. data/sig/telnyx/models/dir/reference.rbs +88 -0
  117. data/sig/telnyx/models/dir/reference_create_params.rbs +38 -0
  118. data/sig/telnyx/models/dir/reference_input.rbs +52 -0
  119. data/sig/telnyx/models/dir/reference_list.rbs +15 -0
  120. data/sig/telnyx/models/dir/reference_list_params.rbs +25 -0
  121. data/sig/telnyx/models/dir/reference_update_params.rbs +92 -0
  122. data/sig/telnyx/models/dir/reference_update_response.rbs +15 -0
  123. data/sig/telnyx/models/dir/{phone_number_delete_all_params.rbs → verify_email_confirm_params.rbs} +6 -6
  124. data/sig/telnyx/models/dir/verify_email_create_params.rbs +25 -0
  125. data/sig/telnyx/models/dir/verify_email_list_params.rbs +25 -0
  126. data/sig/telnyx/models/enterprises/dir_create_params.rbs +5 -7
  127. data/sig/telnyx/models/public_internet_gateway.rbs +32 -3
  128. data/sig/telnyx/models/storage/kv_create_params.rbs +25 -0
  129. data/sig/telnyx/models/storage/kv_delete_params.rbs +22 -0
  130. data/sig/telnyx/models/storage/kv_list_params.rbs +34 -0
  131. data/sig/telnyx/models/storage/kv_namespace.rbs +80 -0
  132. data/sig/telnyx/models/storage/kv_namespace_response_wrapper.rbs +20 -0
  133. data/sig/telnyx/models/storage/kv_retrieve_params.rbs +22 -0
  134. data/sig/telnyx/models/storage/kvs/key_delete_params.rbs +32 -0
  135. data/sig/telnyx/models/storage/kvs/key_list_params.rbs +46 -0
  136. data/sig/telnyx/models/storage/kvs/key_list_response.rbs +88 -0
  137. data/sig/telnyx/models/{enterprises/reputation/loa_patch_all_params.rbs → storage/kvs/key_retrieve_params.rbs} +11 -11
  138. data/sig/telnyx/models/storage/kvs/key_update_params.rbs +47 -0
  139. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +15 -63
  140. data/sig/telnyx/models/virtual_cross_connect_create.rbs +138 -7
  141. data/sig/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rbs +30 -0
  142. data/sig/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbs +66 -0
  143. data/sig/telnyx/models/wireguard_interface.rbs +34 -3
  144. data/sig/telnyx/models.rbs +0 -1
  145. data/sig/telnyx/resources/ai.rbs +2 -3
  146. data/sig/telnyx/resources/dir/references.rbs +35 -0
  147. data/sig/telnyx/resources/dir/verify_email.rbs +25 -0
  148. data/sig/telnyx/resources/dir.rbs +4 -0
  149. data/sig/telnyx/resources/enterprises/dir.rbs +1 -1
  150. data/sig/telnyx/resources/storage/kvs/keys.rbs +39 -0
  151. data/sig/telnyx/resources/storage/kvs.rbs +32 -0
  152. data/sig/telnyx/resources/storage.rbs +2 -0
  153. data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +6 -0
  154. metadata +86 -38
  155. data/lib/telnyx/models/dir/phone_number_create_params.rb +0 -47
  156. data/lib/telnyx/models/dir/phone_number_create_response.rb +0 -32
  157. data/lib/telnyx/models/dir/phone_number_delete_all_response.rb +0 -103
  158. data/lib/telnyx/models/dir_loa_params.rb +0 -79
  159. data/lib/telnyx/models/dir_retrieve_document_types_params.rb +0 -14
  160. data/lib/telnyx/models/dir_retrieve_document_types_response.rb +0 -51
  161. data/lib/telnyx/models/dir_retrieve_infringement_claims_params.rb +0 -40
  162. data/lib/telnyx/models/dir_retrieve_infringement_claims_response.rb +0 -30
  163. data/lib/telnyx/models/dir_update_infringement_update_params.rb +0 -134
  164. data/lib/telnyx/models/enterprises/reputation/loa_create_params.rb +0 -146
  165. data/lib/telnyx/models/enterprises/reputation/loa_patch_all_params.rb +0 -38
  166. data/rbi/telnyx/models/dir/phone_number_create_params.rbi +0 -72
  167. data/rbi/telnyx/models/dir/phone_number_create_response.rbi +0 -48
  168. data/rbi/telnyx/models/dir/phone_number_delete_all_response.rbi +0 -206
  169. data/rbi/telnyx/models/dir_loa_params.rbi +0 -120
  170. data/rbi/telnyx/models/dir_retrieve_document_types_params.rbi +0 -30
  171. data/rbi/telnyx/models/dir_retrieve_document_types_response.rbi +0 -103
  172. data/rbi/telnyx/models/dir_retrieve_infringement_claims_params.rbi +0 -66
  173. data/rbi/telnyx/models/dir_retrieve_infringement_claims_response.rbi +0 -55
  174. data/rbi/telnyx/models/dir_update_infringement_update_params.rbi +0 -256
  175. data/rbi/telnyx/models/enterprises/reputation/loa_create_params.rbi +0 -238
  176. data/rbi/telnyx/models/enterprises/reputation/loa_patch_all_params.rbi +0 -60
  177. data/sig/telnyx/models/dir/phone_number_create_params.rbs +0 -38
  178. data/sig/telnyx/models/dir/phone_number_create_response.rbs +0 -16
  179. data/sig/telnyx/models/dir/phone_number_delete_all_response.rbs +0 -86
  180. data/sig/telnyx/models/dir_loa_params.rbs +0 -61
  181. data/sig/telnyx/models/dir_retrieve_document_types_params.rbs +0 -15
  182. data/sig/telnyx/models/dir_retrieve_document_types_response.rbs +0 -41
  183. data/sig/telnyx/models/dir_retrieve_infringement_claims_params.rbs +0 -36
  184. data/sig/telnyx/models/dir_retrieve_infringement_claims_response.rbs +0 -25
  185. data/sig/telnyx/models/dir_update_infringement_update_params.rbs +0 -111
  186. data/sig/telnyx/models/enterprises/reputation/loa_create_params.rbs +0 -135
@@ -1,103 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module Dir
6
- # @see Telnyx::Resources::Dir::PhoneNumbers#delete_all
7
- class PhoneNumberDeleteAllResponse < Telnyx::Internal::Type::BaseModel
8
- # @!attribute data
9
- # Phone numbers that were successfully soft-deleted. Bare E.164 strings.
10
- #
11
- # @return [Array<String>]
12
- required :data, Telnyx::Internal::Type::ArrayOf[String]
13
-
14
- # @!attribute meta
15
- #
16
- # @return [Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta]
17
- required :meta, -> { Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta }
18
-
19
- # @!method initialize(data:, meta:)
20
- # Bulk-delete partial-success response. `data` is the list of phone numbers that
21
- # were soft-deleted. `meta.errors` holds per-number failures (e.g. number not
22
- # associated with this DIR). When EVERY number in the request fails, the endpoint
23
- # instead returns 400 with the canonical Telnyx error envelope and `data`/`meta`
24
- # are absent.
25
- #
26
- # @param data [Array<String>] Phone numbers that were successfully soft-deleted. Bare E.164 strings.
27
- #
28
- # @param meta [Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta]
29
-
30
- # @see Telnyx::Models::Dir::PhoneNumberDeleteAllResponse#meta
31
- class Meta < Telnyx::Internal::Type::BaseModel
32
- # @!attribute errors
33
- # Per-number failures that did not block the call. Each entry has `phone_number`,
34
- # `code`, `title`, `detail`.
35
- #
36
- # @return [Array<Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error>]
37
- required :errors,
38
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error] }
39
-
40
- # @!method initialize(errors:)
41
- # Some parameter documentations has been truncated, see
42
- # {Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta} for more details.
43
- #
44
- # @param errors [Array<Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error>] Per-number failures that did not block the call. Each entry has `phone_number`,
45
-
46
- class Error < Telnyx::Internal::Type::BaseModel
47
- # @!attribute code
48
- # Stable per-number error code. Currently only `not_associated` is emitted, when
49
- # the number is not attached to this DIR.
50
- #
51
- # @return [Symbol, Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error::Code]
52
- required :code, enum: -> { Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error::Code }
53
-
54
- # @!attribute detail
55
- #
56
- # @return [String]
57
- required :detail, String
58
-
59
- # @!attribute phone_number
60
- #
61
- # @return [String]
62
- required :phone_number, String
63
-
64
- # @!attribute title
65
- #
66
- # @return [String]
67
- required :title, String
68
-
69
- # @!method initialize(code:, detail:, phone_number:, title:)
70
- # Some parameter documentations has been truncated, see
71
- # {Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error} for more
72
- # details.
73
- #
74
- # Per-number error returned by the bulk-delete endpoint. Bulk-add does not use
75
- # this shape - it returns a 400 with the canonical envelope grouping numbers by
76
- # failure category.
77
- #
78
- # @param code [Symbol, Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error::Code] Stable per-number error code. Currently only `not_associated` is emitted, when t
79
- #
80
- # @param detail [String]
81
- #
82
- # @param phone_number [String]
83
- #
84
- # @param title [String]
85
-
86
- # Stable per-number error code. Currently only `not_associated` is emitted, when
87
- # the number is not attached to this DIR.
88
- #
89
- # @see Telnyx::Models::Dir::PhoneNumberDeleteAllResponse::Meta::Error#code
90
- module Code
91
- extend Telnyx::Internal::Type::Enum
92
-
93
- NOT_ASSOCIATED = :not_associated
94
-
95
- # @!method self.values
96
- # @return [Array<Symbol>]
97
- end
98
- end
99
- end
100
- end
101
- end
102
- end
103
- end
@@ -1,79 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- # @see Telnyx::Resources::Dir#loa
6
- class DirLoaParams < Telnyx::Internal::Type::BaseModel
7
- extend Telnyx::Internal::Type::RequestParameters::Converter
8
- include Telnyx::Internal::Type::RequestParameters
9
-
10
- # @!attribute dir_id
11
- #
12
- # @return [String]
13
- required :dir_id, String
14
-
15
- # @!attribute phone_numbers
16
- # Telephone numbers to authorize on the DIR, in `+E164` format (`+` followed by
17
- # 10-15 digits). Max 15 per request.
18
- #
19
- # @return [Array<String>]
20
- required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
21
-
22
- # @!attribute agent
23
- # Third-party reseller / partner managing the enterprise's phone numbers. Omit
24
- # when the enterprise works directly with Telnyx.
25
- #
26
- # @return [Telnyx::Models::Enterprises::Reputation::AgentInput, nil]
27
- optional :agent, -> { Telnyx::Enterprises::Reputation::AgentInput }
28
-
29
- # @!attribute signature
30
- # Optional. When provided the rendered PDF embeds the signature image, printed
31
- # name, and signed-at date. When absent the PDF is returned unsigned so the
32
- # customer can sign externally and upload it via the Documents API.
33
- #
34
- # @return [Telnyx::Models::DirLoaParams::Signature, nil]
35
- optional :signature, -> { Telnyx::DirLoaParams::Signature }
36
-
37
- # @!method initialize(dir_id:, phone_numbers:, agent: nil, signature: nil, request_options: {})
38
- # Some parameter documentations has been truncated, see
39
- # {Telnyx::Models::DirLoaParams} for more details.
40
- #
41
- # @param dir_id [String]
42
- #
43
- # @param phone_numbers [Array<String>] Telephone numbers to authorize on the DIR, in `+E164` format (`+` followed by 10
44
- #
45
- # @param agent [Telnyx::Models::Enterprises::Reputation::AgentInput] Third-party reseller / partner managing the enterprise's phone numbers. Omit whe
46
- #
47
- # @param signature [Telnyx::Models::DirLoaParams::Signature] Optional. When provided the rendered PDF embeds the signature image, printed nam
48
- #
49
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
50
-
51
- class Signature < Telnyx::Internal::Type::BaseModel
52
- # @!attribute image_base64
53
- # PNG image, base64-encoded.
54
- #
55
- # @return [String]
56
- required :image_base64, String
57
-
58
- # @!attribute signer_name
59
- # Optional. When absent the rendered PDF falls back to the enterprise contact's
60
- # legal name.
61
- #
62
- # @return [String, nil]
63
- optional :signer_name, String, nil?: true
64
-
65
- # @!method initialize(image_base64:, signer_name: nil)
66
- # Some parameter documentations has been truncated, see
67
- # {Telnyx::Models::DirLoaParams::Signature} for more details.
68
- #
69
- # Optional. When provided the rendered PDF embeds the signature image, printed
70
- # name, and signed-at date. When absent the PDF is returned unsigned so the
71
- # customer can sign externally and upload it via the Documents API.
72
- #
73
- # @param image_base64 [String] PNG image, base64-encoded.
74
- #
75
- # @param signer_name [String, nil] Optional. When absent the rendered PDF falls back to the enterprise contact's le
76
- end
77
- end
78
- end
79
- end
@@ -1,14 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- # @see Telnyx::Resources::Dir#retrieve_document_types
6
- class DirRetrieveDocumentTypesParams < Telnyx::Internal::Type::BaseModel
7
- extend Telnyx::Internal::Type::RequestParameters::Converter
8
- include Telnyx::Internal::Type::RequestParameters
9
-
10
- # @!method initialize(request_options: {})
11
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
12
- end
13
- end
14
- end
@@ -1,51 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- # @see Telnyx::Resources::Dir#retrieve_document_types
6
- class DirRetrieveDocumentTypesResponse < Telnyx::Internal::Type::BaseModel
7
- # @!attribute data
8
- #
9
- # @return [Array<Telnyx::Models::DirRetrieveDocumentTypesResponse::Data>]
10
- required :data,
11
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::DirRetrieveDocumentTypesResponse::Data] }
12
-
13
- # @!attribute meta
14
- # JSON:API pagination metadata returned with every paginated list response. Page
15
- # numbering is 1-based. `page_size` reports the number of items actually returned
16
- # in `data` for this page; the requested size is taken from the `page[size]` query
17
- # parameter.
18
- #
19
- # @return [Telnyx::Models::BrandedCallingPaginationMeta]
20
- required :meta, -> { Telnyx::BrandedCallingPaginationMeta }
21
-
22
- # @!method initialize(data:, meta:)
23
- # Some parameter documentations has been truncated, see
24
- # {Telnyx::Models::DirRetrieveDocumentTypesResponse} for more details.
25
- #
26
- # @param data [Array<Telnyx::Models::DirRetrieveDocumentTypesResponse::Data>]
27
- #
28
- # @param meta [Telnyx::Models::BrandedCallingPaginationMeta] JSON:API pagination metadata returned with every paginated list response. Page n
29
-
30
- class Data < Telnyx::Internal::Type::BaseModel
31
- # @!attribute description
32
- #
33
- # @return [String, nil]
34
- optional :description, String
35
-
36
- # @!attribute short_name
37
- # Stable identifier passed to `Document.document_type`.
38
- #
39
- # @return [String, nil]
40
- optional :short_name, String
41
-
42
- # @!method initialize(description: nil, short_name: nil)
43
- # Single supported document type.
44
- #
45
- # @param description [String]
46
- #
47
- # @param short_name [String] Stable identifier passed to `Document.document_type`.
48
- end
49
- end
50
- end
51
- end
@@ -1,40 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- # @see Telnyx::Resources::Dir#retrieve_infringement_claims
6
- class DirRetrieveInfringementClaimsParams < Telnyx::Internal::Type::BaseModel
7
- extend Telnyx::Internal::Type::RequestParameters::Converter
8
- include Telnyx::Internal::Type::RequestParameters
9
-
10
- # @!attribute dir_id
11
- #
12
- # @return [String]
13
- required :dir_id, String
14
-
15
- # @!attribute page_number
16
- # 1-based page number. Out-of-range values return an empty page with correct meta.
17
- #
18
- # @return [Integer, nil]
19
- optional :page_number, Integer
20
-
21
- # @!attribute page_size
22
- # Items per page. Maximum 250; values above are clamped to 250.
23
- #
24
- # @return [Integer, nil]
25
- optional :page_size, Integer
26
-
27
- # @!method initialize(dir_id:, page_number: nil, page_size: nil, request_options: {})
28
- # Some parameter documentations has been truncated, see
29
- # {Telnyx::Models::DirRetrieveInfringementClaimsParams} for more details.
30
- #
31
- # @param dir_id [String]
32
- #
33
- # @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
34
- #
35
- # @param page_size [Integer] Items per page. Maximum 250; values above are clamped to 250.
36
- #
37
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
38
- end
39
- end
40
- end
@@ -1,30 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- # @see Telnyx::Resources::Dir#retrieve_infringement_claims
6
- class DirRetrieveInfringementClaimsResponse < Telnyx::Internal::Type::BaseModel
7
- # @!attribute data
8
- #
9
- # @return [Array<Telnyx::Models::InfringementClaim>]
10
- required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InfringementClaim] }
11
-
12
- # @!attribute meta
13
- # JSON:API pagination metadata returned with every paginated list response. Page
14
- # numbering is 1-based. `page_size` reports the number of items actually returned
15
- # in `data` for this page; the requested size is taken from the `page[size]` query
16
- # parameter.
17
- #
18
- # @return [Telnyx::Models::BrandedCallingPaginationMeta]
19
- required :meta, -> { Telnyx::BrandedCallingPaginationMeta }
20
-
21
- # @!method initialize(data:, meta:)
22
- # Some parameter documentations has been truncated, see
23
- # {Telnyx::Models::DirRetrieveInfringementClaimsResponse} for more details.
24
- #
25
- # @param data [Array<Telnyx::Models::InfringementClaim>]
26
- #
27
- # @param meta [Telnyx::Models::BrandedCallingPaginationMeta] JSON:API pagination metadata returned with every paginated list response. Page n
28
- end
29
- end
30
- end
@@ -1,134 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- # @see Telnyx::Resources::Dir#update_infringement_update
6
- class DirUpdateInfringementUpdateParams < Telnyx::Internal::Type::BaseModel
7
- extend Telnyx::Internal::Type::RequestParameters::Converter
8
- include Telnyx::Internal::Type::RequestParameters
9
-
10
- # @!attribute dir_id
11
- #
12
- # @return [String]
13
- required :dir_id, String
14
-
15
- # @!attribute certify_brand_is_accurate
16
- # Must be `true`.
17
- #
18
- # @return [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyBrandIsAccurate]
19
- required :certify_brand_is_accurate,
20
- enum: -> { Telnyx::DirUpdateInfringementUpdateParams::CertifyBrandIsAccurate }
21
-
22
- # @!attribute certify_ip_ownership
23
- # Must be `true`.
24
- #
25
- # @return [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyIPOwnership]
26
- required :certify_ip_ownership, enum: -> { Telnyx::DirUpdateInfringementUpdateParams::CertifyIPOwnership }
27
-
28
- # @!attribute certify_no_infringement
29
- # Must be `true`.
30
- #
31
- # @return [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyNoInfringement]
32
- required :certify_no_infringement,
33
- enum: -> { Telnyx::DirUpdateInfringementUpdateParams::CertifyNoInfringement }
34
-
35
- # @!attribute certify_no_shaft_content
36
- # Must be `true`.
37
- #
38
- # @return [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyNoShaftContent]
39
- required :certify_no_shaft_content,
40
- enum: -> { Telnyx::DirUpdateInfringementUpdateParams::CertifyNoShaftContent }
41
-
42
- # @!attribute infringement_resolution_notes
43
- # Explanation of how the infringement concern was addressed.
44
- #
45
- # @return [String]
46
- required :infringement_resolution_notes, String
47
-
48
- # @!attribute call_reasons
49
- #
50
- # @return [Array<String>, nil]
51
- optional :call_reasons, Telnyx::Internal::Type::ArrayOf[String], nil?: true
52
-
53
- # @!attribute display_name
54
- #
55
- # @return [String, nil]
56
- optional :display_name, String, nil?: true
57
-
58
- # @!attribute documents
59
- # Append-only supporting documents.
60
- #
61
- # @return [Array<Telnyx::Models::Document>, nil]
62
- optional :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Document] }, nil?: true
63
-
64
- # @!attribute logo_url
65
- # Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
66
- #
67
- # @return [String, nil]
68
- optional :logo_url, String, nil?: true
69
-
70
- # @!method initialize(dir_id:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_infringement:, certify_no_shaft_content:, infringement_resolution_notes:, call_reasons: nil, display_name: nil, documents: nil, logo_url: nil, request_options: {})
71
- # @param dir_id [String]
72
- #
73
- # @param certify_brand_is_accurate [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyBrandIsAccurate] Must be `true`.
74
- #
75
- # @param certify_ip_ownership [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyIPOwnership] Must be `true`.
76
- #
77
- # @param certify_no_infringement [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyNoInfringement] Must be `true`.
78
- #
79
- # @param certify_no_shaft_content [Boolean, Telnyx::Models::DirUpdateInfringementUpdateParams::CertifyNoShaftContent] Must be `true`.
80
- #
81
- # @param infringement_resolution_notes [String] Explanation of how the infringement concern was addressed.
82
- #
83
- # @param call_reasons [Array<String>, nil]
84
- #
85
- # @param display_name [String, nil]
86
- #
87
- # @param documents [Array<Telnyx::Models::Document>, nil] Append-only supporting documents.
88
- #
89
- # @param logo_url [String, nil] Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
90
- #
91
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
92
-
93
- # Must be `true`.
94
- module CertifyBrandIsAccurate
95
- extend Telnyx::Internal::Type::Enum
96
-
97
- TRUE = true
98
-
99
- # @!method self.values
100
- # @return [Array<Boolean>]
101
- end
102
-
103
- # Must be `true`.
104
- module CertifyIPOwnership
105
- extend Telnyx::Internal::Type::Enum
106
-
107
- TRUE = true
108
-
109
- # @!method self.values
110
- # @return [Array<Boolean>]
111
- end
112
-
113
- # Must be `true`.
114
- module CertifyNoInfringement
115
- extend Telnyx::Internal::Type::Enum
116
-
117
- TRUE = true
118
-
119
- # @!method self.values
120
- # @return [Array<Boolean>]
121
- end
122
-
123
- # Must be `true`.
124
- module CertifyNoShaftContent
125
- extend Telnyx::Internal::Type::Enum
126
-
127
- TRUE = true
128
-
129
- # @!method self.values
130
- # @return [Array<Boolean>]
131
- end
132
- end
133
- end
134
- end
@@ -1,146 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module Enterprises
6
- module Reputation
7
- # @see Telnyx::Resources::Enterprises::Reputation::Loa#create
8
- class LoaCreateParams < Telnyx::Internal::Type::BaseModel
9
- extend Telnyx::Internal::Type::RequestParameters::Converter
10
- include Telnyx::Internal::Type::RequestParameters
11
-
12
- # @!attribute enterprise_id
13
- #
14
- # @return [String]
15
- required :enterprise_id, String
16
-
17
- # @!attribute agent
18
- # Third-party reseller / partner managing the enterprise's phone numbers. Omit
19
- # when the enterprise works directly with Telnyx.
20
- #
21
- # @return [Telnyx::Models::Enterprises::Reputation::LoaCreateParams::Agent, nil]
22
- optional :agent, -> { Telnyx::Enterprises::Reputation::LoaCreateParams::Agent }
23
-
24
- # @!attribute signature
25
- # Optional signature embedded in the rendered PDF. When omitted the PDF is
26
- # returned unsigned for the customer to sign and upload.
27
- #
28
- # @return [Telnyx::Models::Enterprises::Reputation::LoaCreateParams::Signature, nil]
29
- optional :signature, -> { Telnyx::Enterprises::Reputation::LoaCreateParams::Signature }
30
-
31
- # @!method initialize(enterprise_id:, agent: nil, signature: nil, request_options: {})
32
- # Some parameter documentations has been truncated, see
33
- # {Telnyx::Models::Enterprises::Reputation::LoaCreateParams} for more details.
34
- #
35
- # @param enterprise_id [String]
36
- #
37
- # @param agent [Telnyx::Models::Enterprises::Reputation::LoaCreateParams::Agent] Third-party reseller / partner managing the enterprise's phone numbers. Omit whe
38
- #
39
- # @param signature [Telnyx::Models::Enterprises::Reputation::LoaCreateParams::Signature] Optional signature embedded in the rendered PDF. When omitted the PDF is returne
40
- #
41
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
42
-
43
- class Agent < Telnyx::Internal::Type::BaseModel
44
- # @!attribute administrative_area
45
- #
46
- # @return [String]
47
- required :administrative_area, String
48
-
49
- # @!attribute city
50
- #
51
- # @return [String]
52
- required :city, String
53
-
54
- # @!attribute contact_email
55
- #
56
- # @return [String]
57
- required :contact_email, String
58
-
59
- # @!attribute contact_name
60
- #
61
- # @return [String]
62
- required :contact_name, String
63
-
64
- # @!attribute contact_phone
65
- #
66
- # @return [String]
67
- required :contact_phone, String
68
-
69
- # @!attribute contact_title
70
- #
71
- # @return [String]
72
- required :contact_title, String
73
-
74
- # @!attribute country
75
- #
76
- # @return [String]
77
- required :country, String
78
-
79
- # @!attribute legal_name
80
- #
81
- # @return [String]
82
- required :legal_name, String
83
-
84
- # @!attribute postal_code
85
- #
86
- # @return [String]
87
- required :postal_code, String
88
-
89
- # @!attribute street_address
90
- #
91
- # @return [String]
92
- required :street_address, String
93
-
94
- # @!attribute dba
95
- #
96
- # @return [String, nil]
97
- optional :dba, String, nil?: true
98
-
99
- # @!attribute extended_address
100
- #
101
- # @return [String, nil]
102
- optional :extended_address, String, nil?: true
103
-
104
- # @!method initialize(administrative_area:, city:, contact_email:, contact_name:, contact_phone:, contact_title:, country:, legal_name:, postal_code:, street_address:, dba: nil, extended_address: nil)
105
- # Third-party reseller / partner managing the enterprise's phone numbers. Omit
106
- # when the enterprise works directly with Telnyx.
107
- #
108
- # @param administrative_area [String]
109
- # @param city [String]
110
- # @param contact_email [String]
111
- # @param contact_name [String]
112
- # @param contact_phone [String]
113
- # @param contact_title [String]
114
- # @param country [String]
115
- # @param legal_name [String]
116
- # @param postal_code [String]
117
- # @param street_address [String]
118
- # @param dba [String, nil]
119
- # @param extended_address [String, nil]
120
- end
121
-
122
- class Signature < Telnyx::Internal::Type::BaseModel
123
- # @!attribute image_base64
124
- # Base64-encoded signature image.
125
- #
126
- # @return [String]
127
- required :image_base64, String
128
-
129
- # @!attribute signer_name
130
- #
131
- # @return [String, nil]
132
- optional :signer_name, String, nil?: true
133
-
134
- # @!method initialize(image_base64:, signer_name: nil)
135
- # Optional signature embedded in the rendered PDF. When omitted the PDF is
136
- # returned unsigned for the customer to sign and upload.
137
- #
138
- # @param image_base64 [String] Base64-encoded signature image.
139
- #
140
- # @param signer_name [String, nil]
141
- end
142
- end
143
- end
144
- end
145
- end
146
- end
@@ -1,38 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module Enterprises
6
- module Reputation
7
- # @see Telnyx::Resources::Enterprises::Reputation::Loa#patch_all
8
- class LoaPatchAllParams < Telnyx::Internal::Type::BaseModel
9
- extend Telnyx::Internal::Type::RequestParameters::Converter
10
- include Telnyx::Internal::Type::RequestParameters
11
-
12
- # @!attribute enterprise_id
13
- #
14
- # @return [String]
15
- required :enterprise_id, String
16
-
17
- # @!attribute loa_document_id
18
- # Id of the new signed LOA document (from the Telnyx Documents API). Changing it
19
- # resets LOA approval; the new document must be approved before more numbers can
20
- # be added.
21
- #
22
- # @return [String]
23
- required :loa_document_id, String
24
-
25
- # @!method initialize(enterprise_id:, loa_document_id:, request_options: {})
26
- # Some parameter documentations has been truncated, see
27
- # {Telnyx::Models::Enterprises::Reputation::LoaPatchAllParams} for more details.
28
- #
29
- # @param enterprise_id [String]
30
- #
31
- # @param loa_document_id [String] Id of the new signed LOA document (from the Telnyx Documents API). Changing it r
32
- #
33
- # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
34
- end
35
- end
36
- end
37
- end
38
- end