telnyx 5.151.0 → 5.153.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +7 -533
- data/README.md +1 -1
- data/lib/telnyx/internal/cursor_flat_pagination.rb +106 -0
- data/lib/telnyx/models/advanced_order_create_params.rb +1 -86
- data/lib/telnyx/models/advanced_order_update_requirement_group_params.rb +1 -88
- data/lib/telnyx/models/dir/email_verification_status_wrapped.rb +82 -0
- data/lib/telnyx/models/dir/reference.rb +125 -0
- data/lib/telnyx/models/dir/reference_create_params.rb +43 -0
- data/lib/telnyx/models/dir/reference_input.rb +74 -0
- data/lib/telnyx/models/dir/reference_list.rb +18 -0
- data/lib/telnyx/models/dir/reference_list_params.rb +22 -0
- data/lib/telnyx/models/dir/reference_update_params.rb +103 -0
- data/lib/telnyx/models/dir/reference_update_response.rb +23 -0
- data/lib/telnyx/models/dir/verify_email_confirm_params.rb +31 -0
- data/lib/telnyx/models/dir/verify_email_create_params.rb +22 -0
- data/lib/telnyx/models/dir/verify_email_list_params.rb +22 -0
- data/lib/telnyx/models/dir_update_infringement_params.rb +6 -2
- data/lib/telnyx/models/enterprises/dir_create_params.rb +10 -10
- data/lib/telnyx/models/storage/kv_create_params.rb +24 -0
- data/lib/telnyx/models/storage/kv_delete_params.rb +22 -0
- data/lib/telnyx/models/storage/kv_list_params.rb +32 -0
- data/lib/telnyx/models/storage/kv_namespace.rb +75 -0
- data/lib/telnyx/models/storage/kv_namespace_response_wrapper.rb +18 -0
- data/lib/telnyx/models/storage/kv_retrieve_params.rb +22 -0
- data/lib/telnyx/models/storage/kvs/key_delete_params.rb +30 -0
- data/lib/telnyx/models/storage/kvs/key_list_params.rb +49 -0
- data/lib/telnyx/models/storage/kvs/key_list_response.rb +35 -0
- data/lib/telnyx/models/storage/kvs/key_retrieve_params.rb +30 -0
- data/lib/telnyx/models/storage/kvs/key_update_params.rb +53 -0
- data/lib/telnyx/models/uac_inbound.rb +25 -1
- data/lib/telnyx/models/uac_inbound_request.rb +25 -1
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rb +31 -0
- data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rb +54 -0
- data/lib/telnyx/resources/dir/references.rb +139 -0
- data/lib/telnyx/resources/dir/verify_email.rb +91 -0
- data/lib/telnyx/resources/dir.rb +17 -1
- data/lib/telnyx/resources/documents.rb +1 -1
- data/lib/telnyx/resources/enterprises/dir.rb +3 -3
- data/lib/telnyx/resources/storage/kvs/keys.rb +155 -0
- data/lib/telnyx/resources/storage/kvs.rb +115 -0
- data/lib/telnyx/resources/storage.rb +5 -0
- data/lib/telnyx/resources/whatsapp/phone_numbers.rb +27 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +29 -2
- data/rbi/telnyx/internal/cursor_flat_pagination.rbi +48 -0
- data/rbi/telnyx/models/advanced_order_create_params.rbi +4 -198
- data/rbi/telnyx/models/advanced_order_update_requirement_group_params.rbi +2 -219
- data/rbi/telnyx/models/ai/assistant_get_texml_response.rbi +1 -1
- data/rbi/telnyx/models/ai/assistants/instruction_enhance_response.rbi +1 -1
- data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi +184 -0
- data/rbi/telnyx/models/dir/reference.rbi +162 -0
- data/rbi/telnyx/models/dir/reference_create_params.rbi +66 -0
- data/rbi/telnyx/models/dir/reference_input.rbi +93 -0
- data/rbi/telnyx/models/dir/reference_list.rbi +29 -0
- data/rbi/telnyx/models/dir/reference_list_params.rbi +37 -0
- data/rbi/telnyx/models/dir/reference_update_params.rbi +154 -0
- data/rbi/telnyx/models/dir/reference_update_response.rbi +39 -0
- data/rbi/telnyx/models/dir/verify_email_confirm_params.rbi +54 -0
- data/rbi/telnyx/models/dir/verify_email_create_params.rbi +40 -0
- data/rbi/telnyx/models/dir/verify_email_list_params.rbi +37 -0
- data/rbi/telnyx/models/dir_update_infringement_params.rbi +4 -2
- data/rbi/telnyx/models/enterprises/dir_create_params.rbi +10 -13
- data/rbi/telnyx/models/messaging_profiles/autoresp_config_delete_response.rbi +1 -1
- data/rbi/telnyx/models/storage/kv_create_params.rbi +42 -0
- data/rbi/telnyx/models/storage/kv_delete_params.rbi +37 -0
- data/rbi/telnyx/models/storage/kv_list_params.rbi +59 -0
- data/rbi/telnyx/models/storage/kv_namespace.rbi +131 -0
- data/rbi/telnyx/models/storage/kv_namespace_response_wrapper.rbi +35 -0
- data/rbi/telnyx/models/storage/kv_retrieve_params.rbi +37 -0
- data/rbi/telnyx/models/storage/kvs/key_delete_params.rbi +50 -0
- data/rbi/telnyx/models/storage/kvs/key_list_params.rbi +81 -0
- data/rbi/telnyx/models/storage/kvs/key_list_response.rbi +59 -0
- data/rbi/telnyx/models/storage/kvs/key_retrieve_params.rbi +50 -0
- data/rbi/telnyx/models/storage/kvs/key_update_params.rbi +77 -0
- data/rbi/telnyx/models/sub_number_orders_report_download_response.rbi +1 -1
- data/rbi/telnyx/models/telephony_credential_create_token_response.rbi +1 -1
- data/rbi/telnyx/models/uac_inbound.rbi +36 -0
- data/rbi/telnyx/models/uac_inbound_request.rbi +39 -0
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rbi +54 -0
- data/rbi/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbi +125 -0
- data/rbi/telnyx/models/wireguard_peer_retrieve_config_response.rbi +1 -1
- data/rbi/telnyx/resources/dir/references.rbi +114 -0
- data/rbi/telnyx/resources/dir/verify_email.rbi +70 -0
- data/rbi/telnyx/resources/dir.rbi +13 -1
- data/rbi/telnyx/resources/enterprises/dir.rbi +4 -4
- data/rbi/telnyx/resources/storage/kvs/keys.rbi +122 -0
- data/rbi/telnyx/resources/storage/kvs.rbi +87 -0
- data/rbi/telnyx/resources/storage.rbi +4 -0
- data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +21 -0
- data/sig/telnyx/internal/cursor_flat_pagination.rbs +28 -0
- data/sig/telnyx/models/advanced_order_create_params.rbs +3 -99
- data/sig/telnyx/models/advanced_order_update_requirement_group_params.rbs +3 -94
- data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs +69 -0
- data/sig/telnyx/models/dir/reference.rbs +88 -0
- data/sig/telnyx/models/dir/reference_create_params.rbs +38 -0
- data/sig/telnyx/models/dir/reference_input.rbs +52 -0
- data/sig/telnyx/models/dir/reference_list.rbs +15 -0
- data/sig/telnyx/models/dir/reference_list_params.rbs +25 -0
- data/sig/telnyx/models/dir/reference_update_params.rbs +92 -0
- data/sig/telnyx/models/dir/reference_update_response.rbs +15 -0
- data/sig/telnyx/models/dir/verify_email_confirm_params.rbs +30 -0
- data/sig/telnyx/models/dir/verify_email_create_params.rbs +25 -0
- data/sig/telnyx/models/dir/verify_email_list_params.rbs +25 -0
- data/sig/telnyx/models/enterprises/dir_create_params.rbs +5 -7
- data/sig/telnyx/models/storage/kv_create_params.rbs +25 -0
- data/sig/telnyx/models/storage/kv_delete_params.rbs +22 -0
- data/sig/telnyx/models/storage/kv_list_params.rbs +34 -0
- data/sig/telnyx/models/storage/kv_namespace.rbs +80 -0
- data/sig/telnyx/models/storage/kv_namespace_response_wrapper.rbs +20 -0
- data/sig/telnyx/models/storage/kv_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/storage/kvs/key_delete_params.rbs +32 -0
- data/sig/telnyx/models/storage/kvs/key_list_params.rbs +46 -0
- data/sig/telnyx/models/storage/kvs/key_list_response.rbs +32 -0
- data/sig/telnyx/models/storage/kvs/key_retrieve_params.rbs +32 -0
- data/sig/telnyx/models/storage/kvs/key_update_params.rbs +47 -0
- data/sig/telnyx/models/uac_inbound.rbs +21 -0
- data/sig/telnyx/models/uac_inbound_request.rbs +21 -0
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rbs +30 -0
- data/sig/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbs +66 -0
- data/sig/telnyx/resources/dir/references.rbs +35 -0
- data/sig/telnyx/resources/dir/verify_email.rbs +25 -0
- data/sig/telnyx/resources/dir.rbs +4 -0
- data/sig/telnyx/resources/enterprises/dir.rbs +1 -1
- data/sig/telnyx/resources/storage/kvs/keys.rbs +39 -0
- data/sig/telnyx/resources/storage/kvs.rbs +32 -0
- data/sig/telnyx/resources/storage.rbs +2 -0
- data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +6 -0
- metadata +89 -2
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class Storage
|
|
6
|
+
class Kvs
|
|
7
|
+
# Read and write keys within a KV namespace
|
|
8
|
+
class Keys
|
|
9
|
+
# Some parameter documentations has been truncated, see
|
|
10
|
+
# {Telnyx::Models::Storage::Kvs::KeyRetrieveParams} for more details.
|
|
11
|
+
#
|
|
12
|
+
# Returns the raw stored value for a key. The response body is the value exactly
|
|
13
|
+
# as it was written; the `Content-Type` header echoes the value's stored content
|
|
14
|
+
# type (defaults to `application/octet-stream`).
|
|
15
|
+
#
|
|
16
|
+
# @overload retrieve(key, id:, request_options: {})
|
|
17
|
+
#
|
|
18
|
+
# @param key [String] Key name. Allowed characters: `a-z A-Z 0-9 - _ / = .`; maximum 256 characters; n
|
|
19
|
+
#
|
|
20
|
+
# @param id [String] KV namespace ID
|
|
21
|
+
#
|
|
22
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
23
|
+
#
|
|
24
|
+
# @return [StringIO]
|
|
25
|
+
#
|
|
26
|
+
# @see Telnyx::Models::Storage::Kvs::KeyRetrieveParams
|
|
27
|
+
def retrieve(key, params)
|
|
28
|
+
parsed, options = Telnyx::Storage::Kvs::KeyRetrieveParams.dump_request(params)
|
|
29
|
+
id =
|
|
30
|
+
parsed.delete(:id) do
|
|
31
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
32
|
+
end
|
|
33
|
+
@client.request(
|
|
34
|
+
method: :get,
|
|
35
|
+
path: ["storage/kvs/%1$s/keys/%2$s", id, key],
|
|
36
|
+
headers: {"accept" => "application/octet-stream"},
|
|
37
|
+
model: StringIO,
|
|
38
|
+
options: options
|
|
39
|
+
)
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Some parameter documentations has been truncated, see
|
|
43
|
+
# {Telnyx::Models::Storage::Kvs::KeyUpdateParams} for more details.
|
|
44
|
+
#
|
|
45
|
+
# Creates or replaces the value for a key. The request body is stored verbatim as
|
|
46
|
+
# the value — no base64, no JSON envelope — up to 1 MiB. The request's
|
|
47
|
+
# `Content-Type` header is stored with the value and echoed back on retrieval.
|
|
48
|
+
# Returns `201` when the key is created and `200` when an existing key is updated.
|
|
49
|
+
#
|
|
50
|
+
# @overload update(key, id:, body:, ttl_secs: nil, request_options: {})
|
|
51
|
+
#
|
|
52
|
+
# @param key [String] Path param: Key name. Allowed characters: `a-z A-Z 0-9 - _ / = .`; maximum 256 c
|
|
53
|
+
#
|
|
54
|
+
# @param id [String] Path param: KV namespace ID
|
|
55
|
+
#
|
|
56
|
+
# @param body [Pathname, StringIO, IO, String, Telnyx::FilePart] Body param: Raw value bytes, stored verbatim.
|
|
57
|
+
#
|
|
58
|
+
# @param ttl_secs [Integer] Query param: Time-to-live in seconds. When set, the key expires and is deleted a
|
|
59
|
+
#
|
|
60
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
61
|
+
#
|
|
62
|
+
# @return [nil]
|
|
63
|
+
#
|
|
64
|
+
# @see Telnyx::Models::Storage::Kvs::KeyUpdateParams
|
|
65
|
+
def update(key, params)
|
|
66
|
+
parsed, options = Telnyx::Storage::Kvs::KeyUpdateParams.dump_request(params)
|
|
67
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed.except(:body))
|
|
68
|
+
id =
|
|
69
|
+
parsed.delete(:id) do
|
|
70
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
71
|
+
end
|
|
72
|
+
@client.request(
|
|
73
|
+
method: :put,
|
|
74
|
+
path: ["storage/kvs/%1$s/keys/%2$s", id, key],
|
|
75
|
+
query: query,
|
|
76
|
+
headers: {"content-type" => "application/octet-stream"},
|
|
77
|
+
body: parsed[:body],
|
|
78
|
+
model: NilClass,
|
|
79
|
+
options: options
|
|
80
|
+
)
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Lists the keys in a namespace. Returns key names and metadata only, never
|
|
84
|
+
# values. Results are paginated with `limit` and an opaque `cursor`.
|
|
85
|
+
#
|
|
86
|
+
# @overload list(id, cursor: nil, limit: nil, prefix: nil, request_options: {})
|
|
87
|
+
#
|
|
88
|
+
# @param id [String] KV namespace ID
|
|
89
|
+
#
|
|
90
|
+
# @param cursor [String] Opaque pagination cursor from a previous response's `meta.cursor`.
|
|
91
|
+
#
|
|
92
|
+
# @param limit [Integer] Maximum number of keys to return. Values above 1000 are treated as 1000.
|
|
93
|
+
#
|
|
94
|
+
# @param prefix [String] Return only keys that start with this prefix.
|
|
95
|
+
#
|
|
96
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
97
|
+
#
|
|
98
|
+
# @return [Telnyx::Internal::CursorFlatPagination<Telnyx::Models::Storage::Kvs::KeyListResponse>]
|
|
99
|
+
#
|
|
100
|
+
# @see Telnyx::Models::Storage::Kvs::KeyListParams
|
|
101
|
+
def list(id, params = {})
|
|
102
|
+
parsed, options = Telnyx::Storage::Kvs::KeyListParams.dump_request(params)
|
|
103
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
104
|
+
@client.request(
|
|
105
|
+
method: :get,
|
|
106
|
+
path: ["storage/kvs/%1$s/keys", id],
|
|
107
|
+
query: query,
|
|
108
|
+
page: Telnyx::Internal::CursorFlatPagination,
|
|
109
|
+
model: Telnyx::Models::Storage::Kvs::KeyListResponse,
|
|
110
|
+
options: options
|
|
111
|
+
)
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Some parameter documentations has been truncated, see
|
|
115
|
+
# {Telnyx::Models::Storage::Kvs::KeyDeleteParams} for more details.
|
|
116
|
+
#
|
|
117
|
+
# Deletes a key. Idempotent: deleting a key that does not exist still succeeds.
|
|
118
|
+
# The namespace itself must exist and be provisioned.
|
|
119
|
+
#
|
|
120
|
+
# @overload delete(key, id:, request_options: {})
|
|
121
|
+
#
|
|
122
|
+
# @param key [String] Key name. Allowed characters: `a-z A-Z 0-9 - _ / = .`; maximum 256 characters; n
|
|
123
|
+
#
|
|
124
|
+
# @param id [String] KV namespace ID
|
|
125
|
+
#
|
|
126
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
127
|
+
#
|
|
128
|
+
# @return [nil]
|
|
129
|
+
#
|
|
130
|
+
# @see Telnyx::Models::Storage::Kvs::KeyDeleteParams
|
|
131
|
+
def delete(key, params)
|
|
132
|
+
parsed, options = Telnyx::Storage::Kvs::KeyDeleteParams.dump_request(params)
|
|
133
|
+
id =
|
|
134
|
+
parsed.delete(:id) do
|
|
135
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
136
|
+
end
|
|
137
|
+
@client.request(
|
|
138
|
+
method: :delete,
|
|
139
|
+
path: ["storage/kvs/%1$s/keys/%2$s", id, key],
|
|
140
|
+
model: NilClass,
|
|
141
|
+
options: options
|
|
142
|
+
)
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# @api private
|
|
146
|
+
#
|
|
147
|
+
# @param client [Telnyx::Client]
|
|
148
|
+
def initialize(client:)
|
|
149
|
+
@client = client
|
|
150
|
+
end
|
|
151
|
+
end
|
|
152
|
+
end
|
|
153
|
+
end
|
|
154
|
+
end
|
|
155
|
+
end
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Resources
|
|
5
|
+
class Storage
|
|
6
|
+
# Manage KV storage namespaces
|
|
7
|
+
class Kvs
|
|
8
|
+
# Read and write keys within a KV namespace
|
|
9
|
+
# @return [Telnyx::Resources::Storage::Kvs::Keys]
|
|
10
|
+
attr_reader :keys
|
|
11
|
+
|
|
12
|
+
# Creates a new KV namespace. Provisioning is asynchronous: the namespace is
|
|
13
|
+
# returned with status `pending` and becomes usable once it reaches
|
|
14
|
+
# `provision_ok`.
|
|
15
|
+
#
|
|
16
|
+
# @overload create(name:, request_options: {})
|
|
17
|
+
#
|
|
18
|
+
# @param name [String] Namespace name. May contain lowercase letters, numbers, and hyphens only.
|
|
19
|
+
#
|
|
20
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
21
|
+
#
|
|
22
|
+
# @return [Telnyx::Models::Storage::KvNamespaceResponseWrapper]
|
|
23
|
+
#
|
|
24
|
+
# @see Telnyx::Models::Storage::KvCreateParams
|
|
25
|
+
def create(params)
|
|
26
|
+
parsed, options = Telnyx::Storage::KvCreateParams.dump_request(params)
|
|
27
|
+
@client.request(
|
|
28
|
+
method: :post,
|
|
29
|
+
path: "storage/kvs",
|
|
30
|
+
body: parsed,
|
|
31
|
+
model: Telnyx::Storage::KvNamespaceResponseWrapper,
|
|
32
|
+
options: options
|
|
33
|
+
)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Retrieves a KV namespace by its ID, including its provisioning status.
|
|
37
|
+
#
|
|
38
|
+
# @overload retrieve(id, request_options: {})
|
|
39
|
+
#
|
|
40
|
+
# @param id [String] KV namespace ID
|
|
41
|
+
#
|
|
42
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
43
|
+
#
|
|
44
|
+
# @return [Telnyx::Models::Storage::KvNamespaceResponseWrapper]
|
|
45
|
+
#
|
|
46
|
+
# @see Telnyx::Models::Storage::KvRetrieveParams
|
|
47
|
+
def retrieve(id, params = {})
|
|
48
|
+
@client.request(
|
|
49
|
+
method: :get,
|
|
50
|
+
path: ["storage/kvs/%1$s", id],
|
|
51
|
+
model: Telnyx::Storage::KvNamespaceResponseWrapper,
|
|
52
|
+
options: params[:request_options]
|
|
53
|
+
)
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# Lists the KV namespaces for the authenticated user's organization. Results use
|
|
57
|
+
# page-based pagination (`page[number]`/`page[size]`).
|
|
58
|
+
#
|
|
59
|
+
# @overload list(page_number: nil, page_size: nil, request_options: {})
|
|
60
|
+
#
|
|
61
|
+
# @param page_number [Integer] The page number to load.
|
|
62
|
+
#
|
|
63
|
+
# @param page_size [Integer] The size of the page. Values above 250 are treated as 250.
|
|
64
|
+
#
|
|
65
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
66
|
+
#
|
|
67
|
+
# @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Storage::KvNamespace>]
|
|
68
|
+
#
|
|
69
|
+
# @see Telnyx::Models::Storage::KvListParams
|
|
70
|
+
def list(params = {})
|
|
71
|
+
parsed, options = Telnyx::Storage::KvListParams.dump_request(params)
|
|
72
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
73
|
+
@client.request(
|
|
74
|
+
method: :get,
|
|
75
|
+
path: "storage/kvs",
|
|
76
|
+
query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
|
|
77
|
+
page: Telnyx::Internal::DefaultFlatPagination,
|
|
78
|
+
model: Telnyx::Storage::KvNamespace,
|
|
79
|
+
options: options
|
|
80
|
+
)
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Deletes a KV namespace and all of the keys it contains. Deletion is
|
|
84
|
+
# asynchronous: the namespace is returned with status `deleting`. Deleting a
|
|
85
|
+
# namespace whose deletion is already in progress returns a `409`.
|
|
86
|
+
#
|
|
87
|
+
# @overload delete(id, request_options: {})
|
|
88
|
+
#
|
|
89
|
+
# @param id [String] KV namespace ID
|
|
90
|
+
#
|
|
91
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
92
|
+
#
|
|
93
|
+
# @return [Telnyx::Models::Storage::KvNamespaceResponseWrapper]
|
|
94
|
+
#
|
|
95
|
+
# @see Telnyx::Models::Storage::KvDeleteParams
|
|
96
|
+
def delete(id, params = {})
|
|
97
|
+
@client.request(
|
|
98
|
+
method: :delete,
|
|
99
|
+
path: ["storage/kvs/%1$s", id],
|
|
100
|
+
model: Telnyx::Storage::KvNamespaceResponseWrapper,
|
|
101
|
+
options: params[:request_options]
|
|
102
|
+
)
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# @api private
|
|
106
|
+
#
|
|
107
|
+
# @param client [Telnyx::Client]
|
|
108
|
+
def initialize(client:)
|
|
109
|
+
@client = client
|
|
110
|
+
@keys = Telnyx::Resources::Storage::Kvs::Keys.new(client: client)
|
|
111
|
+
end
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
end
|
|
@@ -16,6 +16,10 @@ module Telnyx
|
|
|
16
16
|
# @return [Telnyx::Resources::Storage::Migrations]
|
|
17
17
|
attr_reader :migrations
|
|
18
18
|
|
|
19
|
+
# Manage KV storage namespaces
|
|
20
|
+
# @return [Telnyx::Resources::Storage::Kvs]
|
|
21
|
+
attr_reader :kvs
|
|
22
|
+
|
|
19
23
|
# List Migration Source coverage
|
|
20
24
|
#
|
|
21
25
|
# @overload list_migration_source_coverage(request_options: {})
|
|
@@ -42,6 +46,7 @@ module Telnyx
|
|
|
42
46
|
@buckets = Telnyx::Resources::Storage::Buckets.new(client: client)
|
|
43
47
|
@migration_sources = Telnyx::Resources::Storage::MigrationSources.new(client: client)
|
|
44
48
|
@migrations = Telnyx::Resources::Storage::Migrations.new(client: client)
|
|
49
|
+
@kvs = Telnyx::Resources::Storage::Kvs.new(client: client)
|
|
45
50
|
end
|
|
46
51
|
end
|
|
47
52
|
end
|
|
@@ -81,6 +81,33 @@ module Telnyx
|
|
|
81
81
|
)
|
|
82
82
|
end
|
|
83
83
|
|
|
84
|
+
# Returns whether the 24-hour conversation window is currently open for a given
|
|
85
|
+
# source/destination pair. If window_active is false, only template messages may
|
|
86
|
+
# be sent.
|
|
87
|
+
#
|
|
88
|
+
# @overload retrieve_conversation_window(phone_number, destination_number:, request_options: {})
|
|
89
|
+
#
|
|
90
|
+
# @param phone_number [String] Phone number (E.164 format)
|
|
91
|
+
#
|
|
92
|
+
# @param destination_number [String] Destination phone number in E.164 format
|
|
93
|
+
#
|
|
94
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
|
+
#
|
|
96
|
+
# @return [Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse]
|
|
97
|
+
#
|
|
98
|
+
# @see Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowParams
|
|
99
|
+
def retrieve_conversation_window(phone_number, params)
|
|
100
|
+
parsed, options = Telnyx::Whatsapp::PhoneNumberRetrieveConversationWindowParams.dump_request(params)
|
|
101
|
+
query = Telnyx::Internal::Util.encode_query_params(parsed)
|
|
102
|
+
@client.request(
|
|
103
|
+
method: :get,
|
|
104
|
+
path: ["v2/whatsapp/phone_numbers/%1$s/conversation_window", phone_number],
|
|
105
|
+
query: query,
|
|
106
|
+
model: Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse,
|
|
107
|
+
options: options
|
|
108
|
+
)
|
|
109
|
+
end
|
|
110
|
+
|
|
84
111
|
# Submit verification code for a phone number
|
|
85
112
|
#
|
|
86
113
|
# @overload verify(phone_number, code:, request_options: {})
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -55,6 +55,7 @@ require_relative "telnyx/internal/transport/base_client"
|
|
|
55
55
|
require_relative "telnyx/internal/transport/pooled_net_requester"
|
|
56
56
|
require_relative "telnyx/client"
|
|
57
57
|
require_relative "telnyx/internal/oauth2"
|
|
58
|
+
require_relative "telnyx/internal/cursor_flat_pagination"
|
|
58
59
|
require_relative "telnyx/internal/default_flat_pagination"
|
|
59
60
|
require_relative "telnyx/internal/default_flat_pagination_for_inexplicit_number_orders"
|
|
60
61
|
require_relative "telnyx/internal/default_flat_pagination_top_level_array"
|
|
@@ -871,6 +872,7 @@ require_relative "telnyx/models/dir/comment_type"
|
|
|
871
872
|
require_relative "telnyx/models/dir/dir_comment"
|
|
872
873
|
require_relative "telnyx/models/dir/dir_phone_number"
|
|
873
874
|
require_relative "telnyx/models/dir/dir_phone_number_status"
|
|
875
|
+
require_relative "telnyx/models/dir/email_verification_status_wrapped"
|
|
874
876
|
require_relative "telnyx/models/dir/phone_number_add_params"
|
|
875
877
|
require_relative "telnyx/models/dir/phone_number_add_response"
|
|
876
878
|
require_relative "telnyx/models/dir/phone_number_batch"
|
|
@@ -880,7 +882,17 @@ require_relative "telnyx/models/dir/phone_number_batch_retrieve_response"
|
|
|
880
882
|
require_relative "telnyx/models/dir/phone_number_list_params"
|
|
881
883
|
require_relative "telnyx/models/dir/phone_number_remove_params"
|
|
882
884
|
require_relative "telnyx/models/dir/phone_number_remove_response"
|
|
885
|
+
require_relative "telnyx/models/dir/reference"
|
|
886
|
+
require_relative "telnyx/models/dir/reference_create_params"
|
|
887
|
+
require_relative "telnyx/models/dir/reference_input"
|
|
888
|
+
require_relative "telnyx/models/dir/reference_list"
|
|
889
|
+
require_relative "telnyx/models/dir/reference_list_params"
|
|
890
|
+
require_relative "telnyx/models/dir/reference_update_params"
|
|
891
|
+
require_relative "telnyx/models/dir/reference_update_response"
|
|
883
892
|
require_relative "telnyx/models/dir/rejection_reason"
|
|
893
|
+
require_relative "telnyx/models/dir/verify_email_confirm_params"
|
|
894
|
+
require_relative "telnyx/models/dir/verify_email_create_params"
|
|
895
|
+
require_relative "telnyx/models/dir/verify_email_list_params"
|
|
884
896
|
require_relative "telnyx/models/dir"
|
|
885
897
|
require_relative "telnyx/models/dir_delete_params"
|
|
886
898
|
require_relative "telnyx/models/dir_list"
|
|
@@ -2147,6 +2159,17 @@ require_relative "telnyx/models/storage/buckets/usage_get_api_usage_params"
|
|
|
2147
2159
|
require_relative "telnyx/models/storage/buckets/usage_get_api_usage_response"
|
|
2148
2160
|
require_relative "telnyx/models/storage/buckets/usage_get_bucket_usage_params"
|
|
2149
2161
|
require_relative "telnyx/models/storage/buckets/usage_get_bucket_usage_response"
|
|
2162
|
+
require_relative "telnyx/models/storage/kv_create_params"
|
|
2163
|
+
require_relative "telnyx/models/storage/kv_delete_params"
|
|
2164
|
+
require_relative "telnyx/models/storage/kv_list_params"
|
|
2165
|
+
require_relative "telnyx/models/storage/kv_namespace"
|
|
2166
|
+
require_relative "telnyx/models/storage/kv_namespace_response_wrapper"
|
|
2167
|
+
require_relative "telnyx/models/storage/kv_retrieve_params"
|
|
2168
|
+
require_relative "telnyx/models/storage/kvs/key_delete_params"
|
|
2169
|
+
require_relative "telnyx/models/storage/kvs/key_list_params"
|
|
2170
|
+
require_relative "telnyx/models/storage/kvs/key_list_response"
|
|
2171
|
+
require_relative "telnyx/models/storage/kvs/key_retrieve_params"
|
|
2172
|
+
require_relative "telnyx/models/storage/kvs/key_update_params"
|
|
2150
2173
|
require_relative "telnyx/models/storage/migration_create_params"
|
|
2151
2174
|
require_relative "telnyx/models/storage/migration_create_response"
|
|
2152
2175
|
require_relative "telnyx/models/storage/migration_list_params"
|
|
@@ -2442,6 +2465,8 @@ require_relative "telnyx/models/whatsapp/phone_number_delete_params"
|
|
|
2442
2465
|
require_relative "telnyx/models/whatsapp/phone_number_list_params"
|
|
2443
2466
|
require_relative "telnyx/models/whatsapp/phone_number_list_response"
|
|
2444
2467
|
require_relative "telnyx/models/whatsapp/phone_number_resend_verification_params"
|
|
2468
|
+
require_relative "telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params"
|
|
2469
|
+
require_relative "telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response"
|
|
2445
2470
|
require_relative "telnyx/models/whatsapp/phone_numbers/calling_setting_retrieve_params"
|
|
2446
2471
|
require_relative "telnyx/models/whatsapp/phone_numbers/calling_setting_retrieve_response"
|
|
2447
2472
|
require_relative "telnyx/models/whatsapp/phone_numbers/calling_setting_update_params"
|
|
@@ -2614,6 +2639,8 @@ require_relative "telnyx/resources/dir"
|
|
|
2614
2639
|
require_relative "telnyx/resources/dir/comments"
|
|
2615
2640
|
require_relative "telnyx/resources/dir/phone_number_batches"
|
|
2616
2641
|
require_relative "telnyx/resources/dir/phone_numbers"
|
|
2642
|
+
require_relative "telnyx/resources/dir/references"
|
|
2643
|
+
require_relative "telnyx/resources/dir/verify_email"
|
|
2617
2644
|
require_relative "telnyx/resources/document_links"
|
|
2618
2645
|
require_relative "telnyx/resources/documents"
|
|
2619
2646
|
require_relative "telnyx/resources/dynamic_emergency_addresses"
|
|
@@ -2805,6 +2832,8 @@ require_relative "telnyx/resources/storage"
|
|
|
2805
2832
|
require_relative "telnyx/resources/storage/buckets"
|
|
2806
2833
|
require_relative "telnyx/resources/storage/buckets/ssl_certificate"
|
|
2807
2834
|
require_relative "telnyx/resources/storage/buckets/usage"
|
|
2835
|
+
require_relative "telnyx/resources/storage/kvs"
|
|
2836
|
+
require_relative "telnyx/resources/storage/kvs/keys"
|
|
2808
2837
|
require_relative "telnyx/resources/storage/migrations"
|
|
2809
2838
|
require_relative "telnyx/resources/storage/migrations/actions"
|
|
2810
2839
|
require_relative "telnyx/resources/storage/migration_sources"
|
|
@@ -2872,6 +2901,4 @@ require_relative "telnyx/resources/wireless_blocklist_values"
|
|
|
2872
2901
|
require_relative "telnyx/resources/x402"
|
|
2873
2902
|
require_relative "telnyx/resources/x402/credit_account"
|
|
2874
2903
|
|
|
2875
|
-
# Custom lib entry point — preserved across codegen.
|
|
2876
|
-
# If this line is lost after a Stainless codegen run, it must be re-added.
|
|
2877
2904
|
require_relative "telnyx/lib"
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Internal
|
|
5
|
+
class CursorFlatPagination
|
|
6
|
+
include Telnyx::Internal::Type::BasePage
|
|
7
|
+
|
|
8
|
+
Elem = type_member
|
|
9
|
+
|
|
10
|
+
sig { returns(T.nilable(T::Array[Elem])) }
|
|
11
|
+
attr_accessor :data
|
|
12
|
+
|
|
13
|
+
sig { returns(Meta) }
|
|
14
|
+
attr_accessor :meta
|
|
15
|
+
|
|
16
|
+
# @api private
|
|
17
|
+
sig { returns(String) }
|
|
18
|
+
def inspect
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
class Meta < Telnyx::Internal::Type::BaseModel
|
|
22
|
+
OrHash = T.type_alias { T.any(Meta, Telnyx::Internal::AnyHash) }
|
|
23
|
+
|
|
24
|
+
sig { returns(T.nilable(String)) }
|
|
25
|
+
attr_reader :cursor
|
|
26
|
+
|
|
27
|
+
sig { params(cursor: String).void }
|
|
28
|
+
attr_writer :cursor
|
|
29
|
+
|
|
30
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
31
|
+
attr_reader :has_more
|
|
32
|
+
|
|
33
|
+
sig { params(has_more: T::Boolean).void }
|
|
34
|
+
attr_writer :has_more
|
|
35
|
+
|
|
36
|
+
sig do
|
|
37
|
+
params(cursor: String, has_more: T::Boolean).returns(T.attached_class)
|
|
38
|
+
end
|
|
39
|
+
def self.new(cursor: nil, has_more: nil)
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
sig { override.returns({ cursor: String, has_more: T::Boolean }) }
|
|
43
|
+
def to_hash
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
@@ -11,211 +11,17 @@ module Telnyx
|
|
|
11
11
|
T.any(Telnyx::AdvancedOrderCreateParams, Telnyx::Internal::AnyHash)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
sig { returns(T.nilable(String)) }
|
|
15
|
-
attr_reader :area_code
|
|
16
|
-
|
|
17
|
-
sig { params(area_code: String).void }
|
|
18
|
-
attr_writer :area_code
|
|
19
|
-
|
|
20
|
-
sig { returns(T.nilable(String)) }
|
|
21
|
-
attr_reader :comments
|
|
22
|
-
|
|
23
|
-
sig { params(comments: String).void }
|
|
24
|
-
attr_writer :comments
|
|
25
|
-
|
|
26
|
-
sig { returns(T.nilable(String)) }
|
|
27
|
-
attr_reader :country_code
|
|
28
|
-
|
|
29
|
-
sig { params(country_code: String).void }
|
|
30
|
-
attr_writer :country_code
|
|
31
|
-
|
|
32
|
-
sig { returns(T.nilable(String)) }
|
|
33
|
-
attr_reader :customer_reference
|
|
34
|
-
|
|
35
|
-
sig { params(customer_reference: String).void }
|
|
36
|
-
attr_writer :customer_reference
|
|
37
|
-
|
|
38
14
|
sig do
|
|
39
|
-
returns(
|
|
40
|
-
T.
|
|
41
|
-
T::Array[Telnyx::AdvancedOrderCreateParams::Feature::OrSymbol]
|
|
42
|
-
)
|
|
15
|
+
params(request_options: Telnyx::RequestOptions::OrHash).returns(
|
|
16
|
+
T.attached_class
|
|
43
17
|
)
|
|
44
18
|
end
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
sig do
|
|
48
|
-
params(
|
|
49
|
-
features:
|
|
50
|
-
T::Array[Telnyx::AdvancedOrderCreateParams::Feature::OrSymbol]
|
|
51
|
-
).void
|
|
52
|
-
end
|
|
53
|
-
attr_writer :features
|
|
54
|
-
|
|
55
|
-
sig do
|
|
56
|
-
returns(
|
|
57
|
-
T.nilable(
|
|
58
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::OrSymbol
|
|
59
|
-
)
|
|
60
|
-
)
|
|
61
|
-
end
|
|
62
|
-
attr_reader :phone_number_type
|
|
63
|
-
|
|
64
|
-
sig do
|
|
65
|
-
params(
|
|
66
|
-
phone_number_type:
|
|
67
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::OrSymbol
|
|
68
|
-
).void
|
|
69
|
-
end
|
|
70
|
-
attr_writer :phone_number_type
|
|
71
|
-
|
|
72
|
-
sig { returns(T.nilable(Integer)) }
|
|
73
|
-
attr_reader :quantity
|
|
74
|
-
|
|
75
|
-
sig { params(quantity: Integer).void }
|
|
76
|
-
attr_writer :quantity
|
|
77
|
-
|
|
78
|
-
# The ID of the requirement group to associate with this advanced order
|
|
79
|
-
sig { returns(T.nilable(String)) }
|
|
80
|
-
attr_reader :requirement_group_id
|
|
81
|
-
|
|
82
|
-
sig { params(requirement_group_id: String).void }
|
|
83
|
-
attr_writer :requirement_group_id
|
|
84
|
-
|
|
85
|
-
sig do
|
|
86
|
-
params(
|
|
87
|
-
area_code: String,
|
|
88
|
-
comments: String,
|
|
89
|
-
country_code: String,
|
|
90
|
-
customer_reference: String,
|
|
91
|
-
features:
|
|
92
|
-
T::Array[Telnyx::AdvancedOrderCreateParams::Feature::OrSymbol],
|
|
93
|
-
phone_number_type:
|
|
94
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::OrSymbol,
|
|
95
|
-
quantity: Integer,
|
|
96
|
-
requirement_group_id: String,
|
|
97
|
-
request_options: Telnyx::RequestOptions::OrHash
|
|
98
|
-
).returns(T.attached_class)
|
|
99
|
-
end
|
|
100
|
-
def self.new(
|
|
101
|
-
area_code: nil,
|
|
102
|
-
comments: nil,
|
|
103
|
-
country_code: nil,
|
|
104
|
-
customer_reference: nil,
|
|
105
|
-
features: nil,
|
|
106
|
-
phone_number_type: nil,
|
|
107
|
-
quantity: nil,
|
|
108
|
-
# The ID of the requirement group to associate with this advanced order
|
|
109
|
-
requirement_group_id: nil,
|
|
110
|
-
request_options: {}
|
|
111
|
-
)
|
|
19
|
+
def self.new(request_options: {})
|
|
112
20
|
end
|
|
113
21
|
|
|
114
|
-
sig
|
|
115
|
-
override.returns(
|
|
116
|
-
{
|
|
117
|
-
area_code: String,
|
|
118
|
-
comments: String,
|
|
119
|
-
country_code: String,
|
|
120
|
-
customer_reference: String,
|
|
121
|
-
features:
|
|
122
|
-
T::Array[Telnyx::AdvancedOrderCreateParams::Feature::OrSymbol],
|
|
123
|
-
phone_number_type:
|
|
124
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::OrSymbol,
|
|
125
|
-
quantity: Integer,
|
|
126
|
-
requirement_group_id: String,
|
|
127
|
-
request_options: Telnyx::RequestOptions
|
|
128
|
-
}
|
|
129
|
-
)
|
|
130
|
-
end
|
|
22
|
+
sig { override.returns({ request_options: Telnyx::RequestOptions }) }
|
|
131
23
|
def to_hash
|
|
132
24
|
end
|
|
133
|
-
|
|
134
|
-
module Feature
|
|
135
|
-
extend Telnyx::Internal::Type::Enum
|
|
136
|
-
|
|
137
|
-
TaggedSymbol =
|
|
138
|
-
T.type_alias do
|
|
139
|
-
T.all(Symbol, Telnyx::AdvancedOrderCreateParams::Feature)
|
|
140
|
-
end
|
|
141
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
142
|
-
|
|
143
|
-
SMS =
|
|
144
|
-
T.let(:sms, Telnyx::AdvancedOrderCreateParams::Feature::TaggedSymbol)
|
|
145
|
-
MMS =
|
|
146
|
-
T.let(:mms, Telnyx::AdvancedOrderCreateParams::Feature::TaggedSymbol)
|
|
147
|
-
VOICE =
|
|
148
|
-
T.let(
|
|
149
|
-
:voice,
|
|
150
|
-
Telnyx::AdvancedOrderCreateParams::Feature::TaggedSymbol
|
|
151
|
-
)
|
|
152
|
-
FAX =
|
|
153
|
-
T.let(:fax, Telnyx::AdvancedOrderCreateParams::Feature::TaggedSymbol)
|
|
154
|
-
EMERGENCY =
|
|
155
|
-
T.let(
|
|
156
|
-
:emergency,
|
|
157
|
-
Telnyx::AdvancedOrderCreateParams::Feature::TaggedSymbol
|
|
158
|
-
)
|
|
159
|
-
|
|
160
|
-
sig do
|
|
161
|
-
override.returns(
|
|
162
|
-
T::Array[Telnyx::AdvancedOrderCreateParams::Feature::TaggedSymbol]
|
|
163
|
-
)
|
|
164
|
-
end
|
|
165
|
-
def self.values
|
|
166
|
-
end
|
|
167
|
-
end
|
|
168
|
-
|
|
169
|
-
module PhoneNumberType
|
|
170
|
-
extend Telnyx::Internal::Type::Enum
|
|
171
|
-
|
|
172
|
-
TaggedSymbol =
|
|
173
|
-
T.type_alias do
|
|
174
|
-
T.all(Symbol, Telnyx::AdvancedOrderCreateParams::PhoneNumberType)
|
|
175
|
-
end
|
|
176
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
177
|
-
|
|
178
|
-
LOCAL =
|
|
179
|
-
T.let(
|
|
180
|
-
:local,
|
|
181
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::TaggedSymbol
|
|
182
|
-
)
|
|
183
|
-
MOBILE =
|
|
184
|
-
T.let(
|
|
185
|
-
:mobile,
|
|
186
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::TaggedSymbol
|
|
187
|
-
)
|
|
188
|
-
TOLL_FREE =
|
|
189
|
-
T.let(
|
|
190
|
-
:toll_free,
|
|
191
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::TaggedSymbol
|
|
192
|
-
)
|
|
193
|
-
SHARED_COST =
|
|
194
|
-
T.let(
|
|
195
|
-
:shared_cost,
|
|
196
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::TaggedSymbol
|
|
197
|
-
)
|
|
198
|
-
NATIONAL =
|
|
199
|
-
T.let(
|
|
200
|
-
:national,
|
|
201
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::TaggedSymbol
|
|
202
|
-
)
|
|
203
|
-
LANDLINE =
|
|
204
|
-
T.let(
|
|
205
|
-
:landline,
|
|
206
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::TaggedSymbol
|
|
207
|
-
)
|
|
208
|
-
|
|
209
|
-
sig do
|
|
210
|
-
override.returns(
|
|
211
|
-
T::Array[
|
|
212
|
-
Telnyx::AdvancedOrderCreateParams::PhoneNumberType::TaggedSymbol
|
|
213
|
-
]
|
|
214
|
-
)
|
|
215
|
-
end
|
|
216
|
-
def self.values
|
|
217
|
-
end
|
|
218
|
-
end
|
|
219
25
|
end
|
|
220
26
|
end
|
|
221
27
|
end
|