expo_notifier 0.1.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 (113) hide show
  1. checksums.yaml +7 -0
  2. data/.ruby-version +1 -0
  3. data/CHANGELOG.md +3 -0
  4. data/LICENSE.txt +21 -0
  5. data/README.md +172 -0
  6. data/Rakefile +17 -0
  7. data/lib/expo_notifier/mapper/base.rb +30 -0
  8. data/lib/expo_notifier/mapper/error.rb +24 -0
  9. data/lib/expo_notifier/mapper/push_message.rb +132 -0
  10. data/lib/expo_notifier/mapper/push_messages.rb +15 -0
  11. data/lib/expo_notifier/mapper/push_receipt.rb +23 -0
  12. data/lib/expo_notifier/mapper/push_receipt_error_details.rb +23 -0
  13. data/lib/expo_notifier/mapper/push_receipt_ids.rb +16 -0
  14. data/lib/expo_notifier/mapper/push_receipts.rb +38 -0
  15. data/lib/expo_notifier/mapper/push_ticket.rb +30 -0
  16. data/lib/expo_notifier/mapper/push_ticket_error_details.rb +19 -0
  17. data/lib/expo_notifier/mapper/push_tickets.rb +26 -0
  18. data/lib/expo_notifier/mapper/rich_content.rb +17 -0
  19. data/lib/expo_notifier/request/base.rb +162 -0
  20. data/lib/expo_notifier/request/get_push_notification_receipts.rb +18 -0
  21. data/lib/expo_notifier/request/send_push_notifications.rb +26 -0
  22. data/lib/expo_notifier/response.rb +93 -0
  23. data/lib/expo_notifier/sorbet_shim.rb +18 -0
  24. data/lib/expo_notifier/version.rb +6 -0
  25. data/lib/expo_notifier.rb +19 -0
  26. data/sorbet/config +6 -0
  27. data/sorbet/rbi/annotations/.gitattributes +1 -0
  28. data/sorbet/rbi/annotations/activesupport.rbi +495 -0
  29. data/sorbet/rbi/annotations/faraday.rbi +17 -0
  30. data/sorbet/rbi/annotations/minitest.rbi +119 -0
  31. data/sorbet/rbi/annotations/rainbow.rbi +269 -0
  32. data/sorbet/rbi/annotations/webmock.rbi +9 -0
  33. data/sorbet/rbi/dsl/.gitattributes +1 -0
  34. data/sorbet/rbi/dsl/active_support/callbacks.rbi +21 -0
  35. data/sorbet/rbi/dsl/expo_notifier/mapper/base.rbi +12 -0
  36. data/sorbet/rbi/dsl/expo_notifier/mapper/error.rbi +42 -0
  37. data/sorbet/rbi/dsl/expo_notifier/mapper/push_message.rbi +263 -0
  38. data/sorbet/rbi/dsl/expo_notifier/mapper/push_messages.rbi +29 -0
  39. data/sorbet/rbi/dsl/expo_notifier/mapper/push_receipt.rbi +45 -0
  40. data/sorbet/rbi/dsl/expo_notifier/mapper/push_receipt_error_details.rbi +38 -0
  41. data/sorbet/rbi/dsl/expo_notifier/mapper/push_receipt_ids.rbi +20 -0
  42. data/sorbet/rbi/dsl/expo_notifier/mapper/push_receipts.rbi +25 -0
  43. data/sorbet/rbi/dsl/expo_notifier/mapper/push_ticket.rbi +59 -0
  44. data/sorbet/rbi/dsl/expo_notifier/mapper/push_ticket_error_details.rbi +32 -0
  45. data/sorbet/rbi/dsl/expo_notifier/mapper/push_tickets.rbi +54 -0
  46. data/sorbet/rbi/dsl/expo_notifier/mapper/rich_content.rbi +26 -0
  47. data/sorbet/rbi/dsl/time.rbi +13 -0
  48. data/sorbet/rbi/gems/.gitattributes +1 -0
  49. data/sorbet/rbi/gems/activesupport@8.1.1.rbi +22456 -0
  50. data/sorbet/rbi/gems/addressable@2.8.8.rbi +2005 -0
  51. data/sorbet/rbi/gems/ast@2.4.3.rbi +586 -0
  52. data/sorbet/rbi/gems/base64@0.3.0.rbi +545 -0
  53. data/sorbet/rbi/gems/benchmark@0.5.0.rbi +637 -0
  54. data/sorbet/rbi/gems/bigdecimal@4.0.1.rbi +409 -0
  55. data/sorbet/rbi/gems/booleans@0.1.3.rbi +31 -0
  56. data/sorbet/rbi/gems/concurrent-ruby@1.3.6.rbi +11729 -0
  57. data/sorbet/rbi/gems/connection_pool@3.0.2.rbi +9 -0
  58. data/sorbet/rbi/gems/crack@1.0.1.rbi +145 -0
  59. data/sorbet/rbi/gems/date@3.5.1.rbi +403 -0
  60. data/sorbet/rbi/gems/drb@2.2.3.rbi +1661 -0
  61. data/sorbet/rbi/gems/erb@6.0.1.rbi +815 -0
  62. data/sorbet/rbi/gems/erubi@1.13.1.rbi +157 -0
  63. data/sorbet/rbi/gems/faraday-net_http@3.4.2.rbi +72 -0
  64. data/sorbet/rbi/gems/faraday@2.14.0.rbi +3301 -0
  65. data/sorbet/rbi/gems/hashdiff@1.2.1.rbi +355 -0
  66. data/sorbet/rbi/gems/i18n@1.14.8.rbi +2383 -0
  67. data/sorbet/rbi/gems/io-console@0.8.2.rbi +9 -0
  68. data/sorbet/rbi/gems/json@2.18.0.rbi +2278 -0
  69. data/sorbet/rbi/gems/lint_roller@1.1.0.rbi +323 -0
  70. data/sorbet/rbi/gems/logger@1.7.0.rbi +963 -0
  71. data/sorbet/rbi/gems/minitest@6.0.1.rbi +1524 -0
  72. data/sorbet/rbi/gems/net-http@0.9.1.rbi +4304 -0
  73. data/sorbet/rbi/gems/netrc@0.11.0.rbi +177 -0
  74. data/sorbet/rbi/gems/parallel@1.27.0.rbi +291 -0
  75. data/sorbet/rbi/gems/parser@3.3.10.0.rbi +5537 -0
  76. data/sorbet/rbi/gems/pp@0.6.3.rbi +390 -0
  77. data/sorbet/rbi/gems/prettyprint@0.2.0.rbi +477 -0
  78. data/sorbet/rbi/gems/prism@1.6.0.rbi +42126 -0
  79. data/sorbet/rbi/gems/psych@5.3.1.rbi +2556 -0
  80. data/sorbet/rbi/gems/public_suffix@7.0.2.rbi +957 -0
  81. data/sorbet/rbi/gems/racc@1.8.1.rbi +168 -0
  82. data/sorbet/rbi/gems/rainbow@3.1.1.rbi +404 -0
  83. data/sorbet/rbi/gems/rake@13.3.1.rbi +3038 -0
  84. data/sorbet/rbi/gems/rbi@0.3.8.rbi +5238 -0
  85. data/sorbet/rbi/gems/rbs@4.0.0.dev.4.rbi +7805 -0
  86. data/sorbet/rbi/gems/regexp_parser@2.11.3.rbi +3849 -0
  87. data/sorbet/rbi/gems/reline@0.6.3.rbi +2995 -0
  88. data/sorbet/rbi/gems/require-hooks@0.2.2.rbi +110 -0
  89. data/sorbet/rbi/gems/rexml@3.4.4.rbi +5258 -0
  90. data/sorbet/rbi/gems/rubocop-espago@1.2.0.rbi +9 -0
  91. data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +1318 -0
  92. data/sorbet/rbi/gems/securerandom@0.4.1.rbi +75 -0
  93. data/sorbet/rbi/gems/shale-builder@0.8.5.rbi +267 -0
  94. data/sorbet/rbi/gems/shale@1.2.2.rbi +2323 -0
  95. data/sorbet/rbi/gems/shoulda-context@2.0.0.rbi +563 -0
  96. data/sorbet/rbi/gems/spoom@1.7.11.rbi +5878 -0
  97. data/sorbet/rbi/gems/stringio@3.2.0.rbi +9 -0
  98. data/sorbet/rbi/gems/tapioca@0.17.4.rbi +3507 -0
  99. data/sorbet/rbi/gems/thor@1.4.0.rbi +4399 -0
  100. data/sorbet/rbi/gems/tsort@0.2.0.rbi +393 -0
  101. data/sorbet/rbi/gems/tzinfo@2.0.6.rbi +5919 -0
  102. data/sorbet/rbi/gems/unicode-display_width@3.2.0.rbi +132 -0
  103. data/sorbet/rbi/gems/unicode-emoji@4.2.0.rbi +254 -0
  104. data/sorbet/rbi/gems/uri@1.1.1.rbi +2407 -0
  105. data/sorbet/rbi/gems/vcr@6.4.0.rbi +3055 -0
  106. data/sorbet/rbi/gems/webmock@3.26.1.rbi +1816 -0
  107. data/sorbet/rbi/shims/gems/set.rbi +2 -0
  108. data/sorbet/rbi/shims/gems/shale.rbi +27 -0
  109. data/sorbet/rbi/shims/gems/shoulda-context.rbi +20 -0
  110. data/sorbet/tapioca/config.yml +21 -0
  111. data/sorbet/tapioca/extensions/load_gem.rb +1 -0
  112. data/sorbet/tapioca/require.rb +15 -0
  113. metadata +228 -0
@@ -0,0 +1,3301 @@
1
+ # typed: true
2
+
3
+ # DO NOT EDIT MANUALLY
4
+ # This is an autogenerated file for types exported from the `faraday` gem.
5
+ # Please instead update this file by running `bin/tapioca gem faraday`.
6
+
7
+
8
+ # conn.get '/'
9
+ #
10
+ # source://faraday//lib/faraday/version.rb#3
11
+ module Faraday
12
+ class << self
13
+ # @overload default_adapter
14
+ # @overload default_adapter=
15
+ #
16
+ # source://faraday//lib/faraday.rb#56
17
+ def default_adapter; end
18
+
19
+ # Documented elsewhere, see default_adapter reader
20
+ #
21
+ # source://faraday//lib/faraday.rb#103
22
+ def default_adapter=(adapter); end
23
+
24
+ # Option for the default_adapter
25
+ # @return [Hash] default_adapter options
26
+ #
27
+ # source://faraday//lib/faraday.rb#60
28
+ def default_adapter_options; end
29
+
30
+ # Option for the default_adapter
31
+ # @return [Hash] default_adapter options
32
+ #
33
+ # source://faraday//lib/faraday.rb#60
34
+ def default_adapter_options=(_arg0); end
35
+
36
+ # @overload default_connection
37
+ # @overload default_connection=
38
+ #
39
+ # source://faraday//lib/faraday.rb#121
40
+ def default_connection; end
41
+
42
+ # Documented below, see default_connection
43
+ #
44
+ # source://faraday//lib/faraday.rb#63
45
+ def default_connection=(_arg0); end
46
+
47
+ # Gets the default connection options used when calling {Faraday#new}.
48
+ #
49
+ # @return [Faraday::ConnectionOptions]
50
+ #
51
+ # source://faraday//lib/faraday.rb#128
52
+ def default_connection_options; end
53
+
54
+ # Sets the default options used when calling {Faraday#new}.
55
+ #
56
+ # @param options [Hash, Faraday::ConnectionOptions]
57
+ #
58
+ # source://faraday//lib/faraday.rb#135
59
+ def default_connection_options=(options); end
60
+
61
+ # Tells Faraday to ignore the environment proxy (http_proxy).
62
+ # Defaults to `false`.
63
+ #
64
+ # @return [Boolean]
65
+ #
66
+ # source://faraday//lib/faraday.rb#68
67
+ def ignore_env_proxy; end
68
+
69
+ # Tells Faraday to ignore the environment proxy (http_proxy).
70
+ # Defaults to `false`.
71
+ #
72
+ # @return [Boolean]
73
+ #
74
+ # source://faraday//lib/faraday.rb#68
75
+ def ignore_env_proxy=(_arg0); end
76
+
77
+ # Gets or sets the path that the Faraday libs are loaded from.
78
+ #
79
+ # @return [String]
80
+ #
81
+ # source://faraday//lib/faraday.rb#47
82
+ def lib_path; end
83
+
84
+ # Gets or sets the path that the Faraday libs are loaded from.
85
+ #
86
+ # @return [String]
87
+ #
88
+ # source://faraday//lib/faraday.rb#47
89
+ def lib_path=(_arg0); end
90
+
91
+ # Initializes a new {Connection}.
92
+ #
93
+ # @example With an URL argument
94
+ # Faraday.new 'http://faraday.com'
95
+ # # => Faraday::Connection to http://faraday.com
96
+ # @example With an URL argument and an options hash
97
+ # Faraday.new 'http://faraday.com', params: { page: 1 }
98
+ # # => Faraday::Connection to http://faraday.com?page=1
99
+ # @example With everything in an options hash
100
+ # Faraday.new url: 'http://faraday.com',
101
+ # params: { page: 1 }
102
+ # # => Faraday::Connection to http://faraday.com?page=1
103
+ # @option options
104
+ # @option options
105
+ # @option options
106
+ # @option options
107
+ # @option options
108
+ # @option options
109
+ # @param options [Hash]
110
+ # @param url [String, Hash] The optional String base URL to use as a prefix
111
+ # for all requests. Can also be the options Hash. Any of these
112
+ # values will be set on every request made, unless overridden
113
+ # for a specific request.
114
+ # @return [Faraday::Connection]
115
+ #
116
+ # source://faraday//lib/faraday.rb#97
117
+ def new(url = T.unsafe(nil), options = T.unsafe(nil), &block); end
118
+
119
+ # @return [Boolean]
120
+ #
121
+ # source://faraday//lib/faraday.rb#108
122
+ def respond_to_missing?(symbol, include_private = T.unsafe(nil)); end
123
+
124
+ # The root path that Faraday is being loaded from.
125
+ #
126
+ # This is the root from where the libraries are auto-loaded.
127
+ #
128
+ # @return [String]
129
+ #
130
+ # source://faraday//lib/faraday.rb#43
131
+ def root_path; end
132
+
133
+ # The root path that Faraday is being loaded from.
134
+ #
135
+ # This is the root from where the libraries are auto-loaded.
136
+ #
137
+ # @return [String]
138
+ #
139
+ # source://faraday//lib/faraday.rb#43
140
+ def root_path=(_arg0); end
141
+
142
+ private
143
+
144
+ # Internal: Proxies method calls on the Faraday constant to
145
+ # .default_connection.
146
+ #
147
+ # source://faraday//lib/faraday.rb#144
148
+ def method_missing(name, *args, &block); end
149
+ end
150
+ end
151
+
152
+ # Base class for all Faraday adapters. Adapters are
153
+ # responsible for fulfilling a Faraday request.
154
+ #
155
+ # source://faraday//lib/faraday/adapter.rb#6
156
+ class Faraday::Adapter
157
+ extend ::Faraday::MiddlewareRegistry
158
+ extend ::Faraday::Adapter::Parallelism
159
+
160
+ # @return [Adapter] a new instance of Adapter
161
+ #
162
+ # source://faraday//lib/faraday/adapter.rb#28
163
+ def initialize(_app = T.unsafe(nil), opts = T.unsafe(nil), &block); end
164
+
165
+ # source://faraday//lib/faraday/adapter.rb#55
166
+ def call(env); end
167
+
168
+ # Close any persistent connections. The adapter should still be usable
169
+ # after calling close.
170
+ #
171
+ # source://faraday//lib/faraday/adapter.rb#50
172
+ def close; end
173
+
174
+ # Yields or returns an adapter's configured connection. Depends on
175
+ # #build_connection being defined on this adapter.
176
+ #
177
+ # @param env [Faraday::Env, Hash] The env object for a faraday request.
178
+ # @return The return value of the given block, or the HTTP connection object
179
+ # if no block is given.
180
+ # @yield [conn]
181
+ #
182
+ # source://faraday//lib/faraday/adapter.rb#41
183
+ def connection(env); end
184
+
185
+ private
186
+
187
+ # Fetches either a read, write, or open timeout setting. Defaults to the
188
+ # :timeout value if a more specific one is not given.
189
+ #
190
+ # @param options [Hash] Hash containing Symbol keys like :timeout,
191
+ # :read_timeout, :write_timeout, or :open_timeout
192
+ # @param type [Symbol] Describes which timeout setting to get: :read,
193
+ # :write, or :open.
194
+ # @return [Integer, nil] Timeout duration in seconds, or nil if no timeout
195
+ # has been set.
196
+ #
197
+ # source://faraday//lib/faraday/adapter.rb#85
198
+ def request_timeout(type, options); end
199
+
200
+ # source://faraday//lib/faraday/adapter.rb#62
201
+ def save_response(env, status, body, headers = T.unsafe(nil), reason_phrase = T.unsafe(nil), finished: T.unsafe(nil)); end
202
+ end
203
+
204
+ # source://faraday//lib/faraday/adapter.rb#9
205
+ Faraday::Adapter::CONTENT_LENGTH = T.let(T.unsafe(nil), String)
206
+
207
+ # This module marks an Adapter as supporting parallel requests.
208
+ #
209
+ # source://faraday//lib/faraday/adapter.rb#12
210
+ module Faraday::Adapter::Parallelism
211
+ # source://faraday//lib/faraday/adapter.rb#19
212
+ def inherited(subclass); end
213
+
214
+ # Sets the attribute supports_parallel
215
+ #
216
+ # @param value the value to set the attribute supports_parallel to.
217
+ #
218
+ # source://faraday//lib/faraday/adapter.rb#13
219
+ def supports_parallel=(_arg0); end
220
+
221
+ # @return [Boolean]
222
+ #
223
+ # source://faraday//lib/faraday/adapter.rb#15
224
+ def supports_parallel?; end
225
+ end
226
+
227
+ # source://faraday//lib/faraday/adapter.rb#93
228
+ Faraday::Adapter::TIMEOUT_KEYS = T.let(T.unsafe(nil), Hash)
229
+
230
+ # @example
231
+ # test = Faraday::Connection.new do
232
+ # use Faraday::Adapter::Test do |stub|
233
+ # # Define matcher to match the request
234
+ # stub.get '/resource.json' do
235
+ # # return static content
236
+ # [200, {'Content-Type' => 'application/json'}, 'hi world']
237
+ # end
238
+ #
239
+ # # response with content generated based on request
240
+ # stub.get '/showget' do |env|
241
+ # [200, {'Content-Type' => 'text/plain'}, env[:method].to_s]
242
+ # end
243
+ #
244
+ # # A regular expression can be used as matching filter
245
+ # stub.get /\A\/items\/(\d+)\z/ do |env, meta|
246
+ # # in case regular expression is used, an instance of MatchData
247
+ # # can be received
248
+ # [200,
249
+ # {'Content-Type' => 'text/plain'},
250
+ # "showing item: #{meta[:match_data][1]}"
251
+ # ]
252
+ # end
253
+ #
254
+ # # Test the request body is the same as the stubbed body
255
+ # stub.post('/bar', 'name=YK&word=call') { [200, {}, ''] }
256
+ #
257
+ # # You can pass a proc as a stubbed body and check the request body in your way.
258
+ # # In this case, the proc should return true or false.
259
+ # stub.post('/foo', ->(request_body) do
260
+ # JSON.parse(request_body).slice('name') == { 'name' => 'YK' } }) { [200, {}, '']
261
+ # end
262
+ #
263
+ # # You can set strict_mode to exactly match the stubbed requests.
264
+ # stub.strict_mode = true
265
+ # end
266
+ # end
267
+ #
268
+ # resp = test.get '/resource.json'
269
+ # resp.body # => 'hi world'
270
+ #
271
+ # resp = test.get '/showget'
272
+ # resp.body # => 'get'
273
+ #
274
+ # resp = test.get '/items/1'
275
+ # resp.body # => 'showing item: 1'
276
+ #
277
+ # resp = test.get '/items/2'
278
+ # resp.body # => 'showing item: 2'
279
+ #
280
+ # resp = test.post '/bar', 'name=YK&word=call'
281
+ # resp.status # => 200
282
+ #
283
+ # resp = test.post '/foo', JSON.dump(name: 'YK', created_at: Time.now)
284
+ # resp.status # => 200
285
+ #
286
+ # source://faraday//lib/faraday/adapter/test.rb#62
287
+ class Faraday::Adapter::Test < ::Faraday::Adapter
288
+ # @return [Test] a new instance of Test
289
+ #
290
+ # source://faraday//lib/faraday/adapter/test.rb#258
291
+ def initialize(app, stubs = T.unsafe(nil), &block); end
292
+
293
+ # @param env [Faraday::Env]
294
+ #
295
+ # source://faraday//lib/faraday/adapter/test.rb#269
296
+ def call(env); end
297
+
298
+ # @yield [stubs]
299
+ #
300
+ # source://faraday//lib/faraday/adapter/test.rb#264
301
+ def configure; end
302
+
303
+ # Returns the value of attribute stubs.
304
+ #
305
+ # source://faraday//lib/faraday/adapter/test.rb#63
306
+ def stubs; end
307
+
308
+ # Sets the attribute stubs
309
+ #
310
+ # @param value the value to set the attribute stubs to.
311
+ #
312
+ # source://faraday//lib/faraday/adapter/test.rb#63
313
+ def stubs=(_arg0); end
314
+ end
315
+
316
+ # Stub request
317
+ #
318
+ # source://faraday//lib/faraday/adapter/test.rb#187
319
+ class Faraday::Adapter::Test::Stub < ::Struct
320
+ # Returns the value of attribute block
321
+ #
322
+ # @return [Object] the current value of block
323
+ #
324
+ # source://faraday//lib/faraday/adapter/test.rb#187
325
+ def block; end
326
+
327
+ # Sets the attribute block
328
+ #
329
+ # @param value [Object] the value to set the attribute block to.
330
+ # @return [Object] the newly set value
331
+ #
332
+ # source://faraday//lib/faraday/adapter/test.rb#187
333
+ def block=(_); end
334
+
335
+ # Returns the value of attribute body
336
+ #
337
+ # @return [Object] the current value of body
338
+ #
339
+ # source://faraday//lib/faraday/adapter/test.rb#187
340
+ def body; end
341
+
342
+ # Sets the attribute body
343
+ #
344
+ # @param value [Object] the value to set the attribute body to.
345
+ # @return [Object] the newly set value
346
+ #
347
+ # source://faraday//lib/faraday/adapter/test.rb#187
348
+ def body=(_); end
349
+
350
+ # @return [Boolean]
351
+ #
352
+ # source://faraday//lib/faraday/adapter/test.rb#242
353
+ def body_match?(request_body); end
354
+
355
+ # Returns the value of attribute headers
356
+ #
357
+ # @return [Object] the current value of headers
358
+ #
359
+ # source://faraday//lib/faraday/adapter/test.rb#187
360
+ def headers; end
361
+
362
+ # Sets the attribute headers
363
+ #
364
+ # @param value [Object] the value to set the attribute headers to.
365
+ # @return [Object] the newly set value
366
+ #
367
+ # source://faraday//lib/faraday/adapter/test.rb#187
368
+ def headers=(_); end
369
+
370
+ # @return [Boolean]
371
+ #
372
+ # source://faraday//lib/faraday/adapter/test.rb#227
373
+ def headers_match?(request_headers); end
374
+
375
+ # Returns the value of attribute host
376
+ #
377
+ # @return [Object] the current value of host
378
+ #
379
+ # source://faraday//lib/faraday/adapter/test.rb#187
380
+ def host; end
381
+
382
+ # Sets the attribute host
383
+ #
384
+ # @param value [Object] the value to set the attribute host to.
385
+ # @return [Object] the newly set value
386
+ #
387
+ # source://faraday//lib/faraday/adapter/test.rb#187
388
+ def host=(_); end
389
+
390
+ # @param env [Faraday::Env]
391
+ # @return [Boolean]
392
+ #
393
+ # source://faraday//lib/faraday/adapter/test.rb#189
394
+ def matches?(env); end
395
+
396
+ # @param env [Faraday::Env]
397
+ # @return [Boolean]
398
+ #
399
+ # source://faraday//lib/faraday/adapter/test.rb#214
400
+ def params_match?(env); end
401
+
402
+ # Returns the value of attribute path
403
+ #
404
+ # @return [Object] the current value of path
405
+ #
406
+ # source://faraday//lib/faraday/adapter/test.rb#187
407
+ def path; end
408
+
409
+ # Sets the attribute path
410
+ #
411
+ # @param value [Object] the value to set the attribute path to.
412
+ # @return [Object] the newly set value
413
+ #
414
+ # source://faraday//lib/faraday/adapter/test.rb#187
415
+ def path=(_); end
416
+
417
+ # @return [Boolean]
418
+ #
419
+ # source://faraday//lib/faraday/adapter/test.rb#205
420
+ def path_match?(request_path, meta); end
421
+
422
+ # Returns the value of attribute query
423
+ #
424
+ # @return [Object] the current value of query
425
+ #
426
+ # source://faraday//lib/faraday/adapter/test.rb#187
427
+ def query; end
428
+
429
+ # Sets the attribute query
430
+ #
431
+ # @param value [Object] the value to set the attribute query to.
432
+ # @return [Object] the newly set value
433
+ #
434
+ # source://faraday//lib/faraday/adapter/test.rb#187
435
+ def query=(_); end
436
+
437
+ # Returns the value of attribute strict_mode
438
+ #
439
+ # @return [Object] the current value of strict_mode
440
+ #
441
+ # source://faraday//lib/faraday/adapter/test.rb#187
442
+ def strict_mode; end
443
+
444
+ # Sets the attribute strict_mode
445
+ #
446
+ # @param value [Object] the value to set the attribute strict_mode to.
447
+ # @return [Object] the newly set value
448
+ #
449
+ # source://faraday//lib/faraday/adapter/test.rb#187
450
+ def strict_mode=(_); end
451
+
452
+ # source://faraday//lib/faraday/adapter/test.rb#253
453
+ def to_s; end
454
+
455
+ class << self
456
+ # source://faraday//lib/faraday/adapter/test.rb#187
457
+ def [](*_arg0); end
458
+
459
+ # source://faraday//lib/faraday/adapter/test.rb#187
460
+ def inspect; end
461
+
462
+ # source://faraday//lib/faraday/adapter/test.rb#187
463
+ def keyword_init?; end
464
+
465
+ # source://faraday//lib/faraday/adapter/test.rb#187
466
+ def members; end
467
+
468
+ # source://faraday//lib/faraday/adapter/test.rb#187
469
+ def new(*_arg0); end
470
+ end
471
+ end
472
+
473
+ # A stack of Stubs
474
+ #
475
+ # source://faraday//lib/faraday/adapter/test.rb#66
476
+ class Faraday::Adapter::Test::Stubs
477
+ # @return [Stubs] a new instance of Stubs
478
+ # @yield [_self]
479
+ # @yieldparam _self [Faraday::Adapter::Test::Stubs] the object that the method was called on
480
+ #
481
+ # source://faraday//lib/faraday/adapter/test.rb#70
482
+ def initialize(strict_mode: T.unsafe(nil)); end
483
+
484
+ # source://faraday//lib/faraday/adapter/test.rb#122
485
+ def delete(path, headers = T.unsafe(nil), &block); end
486
+
487
+ # @return [Boolean]
488
+ #
489
+ # source://faraday//lib/faraday/adapter/test.rb#79
490
+ def empty?; end
491
+
492
+ # source://faraday//lib/faraday/adapter/test.rb#102
493
+ def get(path, headers = T.unsafe(nil), &block); end
494
+
495
+ # source://faraday//lib/faraday/adapter/test.rb#106
496
+ def head(path, headers = T.unsafe(nil), &block); end
497
+
498
+ # @param env [Faraday::Env]
499
+ #
500
+ # source://faraday//lib/faraday/adapter/test.rb#84
501
+ def match(env); end
502
+
503
+ # source://faraday//lib/faraday/adapter/test.rb#126
504
+ def options(path, headers = T.unsafe(nil), &block); end
505
+
506
+ # source://faraday//lib/faraday/adapter/test.rb#118
507
+ def patch(path, body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
508
+
509
+ # source://faraday//lib/faraday/adapter/test.rb#110
510
+ def post(path, body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
511
+
512
+ # source://faraday//lib/faraday/adapter/test.rb#114
513
+ def put(path, body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
514
+
515
+ # Set strict_mode. If the value is true, this adapter tries to find matched requests strictly,
516
+ # which means that all of a path, parameters, and headers must be the same as an actual request.
517
+ #
518
+ # source://faraday//lib/faraday/adapter/test.rb#147
519
+ def strict_mode=(value); end
520
+
521
+ # Raises an error if any of the stubbed calls have not been made.
522
+ #
523
+ # source://faraday//lib/faraday/adapter/test.rb#131
524
+ def verify_stubbed_calls; end
525
+
526
+ protected
527
+
528
+ # @param env [Faraday::Env]
529
+ # @param stack [Hash]
530
+ # @return [Boolean]
531
+ #
532
+ # source://faraday//lib/faraday/adapter/test.rb#177
533
+ def matches?(stack, env); end
534
+
535
+ # source://faraday//lib/faraday/adapter/test.rb#158
536
+ def new_stub(request_method, path, headers = T.unsafe(nil), body = T.unsafe(nil), &block); end
537
+ end
538
+
539
+ # source://faraday//lib/faraday/adapter/test.rb#67
540
+ class Faraday::Adapter::Test::Stubs::NotFound < ::StandardError; end
541
+
542
+ # AdapterRegistry registers adapter class names so they can be looked up by a
543
+ # String or Symbol name.
544
+ #
545
+ # source://faraday//lib/faraday/adapter_registry.rb#8
546
+ class Faraday::AdapterRegistry
547
+ # @return [AdapterRegistry] a new instance of AdapterRegistry
548
+ #
549
+ # source://faraday//lib/faraday/adapter_registry.rb#9
550
+ def initialize; end
551
+
552
+ # source://faraday//lib/faraday/adapter_registry.rb#14
553
+ def get(name); end
554
+
555
+ # source://faraday//lib/faraday/adapter_registry.rb#23
556
+ def set(klass, name = T.unsafe(nil)); end
557
+ end
558
+
559
+ # Raised by Faraday::Response::RaiseError in case of a 400 response.
560
+ #
561
+ # source://faraday//lib/faraday/error.rb#130
562
+ class Faraday::BadRequestError < ::Faraday::ClientError; end
563
+
564
+ # source://faraday//lib/faraday.rb#35
565
+ Faraday::CONTENT_TYPE = T.let(T.unsafe(nil), String)
566
+
567
+ # Faraday client error class. Represents 4xx status responses.
568
+ #
569
+ # source://faraday//lib/faraday/error.rb#126
570
+ class Faraday::ClientError < ::Faraday::Error; end
571
+
572
+ # Raised by Faraday::Response::RaiseError in case of a 409 response.
573
+ #
574
+ # source://faraday//lib/faraday/error.rb#154
575
+ class Faraday::ConflictError < ::Faraday::ClientError; end
576
+
577
+ # Connection objects manage the default properties and the middleware
578
+ # stack for fulfilling an HTTP request.
579
+ #
580
+ # @example
581
+ #
582
+ # conn = Faraday::Connection.new 'http://httpbingo.org'
583
+ #
584
+ # # GET http://httpbingo.org/nigiri
585
+ # conn.get 'nigiri'
586
+ # # => #<Faraday::Response>
587
+ #
588
+ # source://faraday//lib/faraday/connection.rb#15
589
+ class Faraday::Connection
590
+ extend ::Forwardable
591
+
592
+ # Initializes a new Faraday::Connection.
593
+ #
594
+ # @option options
595
+ # @option options
596
+ # @option options
597
+ # @option options
598
+ # @option options
599
+ # @option options
600
+ # @option options
601
+ # @option options
602
+ # @option options
603
+ # @param options [Hash, Faraday::ConnectionOptions]
604
+ # @param url [URI, String] URI or String base URL to use as a prefix for all
605
+ # requests (optional).
606
+ # @return [Connection] a new instance of Connection
607
+ # @yield [self] after all setup has been done
608
+ #
609
+ # source://faraday//lib/faraday/connection.rb#63
610
+ def initialize(url = T.unsafe(nil), options = T.unsafe(nil)); end
611
+
612
+ # source://faraday//lib/faraday/connection.rb#120
613
+ def adapter(*_arg0, **_arg1, &_arg2); end
614
+
615
+ # source://faraday//lib/faraday/connection.rb#120
616
+ def app(*_arg0, **_arg1, &_arg2); end
617
+
618
+ # Build an absolute URL based on url_prefix.
619
+ #
620
+ # of the resulting url (default: nil).
621
+ #
622
+ # @param params [Faraday::Utils::ParamsHash] A Faraday::Utils::ParamsHash to
623
+ # replace the query values
624
+ # @param url [String, URI, nil]
625
+ # @return [URI]
626
+ #
627
+ # source://faraday//lib/faraday/connection.rb#478
628
+ def build_exclusive_url(url = T.unsafe(nil), params = T.unsafe(nil), params_encoder = T.unsafe(nil)); end
629
+
630
+ # Creates and configures the request object.
631
+ #
632
+ # @param method [Symbol]
633
+ # @return [Faraday::Request]
634
+ # @yield [Faraday::Request] if block given
635
+ #
636
+ # source://faraday//lib/faraday/connection.rb#461
637
+ def build_request(method); end
638
+
639
+ # Takes a relative url for a request and combines it with the defaults
640
+ # set on the connection instance.
641
+ #
642
+ # @example
643
+ # conn = Faraday::Connection.new { ... }
644
+ # conn.url_prefix = "https://httpbingo.org/api?token=abc"
645
+ # conn.scheme # => https
646
+ # conn.path_prefix # => "/api"
647
+ #
648
+ # conn.build_url("nigiri?page=2")
649
+ # # => https://httpbingo.org/api/nigiri?token=abc&page=2
650
+ #
651
+ # conn.build_url("nigiri", page: 2)
652
+ # # => https://httpbingo.org/api/nigiri?token=abc&page=2
653
+ # @param extra_params [Hash]
654
+ # @param url [String, URI, nil]
655
+ #
656
+ # source://faraday//lib/faraday/connection.rb#415
657
+ def build_url(url = T.unsafe(nil), extra_params = T.unsafe(nil)); end
658
+
659
+ # @return [Faraday::RackBuilder] Builder for this Connection.
660
+ #
661
+ # source://faraday//lib/faraday/connection.rb#31
662
+ def builder; end
663
+
664
+ # Closes the underlying resources and/or connections. In the case of
665
+ # persistent connections, this closes all currently open connections
666
+ # but does not prevent new connections from being made.
667
+ #
668
+ # source://faraday//lib/faraday/connection.rb#125
669
+ def close; end
670
+
671
+ # Check if the adapter is parallel-capable.
672
+ #
673
+ # @api private
674
+ # @return [Object, nil] a parallel manager or nil if yielded
675
+ # @yield if the adapter isn't parallel-capable, or if no adapter is set yet.
676
+ #
677
+ # source://faraday//lib/faraday/connection.rb#291
678
+ def default_parallel_manager; end
679
+
680
+ # Sets the default parallel manager for this connection.
681
+ #
682
+ # source://faraday//lib/faraday/connection.rb#40
683
+ def default_parallel_manager=(_arg0); end
684
+
685
+ # source://faraday//lib/faraday/connection.rb#198
686
+ def delete(url = T.unsafe(nil), params = T.unsafe(nil), headers = T.unsafe(nil)); end
687
+
688
+ # Creates a duplicate of this Faraday::Connection.
689
+ #
690
+ # @api private
691
+ # @return [Faraday::Connection]
692
+ #
693
+ # source://faraday//lib/faraday/connection.rb#499
694
+ def dup; end
695
+
696
+ # source://faraday//lib/faraday/connection.rb#542
697
+ def find_default_proxy; end
698
+
699
+ # source://faraday//lib/faraday/connection.rb#198
700
+ def get(url = T.unsafe(nil), params = T.unsafe(nil), headers = T.unsafe(nil)); end
701
+
702
+ # source://faraday//lib/faraday/connection.rb#198
703
+ def head(url = T.unsafe(nil), params = T.unsafe(nil), headers = T.unsafe(nil)); end
704
+
705
+ # @return [Hash] unencoded HTTP header key/value pairs.
706
+ #
707
+ # source://faraday//lib/faraday/connection.rb#24
708
+ def headers; end
709
+
710
+ # Sets the Hash of unencoded HTTP header key/value pairs.
711
+ #
712
+ # @param hash [Hash]
713
+ #
714
+ # source://faraday//lib/faraday/connection.rb#114
715
+ def headers=(hash); end
716
+
717
+ # source://faraday//lib/faraday/connection.rb#346
718
+ def host(*_arg0, **_arg1, &_arg2); end
719
+
720
+ # source://faraday//lib/faraday/connection.rb#346
721
+ def host=(*_arg0, **_arg1, &_arg2); end
722
+
723
+ # Sets up the parallel manager to make a set of requests.
724
+ #
725
+ # @param manager [Object] The parallel manager that this Connection's
726
+ # Adapter uses.
727
+ # @return [void]
728
+ # @yield a block to execute multiple requests.
729
+ #
730
+ # source://faraday//lib/faraday/connection.rb#317
731
+ def in_parallel(manager = T.unsafe(nil), &block); end
732
+
733
+ # Determine if this Faraday::Connection can make parallel requests.
734
+ #
735
+ # @return [Boolean]
736
+ #
737
+ # source://faraday//lib/faraday/connection.rb#306
738
+ def in_parallel?; end
739
+
740
+ # source://faraday//lib/faraday/connection.rb#96
741
+ def initialize_proxy(url, options); end
742
+
743
+ # @example
744
+ # conn.options '/items/1'
745
+ # @overload options
746
+ # @overload options
747
+ # @return [Faraday::Response]
748
+ # @yield [Faraday::Request] for further request customizations
749
+ #
750
+ # source://faraday//lib/faraday/connection.rb#222
751
+ def options(*args); end
752
+
753
+ # @return [Object] the parallel manager for this Connection.
754
+ #
755
+ # source://faraday//lib/faraday/connection.rb#37
756
+ def parallel_manager; end
757
+
758
+ # @return [Hash] URI query unencoded key/value pairs.
759
+ #
760
+ # source://faraday//lib/faraday/connection.rb#21
761
+ def params; end
762
+
763
+ # Sets the Hash of URI query unencoded key/value pairs.
764
+ #
765
+ # @param hash [Hash]
766
+ #
767
+ # source://faraday//lib/faraday/connection.rb#108
768
+ def params=(hash); end
769
+
770
+ # source://faraday//lib/faraday/connection.rb#278
771
+ def patch(url = T.unsafe(nil), body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
772
+
773
+ # source://faraday//lib/faraday/connection.rb#347
774
+ def path_prefix(*_arg0, **_arg1, &_arg2); end
775
+
776
+ # Sets the path prefix and ensures that it always has a leading
777
+ # slash.
778
+ #
779
+ # @param value [String]
780
+ # @return [String] the new path prefix
781
+ #
782
+ # source://faraday//lib/faraday/connection.rb#390
783
+ def path_prefix=(value); end
784
+
785
+ # source://faraday//lib/faraday/connection.rb#346
786
+ def port(*_arg0, **_arg1, &_arg2); end
787
+
788
+ # source://faraday//lib/faraday/connection.rb#346
789
+ def port=(*_arg0, **_arg1, &_arg2); end
790
+
791
+ # source://faraday//lib/faraday/connection.rb#278
792
+ def post(url = T.unsafe(nil), body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
793
+
794
+ # @return [Hash] proxy options.
795
+ #
796
+ # source://faraday//lib/faraday/connection.rb#43
797
+ def proxy; end
798
+
799
+ # Sets the Hash proxy options.
800
+ #
801
+ # @param new_value [Object]
802
+ #
803
+ # source://faraday//lib/faraday/connection.rb#341
804
+ def proxy=(new_value); end
805
+
806
+ # source://faraday//lib/faraday/connection.rb#550
807
+ def proxy_for_request(url); end
808
+
809
+ # source://faraday//lib/faraday/connection.rb#522
810
+ def proxy_from_env(url); end
811
+
812
+ # source://faraday//lib/faraday/connection.rb#278
813
+ def put(url = T.unsafe(nil), body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
814
+
815
+ # source://faraday//lib/faraday/connection.rb#120
816
+ def request(*_arg0, **_arg1, &_arg2); end
817
+
818
+ # source://faraday//lib/faraday/connection.rb#120
819
+ def response(*_arg0, **_arg1, &_arg2); end
820
+
821
+ # Builds and runs the Faraday::Request.
822
+ #
823
+ # @param body [String, Hash, Array, nil] The request body that will eventually be converted to
824
+ # a string; middlewares can be used to support more complex types.
825
+ # @param headers [Hash, nil] unencoded HTTP header key/value pairs.
826
+ # @param method [Symbol] HTTP method.
827
+ # @param url [String, URI, nil] String or URI to access.
828
+ # @return [Faraday::Response]
829
+ #
830
+ # source://faraday//lib/faraday/connection.rb#439
831
+ def run_request(method, url, body, headers); end
832
+
833
+ # source://faraday//lib/faraday/connection.rb#346
834
+ def scheme(*_arg0, **_arg1, &_arg2); end
835
+
836
+ # source://faraday//lib/faraday/connection.rb#346
837
+ def scheme=(*_arg0, **_arg1, &_arg2); end
838
+
839
+ # source://faraday//lib/faraday/connection.rb#379
840
+ def set_basic_auth(user, password); end
841
+
842
+ # @return [Hash] SSL options.
843
+ #
844
+ # source://faraday//lib/faraday/connection.rb#34
845
+ def ssl; end
846
+
847
+ # @return [Boolean]
848
+ #
849
+ # source://faraday//lib/faraday/connection.rb#560
850
+ def support_parallel?(adapter); end
851
+
852
+ # source://faraday//lib/faraday/connection.rb#198
853
+ def trace(url = T.unsafe(nil), params = T.unsafe(nil), headers = T.unsafe(nil)); end
854
+
855
+ # @return [String] a URI with the prefix used for all requests from this
856
+ # Connection. This includes a default host name, scheme, port, and path.
857
+ #
858
+ # source://faraday//lib/faraday/connection.rb#28
859
+ def url_prefix; end
860
+
861
+ # Parses the given URL with URI and stores the individual
862
+ # components in this connection. These components serve as defaults for
863
+ # requests made by this connection.
864
+ #
865
+ # @example
866
+ #
867
+ # conn = Faraday::Connection.new { ... }
868
+ # conn.url_prefix = "https://httpbingo.org/api"
869
+ # conn.scheme # => https
870
+ # conn.path_prefix # => "/api"
871
+ #
872
+ # conn.get("nigiri?page=2") # accesses https://httpbingo.org/api/nigiri
873
+ # @param encoder [Object]
874
+ # @param url [String, URI]
875
+ #
876
+ # source://faraday//lib/faraday/connection.rb#364
877
+ def url_prefix=(url, encoder = T.unsafe(nil)); end
878
+
879
+ # source://faraday//lib/faraday/connection.rb#120
880
+ def use(*_arg0, **_arg1, &_arg2); end
881
+
882
+ # Yields username and password extracted from a URI if they both exist.
883
+ #
884
+ # @api private
885
+ # @param uri [URI]
886
+ # @return [void]
887
+ # @yield [username, password] any username and password
888
+ # @yieldparam password [String] any password from URI
889
+ # @yieldparam username [String] any username from URI
890
+ #
891
+ # source://faraday//lib/faraday/connection.rb#516
892
+ def with_uri_credentials(uri); end
893
+ end
894
+
895
+ # A Set of allowed HTTP verbs.
896
+ #
897
+ # source://faraday//lib/faraday/connection.rb#17
898
+ Faraday::Connection::METHODS = T.let(T.unsafe(nil), Set)
899
+
900
+ # source://faraday//lib/faraday/connection.rb#18
901
+ Faraday::Connection::USER_AGENT = T.let(T.unsafe(nil), String)
902
+
903
+ # A unified error for failed connections.
904
+ #
905
+ # source://faraday//lib/faraday/error.rb#188
906
+ class Faraday::ConnectionFailed < ::Faraday::Error; end
907
+
908
+ # ConnectionOptions contains the configurable properties for a Faraday
909
+ # connection object.
910
+ #
911
+ # source://faraday//lib/faraday/options/connection_options.rb#8
912
+ class Faraday::ConnectionOptions < ::Faraday::Options
913
+ # source://faraday//lib/faraday/options/connection_options.rb#8
914
+ def builder; end
915
+
916
+ # source://faraday//lib/faraday/options/connection_options.rb#8
917
+ def builder=(_); end
918
+
919
+ # source://faraday//lib/faraday/options/connection_options.rb#8
920
+ def builder_class; end
921
+
922
+ # source://faraday//lib/faraday/options/connection_options.rb#8
923
+ def builder_class=(_); end
924
+
925
+ # source://faraday//lib/faraday/options/connection_options.rb#8
926
+ def headers; end
927
+
928
+ # source://faraday//lib/faraday/options/connection_options.rb#8
929
+ def headers=(_); end
930
+
931
+ # source://faraday//lib/faraday/options/connection_options.rb#19
932
+ def new_builder(block); end
933
+
934
+ # source://faraday//lib/faraday/options/connection_options.rb#8
935
+ def parallel_manager; end
936
+
937
+ # source://faraday//lib/faraday/options/connection_options.rb#8
938
+ def parallel_manager=(_); end
939
+
940
+ # source://faraday//lib/faraday/options/connection_options.rb#8
941
+ def params; end
942
+
943
+ # source://faraday//lib/faraday/options/connection_options.rb#8
944
+ def params=(_); end
945
+
946
+ # source://faraday//lib/faraday/options/connection_options.rb#8
947
+ def proxy; end
948
+
949
+ # source://faraday//lib/faraday/options/connection_options.rb#8
950
+ def proxy=(_); end
951
+
952
+ # source://faraday//lib/faraday/options/connection_options.rb#8
953
+ def request; end
954
+
955
+ # source://faraday//lib/faraday/options/connection_options.rb#8
956
+ def request=(_); end
957
+
958
+ # source://faraday//lib/faraday/options/connection_options.rb#8
959
+ def ssl; end
960
+
961
+ # source://faraday//lib/faraday/options/connection_options.rb#8
962
+ def ssl=(_); end
963
+
964
+ # source://faraday//lib/faraday/options/connection_options.rb#8
965
+ def url; end
966
+
967
+ # source://faraday//lib/faraday/options/connection_options.rb#8
968
+ def url=(_); end
969
+
970
+ class << self
971
+ # source://faraday//lib/faraday/options/connection_options.rb#8
972
+ def [](*_arg0); end
973
+
974
+ # source://faraday//lib/faraday/options/connection_options.rb#8
975
+ def inspect; end
976
+
977
+ # source://faraday//lib/faraday/options/connection_options.rb#8
978
+ def keyword_init?; end
979
+
980
+ # source://faraday//lib/faraday/options/connection_options.rb#8
981
+ def members; end
982
+
983
+ # source://faraday//lib/faraday/options/connection_options.rb#8
984
+ def new(*_arg0); end
985
+ end
986
+ end
987
+
988
+ # Sub-module for decoding query-string into parameters.
989
+ #
990
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#81
991
+ module Faraday::DecodeMethods
992
+ # @param query [nil, String]
993
+ # @raise [TypeError] if the nesting is incorrect
994
+ # @return [Array<Array, String>] the decoded params
995
+ #
996
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#87
997
+ def decode(query); end
998
+
999
+ protected
1000
+
1001
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#144
1002
+ def add_to_context(is_array, context, value, subkey); end
1003
+
1004
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#107
1005
+ def decode_pair(key, value, context); end
1006
+
1007
+ # Internal: convert a nested hash with purely numeric keys into an array.
1008
+ # FIXME: this is not compatible with Rack::Utils.parse_nested_query
1009
+ #
1010
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#151
1011
+ def dehash(hash, depth); end
1012
+
1013
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#139
1014
+ def match_context(context, subkey); end
1015
+
1016
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#129
1017
+ def new_context(subkey, is_array, context); end
1018
+
1019
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#119
1020
+ def prepare_context(context, subkey, is_array, last_subkey); end
1021
+ end
1022
+
1023
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#105
1024
+ Faraday::DecodeMethods::SUBKEYS_REGEX = T.let(T.unsafe(nil), Regexp)
1025
+
1026
+ # Sub-module for encoding parameters into query-string.
1027
+ #
1028
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#5
1029
+ module Faraday::EncodeMethods
1030
+ # @param params [nil, Array, #to_hash] parameters to be encoded
1031
+ # @raise [TypeError] if params can not be converted to a Hash
1032
+ # @return [String] the encoded params
1033
+ #
1034
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#11
1035
+ def encode(params); end
1036
+
1037
+ protected
1038
+
1039
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#64
1040
+ def encode_array(parent, value); end
1041
+
1042
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#53
1043
+ def encode_hash(parent, value); end
1044
+
1045
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#40
1046
+ def encode_pair(parent, value); end
1047
+ end
1048
+
1049
+ # source://faraday//lib/faraday/options/env.rb#57
1050
+ class Faraday::Env < ::Faraday::Options
1051
+ extend ::Forwardable
1052
+
1053
+ # source://faraday//lib/faraday/options/env.rb#89
1054
+ def [](key); end
1055
+
1056
+ # source://faraday//lib/faraday/options/env.rb#101
1057
+ def []=(key, value); end
1058
+
1059
+ # string.
1060
+ #
1061
+ # @return [String] The request body that will eventually be converted to a
1062
+ #
1063
+ # source://faraday//lib/faraday/options/env.rb#118
1064
+ def body; end
1065
+
1066
+ # string.
1067
+ #
1068
+ # @return [String] The request body that will eventually be converted to a
1069
+ #
1070
+ # source://faraday//lib/faraday/options/env.rb#122
1071
+ def body=(value); end
1072
+
1073
+ # source://faraday//lib/faraday/options/env.rb#138
1074
+ def clear_body; end
1075
+
1076
+ # source://faraday//lib/faraday/options/env.rb#114
1077
+ def current_body; end
1078
+
1079
+ # source://faraday//lib/faraday/options/env.rb#184
1080
+ def custom_members; end
1081
+
1082
+ # source://faraday//lib/faraday/options/env.rb#190
1083
+ def in_member_set?(key); end
1084
+
1085
+ # source://faraday//lib/faraday/options/env.rb#154
1086
+ def inspect; end
1087
+
1088
+ # @return [Symbol] HTTP method (`:get`, `:post`)
1089
+ #
1090
+ # source://faraday//lib/faraday/options/env.rb#57
1091
+ def method; end
1092
+
1093
+ # @return [Symbol] HTTP method (`:get`, `:post`)
1094
+ #
1095
+ # source://faraday//lib/faraday/options/env.rb#57
1096
+ def method=(_); end
1097
+
1098
+ # source://faraday//lib/faraday/options/env.rb#133
1099
+ def needs_body?; end
1100
+
1101
+ # source://faraday//lib/faraday/options/env.rb#150
1102
+ def parallel?; end
1103
+
1104
+ # @return [Object] sent if the connection is in parallel mode
1105
+ #
1106
+ # source://faraday//lib/faraday/options/env.rb#57
1107
+ def parallel_manager; end
1108
+
1109
+ # @return [Object] sent if the connection is in parallel mode
1110
+ #
1111
+ # source://faraday//lib/faraday/options/env.rb#57
1112
+ def parallel_manager=(_); end
1113
+
1114
+ # @return [Hash]
1115
+ #
1116
+ # source://faraday//lib/faraday/options/env.rb#57
1117
+ def params; end
1118
+
1119
+ # @return [Hash]
1120
+ #
1121
+ # source://faraday//lib/faraday/options/env.rb#57
1122
+ def params=(_); end
1123
+
1124
+ # source://faraday//lib/faraday/options/env.rb#74
1125
+ def params_encoder(*_arg0, **_arg1, &_arg2); end
1126
+
1127
+ # source://faraday//lib/faraday/options/env.rb#145
1128
+ def parse_body?; end
1129
+
1130
+ # @return [String]
1131
+ #
1132
+ # source://faraday//lib/faraday/options/env.rb#57
1133
+ def reason_phrase; end
1134
+
1135
+ # @return [String]
1136
+ #
1137
+ # source://faraday//lib/faraday/options/env.rb#57
1138
+ def reason_phrase=(_); end
1139
+
1140
+ # Options for configuring the request.
1141
+ #
1142
+ # - `:timeout` - time limit for the entire request (Integer in
1143
+ # seconds)
1144
+ # - `:open_timeout` - time limit for just the connection phase (e.g.
1145
+ # handshake) (Integer in seconds)
1146
+ # - `:read_timeout` - time limit for the first response byte received from
1147
+ # the server (Integer in seconds)
1148
+ # - `:write_timeout` - time limit for the client to send the request to the
1149
+ # server (Integer in seconds)
1150
+ # - `:on_data` - Proc for streaming
1151
+ # - `:proxy` - Hash of proxy options
1152
+ # - `:uri` - Proxy server URI
1153
+ # - `:user` - Proxy server username
1154
+ # - `:password` - Proxy server password
1155
+ #
1156
+ # @return [Hash] options for configuring the request.
1157
+ #
1158
+ # source://faraday//lib/faraday/options/env.rb#57
1159
+ def request; end
1160
+
1161
+ # Options for configuring the request.
1162
+ #
1163
+ # - `:timeout` - time limit for the entire request (Integer in
1164
+ # seconds)
1165
+ # - `:open_timeout` - time limit for just the connection phase (e.g.
1166
+ # handshake) (Integer in seconds)
1167
+ # - `:read_timeout` - time limit for the first response byte received from
1168
+ # the server (Integer in seconds)
1169
+ # - `:write_timeout` - time limit for the client to send the request to the
1170
+ # server (Integer in seconds)
1171
+ # - `:on_data` - Proc for streaming
1172
+ # - `:proxy` - Hash of proxy options
1173
+ # - `:uri` - Proxy server URI
1174
+ # - `:user` - Proxy server username
1175
+ # - `:password` - Proxy server password
1176
+ #
1177
+ # @return [Hash] options for configuring the request.
1178
+ #
1179
+ # source://faraday//lib/faraday/options/env.rb#57
1180
+ def request=(_); end
1181
+
1182
+ # source://faraday//lib/faraday/options/env.rb#57
1183
+ def request_body; end
1184
+
1185
+ # source://faraday//lib/faraday/options/env.rb#57
1186
+ def request_body=(_); end
1187
+
1188
+ # @return [Hash] HTTP Headers to be sent to the server.
1189
+ #
1190
+ # source://faraday//lib/faraday/options/env.rb#57
1191
+ def request_headers; end
1192
+
1193
+ # @return [Hash] HTTP Headers to be sent to the server.
1194
+ #
1195
+ # source://faraday//lib/faraday/options/env.rb#57
1196
+ def request_headers=(_); end
1197
+
1198
+ # @return [Response]
1199
+ #
1200
+ # source://faraday//lib/faraday/options/env.rb#57
1201
+ def response; end
1202
+
1203
+ # @return [Response]
1204
+ #
1205
+ # source://faraday//lib/faraday/options/env.rb#57
1206
+ def response=(_); end
1207
+
1208
+ # source://faraday//lib/faraday/options/env.rb#57
1209
+ def response_body; end
1210
+
1211
+ # source://faraday//lib/faraday/options/env.rb#57
1212
+ def response_body=(_); end
1213
+
1214
+ # @return [Hash] HTTP headers from the server
1215
+ #
1216
+ # source://faraday//lib/faraday/options/env.rb#57
1217
+ def response_headers; end
1218
+
1219
+ # @return [Hash] HTTP headers from the server
1220
+ #
1221
+ # source://faraday//lib/faraday/options/env.rb#57
1222
+ def response_headers=(_); end
1223
+
1224
+ # @return [Hash] options for configuring SSL requests
1225
+ #
1226
+ # source://faraday//lib/faraday/options/env.rb#57
1227
+ def ssl; end
1228
+
1229
+ # @return [Hash] options for configuring SSL requests
1230
+ #
1231
+ # source://faraday//lib/faraday/options/env.rb#57
1232
+ def ssl=(_); end
1233
+
1234
+ # @return [Integer] HTTP response status code
1235
+ #
1236
+ # source://faraday//lib/faraday/options/env.rb#57
1237
+ def status; end
1238
+
1239
+ # @return [Integer] HTTP response status code
1240
+ #
1241
+ # source://faraday//lib/faraday/options/env.rb#57
1242
+ def status=(_); end
1243
+
1244
+ # source://faraday//lib/faraday/options/env.rb#169
1245
+ def stream_response(&block); end
1246
+
1247
+ # source://faraday//lib/faraday/options/env.rb#165
1248
+ def stream_response?; end
1249
+
1250
+ # source://faraday//lib/faraday/options/env.rb#127
1251
+ def success?; end
1252
+
1253
+ # @return [URI] URI instance for the current request.
1254
+ #
1255
+ # source://faraday//lib/faraday/options/env.rb#57
1256
+ def url; end
1257
+
1258
+ # @return [URI] URI instance for the current request.
1259
+ #
1260
+ # source://faraday//lib/faraday/options/env.rb#57
1261
+ def url=(_); end
1262
+
1263
+ class << self
1264
+ # source://faraday//lib/faraday/options/env.rb#57
1265
+ def [](*_arg0); end
1266
+
1267
+ # source://faraday//lib/faraday/options/env.rb#80
1268
+ def from(value); end
1269
+
1270
+ # source://faraday//lib/faraday/options/env.rb#57
1271
+ def inspect; end
1272
+
1273
+ # source://faraday//lib/faraday/options/env.rb#57
1274
+ def keyword_init?; end
1275
+
1276
+ # source://faraday//lib/faraday/options/env.rb#200
1277
+ def member_set; end
1278
+
1279
+ # source://faraday//lib/faraday/options/env.rb#57
1280
+ def members; end
1281
+
1282
+ # source://faraday//lib/faraday/options/env.rb#57
1283
+ def new(*_arg0); end
1284
+ end
1285
+ end
1286
+
1287
+ # source://faraday//lib/faraday/options/env.rb#61
1288
+ Faraday::Env::ContentLength = T.let(T.unsafe(nil), String)
1289
+
1290
+ # source://faraday//lib/faraday/options/env.rb#67
1291
+ Faraday::Env::MethodsWithBodies = T.let(T.unsafe(nil), Set)
1292
+
1293
+ # source://faraday//lib/faraday/options/env.rb#62
1294
+ Faraday::Env::StatusesWithoutBody = T.let(T.unsafe(nil), Set)
1295
+
1296
+ # source://faraday//lib/faraday/options/env.rb#63
1297
+ Faraday::Env::SuccessfulStatuses = T.let(T.unsafe(nil), Range)
1298
+
1299
+ # Faraday error base class.
1300
+ #
1301
+ # source://faraday//lib/faraday/error.rb#6
1302
+ class Faraday::Error < ::StandardError
1303
+ # @return [Error] a new instance of Error
1304
+ #
1305
+ # source://faraday//lib/faraday/error.rb#9
1306
+ def initialize(exc = T.unsafe(nil), response = T.unsafe(nil)); end
1307
+
1308
+ # source://faraday//lib/faraday/error.rb#15
1309
+ def backtrace; end
1310
+
1311
+ # source://faraday//lib/faraday/error.rb#23
1312
+ def inspect; end
1313
+
1314
+ # Returns the value of attribute response.
1315
+ #
1316
+ # source://faraday//lib/faraday/error.rb#7
1317
+ def response; end
1318
+
1319
+ # source://faraday//lib/faraday/error.rb#43
1320
+ def response_body; end
1321
+
1322
+ # source://faraday//lib/faraday/error.rb#37
1323
+ def response_headers; end
1324
+
1325
+ # source://faraday//lib/faraday/error.rb#31
1326
+ def response_status; end
1327
+
1328
+ # Returns the value of attribute wrapped_exception.
1329
+ #
1330
+ # source://faraday//lib/faraday/error.rb#7
1331
+ def wrapped_exception; end
1332
+
1333
+ protected
1334
+
1335
+ # Pulls out potential parent exception and response hash.
1336
+ #
1337
+ # source://faraday//lib/faraday/error.rb#81
1338
+ def exc_msg_and_response(exc, response = T.unsafe(nil)); end
1339
+
1340
+ # Pulls out potential parent exception and response hash, storing them in
1341
+ # instance variables.
1342
+ # exc - Either an Exception, a string message, or a response hash.
1343
+ # response - Hash
1344
+ # :status - Optional integer HTTP response status
1345
+ # :headers - String key/value hash of HTTP response header
1346
+ # values.
1347
+ # :body - Optional string HTTP response body.
1348
+ # :request - Hash
1349
+ # :method - Symbol with the request HTTP method.
1350
+ # :url - URI object with the url requested.
1351
+ # :url_path - String with the url path requested.
1352
+ # :params - String key/value hash of query params
1353
+ # present in the request.
1354
+ # :headers - String key/value hash of HTTP request
1355
+ # header values.
1356
+ # :body - String HTTP request body.
1357
+ #
1358
+ # If a subclass has to call this, then it should pass a string message
1359
+ # to `super`. See NilStatusError.
1360
+ #
1361
+ # source://faraday//lib/faraday/error.rb#71
1362
+ def exc_msg_and_response!(exc, response = T.unsafe(nil)); end
1363
+
1364
+ private
1365
+
1366
+ # source://faraday//lib/faraday/error.rb#108
1367
+ def build_error_message_from_env(env); end
1368
+
1369
+ # source://faraday//lib/faraday/error.rb#96
1370
+ def build_error_message_from_hash(hash); end
1371
+
1372
+ # source://faraday//lib/faraday/error.rb#113
1373
+ def build_status_error_message(status, method, url); end
1374
+
1375
+ # source://faraday//lib/faraday/error.rb#119
1376
+ def fallback_error_message(status); end
1377
+ end
1378
+
1379
+ # FlatParamsEncoder manages URI params as a flat hash. Any Array values repeat
1380
+ # the parameter multiple times.
1381
+ #
1382
+ # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#6
1383
+ module Faraday::FlatParamsEncoder
1384
+ class << self
1385
+ # Decode converts the given URI querystring into a hash.
1386
+ #
1387
+ # @example
1388
+ #
1389
+ # decode('a=one&a=two&a=three&b=true&c=C')
1390
+ # # => {"a"=>["one", "two", "three"], "b"=>"true", "c"=>"C"}
1391
+ # @param query [String] query arguments to parse.
1392
+ # @return [Hash] parsed keys and value strings from the querystring.
1393
+ #
1394
+ # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#74
1395
+ def decode(query); end
1396
+
1397
+ # Encode converts the given param into a URI querystring. Keys and values
1398
+ # will converted to strings and appropriately escaped for the URI.
1399
+ #
1400
+ # @example
1401
+ #
1402
+ # encode({a: %w[one two three], b: true, c: "C"})
1403
+ # # => 'a=one&a=two&a=three&b=true&c=C'
1404
+ # @param params [Hash] query arguments to convert.
1405
+ # @return [String] the URI querystring (without the leading '?')
1406
+ #
1407
+ # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#23
1408
+ def encode(params); end
1409
+
1410
+ # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#9
1411
+ def escape(*_arg0, **_arg1, &_arg2); end
1412
+
1413
+ # Returns the value of attribute sort_params.
1414
+ #
1415
+ # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#99
1416
+ def sort_params; end
1417
+
1418
+ # Sets the attribute sort_params
1419
+ #
1420
+ # @param value the value to set the attribute sort_params to.
1421
+ #
1422
+ # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#99
1423
+ def sort_params=(_arg0); end
1424
+
1425
+ # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#9
1426
+ def unescape(*_arg0, **_arg1, &_arg2); end
1427
+ end
1428
+ end
1429
+
1430
+ # Raised by Faraday::Response::RaiseError in case of a 403 response.
1431
+ #
1432
+ # source://faraday//lib/faraday/error.rb#138
1433
+ class Faraday::ForbiddenError < ::Faraday::ClientError; end
1434
+
1435
+ # Raised by Faraday::Middleware and subclasses when invalid default_options are used
1436
+ #
1437
+ # source://faraday//lib/faraday/error.rb#200
1438
+ class Faraday::InitializationError < ::Faraday::Error; end
1439
+
1440
+ # source://faraday//lib/faraday/logging/formatter.rb#6
1441
+ module Faraday::Logging; end
1442
+
1443
+ # Serves as an integration point to customize logging
1444
+ #
1445
+ # source://faraday//lib/faraday/logging/formatter.rb#8
1446
+ class Faraday::Logging::Formatter
1447
+ extend ::Forwardable
1448
+
1449
+ # @return [Formatter] a new instance of Formatter
1450
+ #
1451
+ # source://faraday//lib/faraday/logging/formatter.rb#14
1452
+ def initialize(logger:, options:); end
1453
+
1454
+ # source://faraday//lib/faraday/logging/formatter.rb#23
1455
+ def debug(*_arg0, **_arg1, &_arg2); end
1456
+
1457
+ # source://faraday//lib/faraday/logging/formatter.rb#23
1458
+ def error(*_arg0, **_arg1, &_arg2); end
1459
+
1460
+ # source://faraday//lib/faraday/logging/formatter.rb#41
1461
+ def exception(exc); end
1462
+
1463
+ # source://faraday//lib/faraday/logging/formatter.rb#23
1464
+ def fatal(*_arg0, **_arg1, &_arg2); end
1465
+
1466
+ # source://faraday//lib/faraday/logging/formatter.rb#52
1467
+ def filter(filter_word, filter_replacement); end
1468
+
1469
+ # source://faraday//lib/faraday/logging/formatter.rb#23
1470
+ def info(*_arg0, **_arg1, &_arg2); end
1471
+
1472
+ # source://faraday//lib/faraday/logging/formatter.rb#25
1473
+ def request(env); end
1474
+
1475
+ # source://faraday//lib/faraday/logging/formatter.rb#34
1476
+ def response(env); end
1477
+
1478
+ # source://faraday//lib/faraday/logging/formatter.rb#23
1479
+ def warn(*_arg0, **_arg1, &_arg2); end
1480
+
1481
+ private
1482
+
1483
+ # source://faraday//lib/faraday/logging/formatter.rb#98
1484
+ def apply_filters(output); end
1485
+
1486
+ # source://faraday//lib/faraday/logging/formatter.rb#64
1487
+ def dump_body(body); end
1488
+
1489
+ # source://faraday//lib/faraday/logging/formatter.rb#58
1490
+ def dump_headers(headers); end
1491
+
1492
+ # source://faraday//lib/faraday/logging/formatter.rb#113
1493
+ def log_body(type, body); end
1494
+
1495
+ # @return [Boolean]
1496
+ #
1497
+ # source://faraday//lib/faraday/logging/formatter.rb#85
1498
+ def log_body?(type); end
1499
+
1500
+ # @return [Boolean]
1501
+ #
1502
+ # source://faraday//lib/faraday/logging/formatter.rb#94
1503
+ def log_errors?; end
1504
+
1505
+ # source://faraday//lib/faraday/logging/formatter.rb#109
1506
+ def log_headers(type, headers); end
1507
+
1508
+ # @return [Boolean]
1509
+ #
1510
+ # source://faraday//lib/faraday/logging/formatter.rb#76
1511
+ def log_headers?(type); end
1512
+
1513
+ # source://faraday//lib/faraday/logging/formatter.rb#105
1514
+ def log_level; end
1515
+
1516
+ # source://faraday//lib/faraday/logging/formatter.rb#72
1517
+ def pretty_inspect(body); end
1518
+ end
1519
+
1520
+ # source://faraday//lib/faraday/logging/formatter.rb#11
1521
+ Faraday::Logging::Formatter::DEFAULT_OPTIONS = T.let(T.unsafe(nil), Hash)
1522
+
1523
+ # source://faraday//lib/faraday/methods.rb#5
1524
+ Faraday::METHODS_WITH_BODY = T.let(T.unsafe(nil), Array)
1525
+
1526
+ # source://faraday//lib/faraday/methods.rb#4
1527
+ Faraday::METHODS_WITH_QUERY = T.let(T.unsafe(nil), Array)
1528
+
1529
+ # Middleware is the basic base class of any Faraday middleware.
1530
+ #
1531
+ # source://faraday//lib/faraday/middleware.rb#7
1532
+ class Faraday::Middleware
1533
+ extend ::Faraday::MiddlewareRegistry
1534
+
1535
+ # @return [Middleware] a new instance of Middleware
1536
+ #
1537
+ # source://faraday//lib/faraday/middleware.rb#15
1538
+ def initialize(app = T.unsafe(nil), options = T.unsafe(nil)); end
1539
+
1540
+ # Returns the value of attribute app.
1541
+ #
1542
+ # source://faraday//lib/faraday/middleware.rb#10
1543
+ def app; end
1544
+
1545
+ # source://faraday//lib/faraday/middleware.rb#54
1546
+ def call(env); end
1547
+
1548
+ # source://faraday//lib/faraday/middleware.rb#64
1549
+ def close; end
1550
+
1551
+ # Returns the value of attribute options.
1552
+ #
1553
+ # source://faraday//lib/faraday/middleware.rb#10
1554
+ def options; end
1555
+
1556
+ class << self
1557
+ # default_options attr_reader that initializes class instance variable
1558
+ # with the values of any Faraday::Middleware defaults, and merges with
1559
+ # subclass defaults
1560
+ #
1561
+ # source://faraday//lib/faraday/middleware.rb#39
1562
+ def default_options; end
1563
+
1564
+ # Faraday::Middleware::default_options= allows user to set default options at the Faraday::Middleware
1565
+ # class level.
1566
+ #
1567
+ # my_app/config/initializers/my_faraday_middleware.rb
1568
+ #
1569
+ # Faraday::Response::RaiseError.default_options = { include_request: false }
1570
+ #
1571
+ # @example Set the Faraday::Response::RaiseError option, `include_request` to `false`
1572
+ #
1573
+ # source://faraday//lib/faraday/middleware.rb#29
1574
+ def default_options=(options = T.unsafe(nil)); end
1575
+
1576
+ private
1577
+
1578
+ # @raise [Faraday::InitializationError]
1579
+ #
1580
+ # source://faraday//lib/faraday/middleware.rb#45
1581
+ def validate_default_options(options); end
1582
+ end
1583
+ end
1584
+
1585
+ # source://faraday//lib/faraday/middleware.rb#12
1586
+ Faraday::Middleware::DEFAULT_OPTIONS = T.let(T.unsafe(nil), Hash)
1587
+
1588
+ # source://faraday//lib/faraday/middleware.rb#13
1589
+ Faraday::Middleware::LOCK = T.let(T.unsafe(nil), Thread::Mutex)
1590
+
1591
+ # Adds the ability for other modules to register and lookup
1592
+ # middleware classes.
1593
+ #
1594
+ # source://faraday//lib/faraday/middleware_registry.rb#8
1595
+ module Faraday::MiddlewareRegistry
1596
+ # Lookup middleware class with a registered Symbol shortcut.
1597
+ #
1598
+ # @example
1599
+ #
1600
+ # module Faraday
1601
+ # class Whatever < Middleware
1602
+ # register_middleware(foo: Whatever)
1603
+ # end
1604
+ # end
1605
+ #
1606
+ # Faraday::Middleware.lookup_middleware(:foo)
1607
+ # # => Faraday::Whatever
1608
+ # @param key [Symbol] key for the registered middleware.
1609
+ # @raise [Faraday::Error] if given key is not registered
1610
+ # @return [Class] a middleware Class.
1611
+ #
1612
+ # source://faraday//lib/faraday/middleware_registry.rb#55
1613
+ def lookup_middleware(key); end
1614
+
1615
+ # Register middleware class(es) on the current module.
1616
+ #
1617
+ # @example Lookup by a constant
1618
+ #
1619
+ # module Faraday
1620
+ # class Whatever < Middleware
1621
+ # # Middleware looked up by :foo returns Faraday::Whatever::Foo.
1622
+ # register_middleware(foo: Whatever)
1623
+ # end
1624
+ # end
1625
+ # @param mappings [Hash] Middleware mappings from a lookup symbol to a middleware class.
1626
+ # @return [void]
1627
+ #
1628
+ # source://faraday//lib/faraday/middleware_registry.rb#26
1629
+ def register_middleware(**mappings); end
1630
+
1631
+ # source://faraday//lib/faraday/middleware_registry.rb#9
1632
+ def registered_middleware; end
1633
+
1634
+ # Unregister a previously registered middleware class.
1635
+ #
1636
+ # @param key [Symbol] key for the registered middleware.
1637
+ #
1638
+ # source://faraday//lib/faraday/middleware_registry.rb#35
1639
+ def unregister_middleware(key); end
1640
+
1641
+ private
1642
+
1643
+ # source://faraday//lib/faraday/middleware_registry.rb#67
1644
+ def load_middleware(key); end
1645
+
1646
+ # source://faraday//lib/faraday/middleware_registry.rb#62
1647
+ def middleware_mutex(&block); end
1648
+ end
1649
+
1650
+ # This is the default encoder for Faraday requests.
1651
+ # Using this encoder, parameters will be encoded respecting their structure,
1652
+ # so you can send objects such as Arrays or Hashes as parameters
1653
+ # for your requests.
1654
+ #
1655
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#168
1656
+ module Faraday::NestedParamsEncoder
1657
+ extend ::Faraday::EncodeMethods
1658
+ extend ::Faraday::DecodeMethods
1659
+
1660
+ class << self
1661
+ # Returns the value of attribute array_indices.
1662
+ #
1663
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#170
1664
+ def array_indices; end
1665
+
1666
+ # Sets the attribute array_indices
1667
+ #
1668
+ # @param value the value to set the attribute array_indices to.
1669
+ #
1670
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#170
1671
+ def array_indices=(_arg0); end
1672
+
1673
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#173
1674
+ def escape(*_arg0, **_arg1, &_arg2); end
1675
+
1676
+ # Returns the value of attribute sort_params.
1677
+ #
1678
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#170
1679
+ def sort_params; end
1680
+
1681
+ # Sets the attribute sort_params
1682
+ #
1683
+ # @param value the value to set the attribute sort_params to.
1684
+ #
1685
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#170
1686
+ def sort_params=(_arg0); end
1687
+
1688
+ # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#173
1689
+ def unescape(*_arg0, **_arg1, &_arg2); end
1690
+ end
1691
+ end
1692
+
1693
+ # Raised by Faraday::Response::RaiseError in case of a nil status in response.
1694
+ #
1695
+ # source://faraday//lib/faraday/error.rb#180
1696
+ class Faraday::NilStatusError < ::Faraday::ServerError
1697
+ # @return [NilStatusError] a new instance of NilStatusError
1698
+ #
1699
+ # source://faraday//lib/faraday/error.rb#181
1700
+ def initialize(exc, response = T.unsafe(nil)); end
1701
+ end
1702
+
1703
+ # Subclasses Struct with some special helpers for converting from a Hash to
1704
+ # a Struct.
1705
+ #
1706
+ # source://faraday//lib/faraday/options.rb#6
1707
+ class Faraday::Options < ::Struct
1708
+ # source://faraday//lib/faraday/options.rb#186
1709
+ def [](key); end
1710
+
1711
+ # Public
1712
+ #
1713
+ # source://faraday//lib/faraday/options.rb#46
1714
+ def clear; end
1715
+
1716
+ # Public
1717
+ #
1718
+ # source://faraday//lib/faraday/options.rb#71
1719
+ def deep_dup; end
1720
+
1721
+ # Public
1722
+ #
1723
+ # source://faraday//lib/faraday/options.rb#39
1724
+ def delete(key); end
1725
+
1726
+ # Public
1727
+ #
1728
+ # source://faraday//lib/faraday/options.rb#13
1729
+ def each; end
1730
+
1731
+ # Public
1732
+ #
1733
+ # source://faraday//lib/faraday/options.rb#106
1734
+ def each_key(&block); end
1735
+
1736
+ # Public
1737
+ #
1738
+ # source://faraday//lib/faraday/options.rb#120
1739
+ def each_value(&block); end
1740
+
1741
+ # Public
1742
+ #
1743
+ # @return [Boolean]
1744
+ #
1745
+ # source://faraday//lib/faraday/options.rb#101
1746
+ def empty?; end
1747
+
1748
+ # Public
1749
+ #
1750
+ # source://faraday//lib/faraday/options.rb#76
1751
+ def fetch(key, *args); end
1752
+
1753
+ # Public
1754
+ #
1755
+ # @return [Boolean]
1756
+ #
1757
+ # source://faraday//lib/faraday/options.rb#117
1758
+ def has_key?(key); end
1759
+
1760
+ # Public
1761
+ #
1762
+ # @return [Boolean]
1763
+ #
1764
+ # source://faraday//lib/faraday/options.rb#131
1765
+ def has_value?(value); end
1766
+
1767
+ # Internal
1768
+ #
1769
+ # source://faraday//lib/faraday/options.rb#144
1770
+ def inspect; end
1771
+
1772
+ # Public
1773
+ #
1774
+ # @return [Boolean]
1775
+ #
1776
+ # source://faraday//lib/faraday/options.rb#113
1777
+ def key?(key); end
1778
+
1779
+ # Public
1780
+ #
1781
+ # source://faraday//lib/faraday/options.rb#96
1782
+ def keys; end
1783
+
1784
+ # Public
1785
+ #
1786
+ # source://faraday//lib/faraday/options.rb#66
1787
+ def merge(other); end
1788
+
1789
+ # Public
1790
+ #
1791
+ # source://faraday//lib/faraday/options.rb#51
1792
+ def merge!(other); end
1793
+
1794
+ # source://faraday//lib/faraday/options.rb#195
1795
+ def symbolized_key_set; end
1796
+
1797
+ # Public
1798
+ #
1799
+ # source://faraday//lib/faraday/options.rb#134
1800
+ def to_hash; end
1801
+
1802
+ # Public
1803
+ #
1804
+ # source://faraday//lib/faraday/options.rb#22
1805
+ def update(obj); end
1806
+
1807
+ # Public
1808
+ #
1809
+ # @return [Boolean]
1810
+ #
1811
+ # source://faraday//lib/faraday/options.rb#127
1812
+ def value?(value); end
1813
+
1814
+ # Public
1815
+ #
1816
+ # source://faraday//lib/faraday/options.rb#91
1817
+ def values_at(*keys); end
1818
+
1819
+ class << self
1820
+ # Internal
1821
+ #
1822
+ # source://faraday//lib/faraday/options.rb#166
1823
+ def attribute_options; end
1824
+
1825
+ # source://faraday//lib/faraday/options.rb#205
1826
+ def fetch_error_class; end
1827
+
1828
+ # Public
1829
+ #
1830
+ # source://faraday//lib/faraday/options.rb#8
1831
+ def from(value); end
1832
+
1833
+ # @private
1834
+ #
1835
+ # source://faraday//lib/faraday/options.rb#199
1836
+ def inherited(subclass); end
1837
+
1838
+ # source://faraday//lib/faraday/options.rb#170
1839
+ def memoized(key, &block); end
1840
+
1841
+ # source://faraday//lib/faraday/options.rb#182
1842
+ def memoized_attributes; end
1843
+
1844
+ # Internal
1845
+ #
1846
+ # source://faraday//lib/faraday/options.rb#156
1847
+ def options(mapping); end
1848
+
1849
+ # Internal
1850
+ #
1851
+ # source://faraday//lib/faraday/options.rb#161
1852
+ def options_for(key); end
1853
+ end
1854
+ end
1855
+
1856
+ # Raised by middlewares that parse the response, like the JSON response middleware.
1857
+ #
1858
+ # source://faraday//lib/faraday/error.rb#196
1859
+ class Faraday::ParsingError < ::Faraday::Error; end
1860
+
1861
+ # Raised by Faraday::Response::RaiseError in case of a 407 response.
1862
+ #
1863
+ # source://faraday//lib/faraday/error.rb#146
1864
+ class Faraday::ProxyAuthError < ::Faraday::ClientError; end
1865
+
1866
+ # ProxyOptions contains the configurable properties for the proxy
1867
+ # configuration used when making an HTTP request.
1868
+ #
1869
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1870
+ class Faraday::ProxyOptions < ::Faraday::Options
1871
+ extend ::Forwardable
1872
+
1873
+ # source://faraday//lib/faraday/options/proxy_options.rb#10
1874
+ def host(*_arg0, **_arg1, &_arg2); end
1875
+
1876
+ # source://faraday//lib/faraday/options/proxy_options.rb#10
1877
+ def host=(*_arg0, **_arg1, &_arg2); end
1878
+
1879
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1880
+ def password; end
1881
+
1882
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1883
+ def password=(_); end
1884
+
1885
+ # source://faraday//lib/faraday/options/proxy_options.rb#10
1886
+ def path(*_arg0, **_arg1, &_arg2); end
1887
+
1888
+ # source://faraday//lib/faraday/options/proxy_options.rb#10
1889
+ def path=(*_arg0, **_arg1, &_arg2); end
1890
+
1891
+ # source://faraday//lib/faraday/options/proxy_options.rb#10
1892
+ def port(*_arg0, **_arg1, &_arg2); end
1893
+
1894
+ # source://faraday//lib/faraday/options/proxy_options.rb#10
1895
+ def port=(*_arg0, **_arg1, &_arg2); end
1896
+
1897
+ # source://faraday//lib/faraday/options/proxy_options.rb#10
1898
+ def scheme(*_arg0, **_arg1, &_arg2); end
1899
+
1900
+ # source://faraday//lib/faraday/options/proxy_options.rb#10
1901
+ def scheme=(*_arg0, **_arg1, &_arg2); end
1902
+
1903
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1904
+ def uri; end
1905
+
1906
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1907
+ def uri=(_); end
1908
+
1909
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1910
+ def user; end
1911
+
1912
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1913
+ def user=(_); end
1914
+
1915
+ class << self
1916
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1917
+ def [](*_arg0); end
1918
+
1919
+ # source://faraday//lib/faraday/options/proxy_options.rb#13
1920
+ def from(value); end
1921
+
1922
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1923
+ def inspect; end
1924
+
1925
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1926
+ def keyword_init?; end
1927
+
1928
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1929
+ def members; end
1930
+
1931
+ # source://faraday//lib/faraday/options/proxy_options.rb#8
1932
+ def new(*_arg0); end
1933
+ end
1934
+ end
1935
+
1936
+ # A Builder that processes requests into responses by passing through an inner
1937
+ # middleware stack (heavily inspired by Rack).
1938
+ #
1939
+ # @example
1940
+ # Faraday::Connection.new(url: 'http://httpbingo.org') do |builder|
1941
+ # builder.request :url_encoded # Faraday::Request::UrlEncoded
1942
+ # builder.adapter :net_http # Faraday::Adapter::NetHttp
1943
+ # end
1944
+ #
1945
+ # source://faraday//lib/faraday/rack_builder.rb#14
1946
+ class Faraday::RackBuilder
1947
+ # @return [RackBuilder] a new instance of RackBuilder
1948
+ #
1949
+ # source://faraday//lib/faraday/rack_builder.rb#61
1950
+ def initialize(&block); end
1951
+
1952
+ # source://faraday//lib/faraday/rack_builder.rb#179
1953
+ def ==(other); end
1954
+
1955
+ # source://faraday//lib/faraday/rack_builder.rb#79
1956
+ def [](idx); end
1957
+
1958
+ # source://faraday//lib/faraday/rack_builder.rb#110
1959
+ def adapter(klass = T.unsafe(nil), *args, **kwargs, &block); end
1960
+
1961
+ # The "rack app" wrapped in middleware. All requests are sent here.
1962
+ #
1963
+ # The builder is responsible for creating the app object. After this,
1964
+ # the builder gets locked to ensure no further modifications are made
1965
+ # to the middleware stack.
1966
+ #
1967
+ # Returns an object that responds to `call` and returns a Response.
1968
+ #
1969
+ # source://faraday//lib/faraday/rack_builder.rb#163
1970
+ def app; end
1971
+
1972
+ # source://faraday//lib/faraday/rack_builder.rb#73
1973
+ def build; end
1974
+
1975
+ # ENV Keys
1976
+ # :http_method - a symbolized request HTTP method (:get, :post)
1977
+ # :body - the request body that will eventually be converted to a string.
1978
+ # :url - URI instance for the current request.
1979
+ # :status - HTTP response status code
1980
+ # :request_headers - hash of HTTP Headers to be sent to the server
1981
+ # :response_headers - Hash of HTTP headers from the server
1982
+ # :parallel_manager - sent if the connection is in parallel mode
1983
+ # :request - Hash of options for configuring the request.
1984
+ # :timeout - open/read timeout Integer in seconds
1985
+ # :open_timeout - read timeout Integer in seconds
1986
+ # :proxy - Hash of proxy options
1987
+ # :uri - Proxy Server URI
1988
+ # :user - Proxy server username
1989
+ # :password - Proxy server password
1990
+ # :ssl - Hash of options for configuring SSL requests.
1991
+ #
1992
+ # source://faraday//lib/faraday/rack_builder.rb#201
1993
+ def build_env(connection, request); end
1994
+
1995
+ # Processes a Request into a Response by passing it through this Builder's
1996
+ # middleware stack.
1997
+ #
1998
+ # @param connection [Faraday::Connection]
1999
+ # @param request [Faraday::Request]
2000
+ # @return [Faraday::Response]
2001
+ #
2002
+ # source://faraday//lib/faraday/rack_builder.rb#152
2003
+ def build_response(connection, request); end
2004
+
2005
+ # source://faraday//lib/faraday/rack_builder.rb#140
2006
+ def delete(handler); end
2007
+
2008
+ # Returns the value of attribute handlers.
2009
+ #
2010
+ # source://faraday//lib/faraday/rack_builder.rb#18
2011
+ def handlers; end
2012
+
2013
+ # Sets the attribute handlers
2014
+ #
2015
+ # @param value the value to set the attribute handlers to.
2016
+ #
2017
+ # source://faraday//lib/faraday/rack_builder.rb#18
2018
+ def handlers=(_arg0); end
2019
+
2020
+ # methods to push onto the various positions in the stack:
2021
+ #
2022
+ # source://faraday//lib/faraday/rack_builder.rb#119
2023
+ def insert(index, *_arg1, **_arg2, &_arg3); end
2024
+
2025
+ # source://faraday//lib/faraday/rack_builder.rb#128
2026
+ def insert_after(index, *_arg1, **_arg2, &_arg3); end
2027
+
2028
+ # methods to push onto the various positions in the stack:
2029
+ #
2030
+ # source://faraday//lib/faraday/rack_builder.rb#126
2031
+ def insert_before(index, *_arg1, **_arg2, &_arg3); end
2032
+
2033
+ # Locks the middleware stack to ensure no further modifications are made.
2034
+ #
2035
+ # source://faraday//lib/faraday/rack_builder.rb#84
2036
+ def lock!; end
2037
+
2038
+ # @return [Boolean]
2039
+ #
2040
+ # source://faraday//lib/faraday/rack_builder.rb#88
2041
+ def locked?; end
2042
+
2043
+ # source://faraday//lib/faraday/rack_builder.rb#102
2044
+ def request(key, *_arg1, **_arg2, &_arg3); end
2045
+
2046
+ # source://faraday//lib/faraday/rack_builder.rb#106
2047
+ def response(*_arg0, **_arg1, &_arg2); end
2048
+
2049
+ # source://faraday//lib/faraday/rack_builder.rb#133
2050
+ def swap(index, *_arg1, **_arg2, &_arg3); end
2051
+
2052
+ # source://faraday//lib/faraday/rack_builder.rb#171
2053
+ def to_app; end
2054
+
2055
+ # source://faraday//lib/faraday/rack_builder.rb#92
2056
+ def use(klass, *_arg1, **_arg2, &_arg3); end
2057
+
2058
+ private
2059
+
2060
+ # @return [Boolean]
2061
+ #
2062
+ # source://faraday//lib/faraday/rack_builder.rb#233
2063
+ def adapter_set?; end
2064
+
2065
+ # source://faraday//lib/faraday/rack_builder.rb#241
2066
+ def assert_index(index); end
2067
+
2068
+ # @raise [MISSING_ADAPTER_ERROR]
2069
+ #
2070
+ # source://faraday//lib/faraday/rack_builder.rb#229
2071
+ def ensure_adapter!; end
2072
+
2073
+ # source://faraday//lib/faraday/rack_builder.rb#67
2074
+ def initialize_dup(original); end
2075
+
2076
+ # source://faraday//lib/faraday/rack_builder.rb#223
2077
+ def raise_if_adapter(klass); end
2078
+
2079
+ # @raise [StackLocked]
2080
+ #
2081
+ # source://faraday//lib/faraday/rack_builder.rb#219
2082
+ def raise_if_locked; end
2083
+
2084
+ # source://faraday//lib/faraday/rack_builder.rb#237
2085
+ def use_symbol(mod, key, *_arg2, **_arg3, &_arg4); end
2086
+ end
2087
+
2088
+ # borrowed from ActiveSupport::Dependencies::Reference &
2089
+ # ActionDispatch::MiddlewareStack::Middleware
2090
+ #
2091
+ # source://faraday//lib/faraday/rack_builder.rb#25
2092
+ class Faraday::RackBuilder::Handler
2093
+ # @return [Handler] a new instance of Handler
2094
+ #
2095
+ # source://faraday//lib/faraday/rack_builder.rb#30
2096
+ def initialize(klass, *args, **kwargs, &block); end
2097
+
2098
+ # source://faraday//lib/faraday/rack_builder.rb#46
2099
+ def ==(other); end
2100
+
2101
+ # source://faraday//lib/faraday/rack_builder.rb#56
2102
+ def build(app = T.unsafe(nil)); end
2103
+
2104
+ # source://faraday//lib/faraday/rack_builder.rb#42
2105
+ def inspect; end
2106
+
2107
+ # source://faraday//lib/faraday/rack_builder.rb#38
2108
+ def klass; end
2109
+
2110
+ # Returns the value of attribute name.
2111
+ #
2112
+ # source://faraday//lib/faraday/rack_builder.rb#28
2113
+ def name; end
2114
+ end
2115
+
2116
+ # source://faraday//lib/faraday/rack_builder.rb#26
2117
+ Faraday::RackBuilder::Handler::REGISTRY = T.let(T.unsafe(nil), Faraday::AdapterRegistry)
2118
+
2119
+ # source://faraday//lib/faraday/rack_builder.rb#214
2120
+ Faraday::RackBuilder::LOCK_ERR = T.let(T.unsafe(nil), String)
2121
+
2122
+ # source://faraday//lib/faraday/rack_builder.rb#215
2123
+ Faraday::RackBuilder::MISSING_ADAPTER_ERROR = T.let(T.unsafe(nil), String)
2124
+
2125
+ # Used to detect missing arguments
2126
+ #
2127
+ # source://faraday//lib/faraday/rack_builder.rb#16
2128
+ Faraday::RackBuilder::NO_ARGUMENT = T.let(T.unsafe(nil), Object)
2129
+
2130
+ # Error raised when trying to modify the stack after calling `lock!`
2131
+ #
2132
+ # source://faraday//lib/faraday/rack_builder.rb#21
2133
+ class Faraday::RackBuilder::StackLocked < ::RuntimeError; end
2134
+
2135
+ # Used to setup URLs, params, headers, and the request body in a sane manner.
2136
+ #
2137
+ # @example
2138
+ # @connection.post do |req|
2139
+ # req.url 'http://localhost', 'a' => '1' # 'http://localhost?a=1'
2140
+ # req.headers['b'] = '2' # Header
2141
+ # req.params['c'] = '3' # GET Param
2142
+ # req['b'] = '2' # also Header
2143
+ # req.body = 'abc'
2144
+ # end
2145
+ #
2146
+ # source://faraday//lib/faraday/request.rb#27
2147
+ class Faraday::Request < ::Struct
2148
+ extend ::Faraday::MiddlewareRegistry
2149
+
2150
+ # @param key [Object] key to look up in headers
2151
+ # @return [Object] value of the given header name
2152
+ #
2153
+ # source://faraday//lib/faraday/request.rb#92
2154
+ def [](key); end
2155
+
2156
+ # @param key [Object] key of header to write
2157
+ # @param value [Object] value of header
2158
+ #
2159
+ # source://faraday//lib/faraday/request.rb#98
2160
+ def []=(key, value); end
2161
+
2162
+ # @return [String] body
2163
+ #
2164
+ # source://faraday//lib/faraday/request.rb#27
2165
+ def body; end
2166
+
2167
+ # @return [String] body
2168
+ #
2169
+ # source://faraday//lib/faraday/request.rb#27
2170
+ def body=(_); end
2171
+
2172
+ # @return [Faraday::Utils::Headers] headers
2173
+ #
2174
+ # source://faraday//lib/faraday/request.rb#27
2175
+ def headers; end
2176
+
2177
+ # Replace request headers, preserving the existing hash type.
2178
+ #
2179
+ # @param hash [Hash] new headers
2180
+ #
2181
+ # source://faraday//lib/faraday/request.rb#27
2182
+ def headers=(hash); end
2183
+
2184
+ # @return [Symbol] the HTTP method of the Request
2185
+ #
2186
+ # source://faraday//lib/faraday/request.rb#27
2187
+ def http_method; end
2188
+
2189
+ # @return [Symbol] the HTTP method of the Request
2190
+ #
2191
+ # source://faraday//lib/faraday/request.rb#27
2192
+ def http_method=(_); end
2193
+
2194
+ # Marshal serialization support.
2195
+ #
2196
+ # @return [Hash] the hash ready to be serialized in Marshal.
2197
+ #
2198
+ # source://faraday//lib/faraday/request.rb#105
2199
+ def marshal_dump; end
2200
+
2201
+ # Marshal serialization support.
2202
+ # Restores the instance variables according to the +serialised+.
2203
+ #
2204
+ # @param serialised [Hash] the serialised object.
2205
+ #
2206
+ # source://faraday//lib/faraday/request.rb#119
2207
+ def marshal_load(serialised); end
2208
+
2209
+ # @return [RequestOptions] options
2210
+ #
2211
+ # source://faraday//lib/faraday/request.rb#27
2212
+ def options; end
2213
+
2214
+ # @return [RequestOptions] options
2215
+ #
2216
+ # source://faraday//lib/faraday/request.rb#27
2217
+ def options=(_); end
2218
+
2219
+ # @return [Hash] query parameters
2220
+ #
2221
+ # source://faraday//lib/faraday/request.rb#27
2222
+ def params; end
2223
+
2224
+ # Replace params, preserving the existing hash type.
2225
+ #
2226
+ # @param hash [Hash] new params
2227
+ #
2228
+ # source://faraday//lib/faraday/request.rb#27
2229
+ def params=(hash); end
2230
+
2231
+ # @return [URI, String] the path
2232
+ #
2233
+ # source://faraday//lib/faraday/request.rb#27
2234
+ def path; end
2235
+
2236
+ # @return [URI, String] the path
2237
+ #
2238
+ # source://faraday//lib/faraday/request.rb#27
2239
+ def path=(_); end
2240
+
2241
+ # @return [Env] the Env for this Request
2242
+ #
2243
+ # source://faraday//lib/faraday/request.rb#129
2244
+ def to_env(connection); end
2245
+
2246
+ # Update path and params.
2247
+ #
2248
+ # @param params [Hash, nil]
2249
+ # @param path [URI, String]
2250
+ # @return [void]
2251
+ #
2252
+ # source://faraday//lib/faraday/request.rb#74
2253
+ def url(path, params = T.unsafe(nil)); end
2254
+
2255
+ private
2256
+
2257
+ # source://faraday//lib/faraday/request.rb#30
2258
+ def member_get(_arg0); end
2259
+
2260
+ # source://faraday//lib/faraday/request.rb#32
2261
+ def member_set(_arg0, _arg1); end
2262
+
2263
+ class << self
2264
+ # source://faraday//lib/faraday/request.rb#27
2265
+ def [](*_arg0); end
2266
+
2267
+ # @param request_method [String]
2268
+ # @return [Request]
2269
+ # @yield [request] for block customization, if block given
2270
+ # @yieldparam request [Request]
2271
+ #
2272
+ # source://faraday//lib/faraday/request.rb#39
2273
+ def create(request_method); end
2274
+
2275
+ # source://faraday//lib/faraday/request.rb#27
2276
+ def inspect; end
2277
+
2278
+ # source://faraday//lib/faraday/request.rb#27
2279
+ def keyword_init?; end
2280
+
2281
+ # source://faraday//lib/faraday/request.rb#27
2282
+ def members; end
2283
+
2284
+ # source://faraday//lib/faraday/request.rb#27
2285
+ def new(*_arg0); end
2286
+ end
2287
+ end
2288
+
2289
+ # Request middleware for the Authorization HTTP header
2290
+ #
2291
+ # source://faraday//lib/faraday/request/authorization.rb#6
2292
+ class Faraday::Request::Authorization < ::Faraday::Middleware
2293
+ # @param app [#call]
2294
+ # @param params [Array<String, Proc, #call>] parameters to build the Authorization header.
2295
+ # If the type is `:basic`, then these can be a login and password pair.
2296
+ # Otherwise, a single value is expected that will be appended after the type.
2297
+ # This value can be a proc or an object responding to `.call`, in which case
2298
+ # it will be invoked on each request.
2299
+ # @param type [String, Symbol] Type of Authorization
2300
+ # @return [Authorization] a new instance of Authorization
2301
+ #
2302
+ # source://faraday//lib/faraday/request/authorization.rb#16
2303
+ def initialize(app, type, *params); end
2304
+
2305
+ # @param env [Faraday::Env]
2306
+ #
2307
+ # source://faraday//lib/faraday/request/authorization.rb#23
2308
+ def on_request(env); end
2309
+
2310
+ private
2311
+
2312
+ # @param env [Faraday::Env]
2313
+ # @param params [Array]
2314
+ # @param type [String, Symbol]
2315
+ # @return [String] a header value
2316
+ #
2317
+ # source://faraday//lib/faraday/request/authorization.rb#35
2318
+ def header_from(type, env, *params); end
2319
+ end
2320
+
2321
+ # source://faraday//lib/faraday/request/authorization.rb#7
2322
+ Faraday::Request::Authorization::KEY = T.let(T.unsafe(nil), String)
2323
+
2324
+ # Middleware for instrumenting Requests.
2325
+ #
2326
+ # source://faraday//lib/faraday/request/instrumentation.rb#6
2327
+ class Faraday::Request::Instrumentation < ::Faraday::Middleware
2328
+ # Instruments requests using Active Support.
2329
+ #
2330
+ # Measures time spent only for synchronous requests.
2331
+ #
2332
+ # @example Using ActiveSupport::Notifications to measure time spent
2333
+ # for Faraday requests.
2334
+ # ActiveSupport::Notifications
2335
+ # .subscribe('request.faraday') do |name, starts, ends, _, env|
2336
+ # url = env[:url]
2337
+ # http_method = env[:method].to_s.upcase
2338
+ # duration = ends - starts
2339
+ # $stderr.puts '[%s] %s %s (%.3f s)' %
2340
+ # [url.host, http_method, url.request_uri, duration]
2341
+ # end
2342
+ # @option options
2343
+ # @option options
2344
+ # @param app [#call]
2345
+ # @param options [nil, Hash] Options hash
2346
+ # @return [Instrumentation] a new instance of Instrumentation
2347
+ #
2348
+ # source://faraday//lib/faraday/request/instrumentation.rb#42
2349
+ def initialize(app, options = T.unsafe(nil)); end
2350
+
2351
+ # @param env [Faraday::Env]
2352
+ #
2353
+ # source://faraday//lib/faraday/request/instrumentation.rb#49
2354
+ def call(env); end
2355
+ end
2356
+
2357
+ # Options class used in Request::Instrumentation class.
2358
+ #
2359
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2360
+ class Faraday::Request::Instrumentation::Options < ::Faraday::Options
2361
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2362
+ def instrumenter; end
2363
+
2364
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2365
+ def instrumenter=(_); end
2366
+
2367
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2368
+ def name; end
2369
+
2370
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2371
+ def name=(_); end
2372
+
2373
+ class << self
2374
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2375
+ def [](*_arg0); end
2376
+
2377
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2378
+ def inspect; end
2379
+
2380
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2381
+ def keyword_init?; end
2382
+
2383
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2384
+ def members; end
2385
+
2386
+ # source://faraday//lib/faraday/request/instrumentation.rb#8
2387
+ def new(*_arg0); end
2388
+ end
2389
+ end
2390
+
2391
+ # Request middleware that encodes the body as JSON.
2392
+ #
2393
+ # Processes only requests with matching Content-type or those without a type.
2394
+ # If a request doesn't have a type but has a body, it sets the Content-type
2395
+ # to JSON MIME-type.
2396
+ #
2397
+ # Doesn't try to encode bodies that already are in string form.
2398
+ #
2399
+ # source://faraday//lib/faraday/request/json.rb#14
2400
+ class Faraday::Request::Json < ::Faraday::Middleware
2401
+ # source://faraday//lib/faraday/request/json.rb#18
2402
+ def on_request(env); end
2403
+
2404
+ private
2405
+
2406
+ # @return [Boolean]
2407
+ #
2408
+ # source://faraday//lib/faraday/request/json.rb#48
2409
+ def body?(env); end
2410
+
2411
+ # source://faraday//lib/faraday/request/json.rb#26
2412
+ def encode(data); end
2413
+
2414
+ # @yield []
2415
+ #
2416
+ # source://faraday//lib/faraday/request/json.rb#36
2417
+ def match_content_type(env); end
2418
+
2419
+ # @return [Boolean]
2420
+ #
2421
+ # source://faraday//lib/faraday/request/json.rb#43
2422
+ def process_request?(env); end
2423
+
2424
+ # source://faraday//lib/faraday/request/json.rb#61
2425
+ def request_type(env); end
2426
+ end
2427
+
2428
+ # source://faraday//lib/faraday/request/json.rb#15
2429
+ Faraday::Request::Json::MIME_TYPE = T.let(T.unsafe(nil), String)
2430
+
2431
+ # source://faraday//lib/faraday/request/json.rb#16
2432
+ Faraday::Request::Json::MIME_TYPE_REGEX = T.let(T.unsafe(nil), Regexp)
2433
+
2434
+ # Middleware for supporting urlencoded requests.
2435
+ #
2436
+ # source://faraday//lib/faraday/request/url_encoded.rb#6
2437
+ class Faraday::Request::UrlEncoded < ::Faraday::Middleware
2438
+ # Encodes as "application/x-www-form-urlencoded" if not already encoded or
2439
+ # of another type.
2440
+ #
2441
+ # @param env [Faraday::Env]
2442
+ #
2443
+ # source://faraday//lib/faraday/request/url_encoded.rb#20
2444
+ def call(env); end
2445
+
2446
+ # @param env [Faraday::Env]
2447
+ # @yield [request_body] Body of the request
2448
+ #
2449
+ # source://faraday//lib/faraday/request/url_encoded.rb#30
2450
+ def match_content_type(env); end
2451
+
2452
+ # @param env [Faraday::Env]
2453
+ # @return [Boolean] True if the request has a body and its Content-Type is
2454
+ # urlencoded.
2455
+ #
2456
+ # source://faraday//lib/faraday/request/url_encoded.rb#43
2457
+ def process_request?(env); end
2458
+
2459
+ # @param env [Faraday::Env]
2460
+ # @return [String]
2461
+ #
2462
+ # source://faraday//lib/faraday/request/url_encoded.rb#51
2463
+ def request_type(env); end
2464
+
2465
+ class << self
2466
+ # Returns the value of attribute mime_type.
2467
+ #
2468
+ # source://faraday//lib/faraday/request/url_encoded.rb#12
2469
+ def mime_type; end
2470
+
2471
+ # Sets the attribute mime_type
2472
+ #
2473
+ # @param value the value to set the attribute mime_type to.
2474
+ #
2475
+ # source://faraday//lib/faraday/request/url_encoded.rb#12
2476
+ def mime_type=(_arg0); end
2477
+ end
2478
+ end
2479
+
2480
+ # source://faraday//lib/faraday/request/url_encoded.rb#8
2481
+ Faraday::Request::UrlEncoded::CONTENT_TYPE = T.let(T.unsafe(nil), String)
2482
+
2483
+ # RequestOptions contains the configurable properties for a Faraday request.
2484
+ #
2485
+ # source://faraday//lib/faraday/options/request_options.rb#7
2486
+ class Faraday::RequestOptions < ::Faraday::Options
2487
+ # source://faraday//lib/faraday/options/request_options.rb#11
2488
+ def []=(key, value); end
2489
+
2490
+ # source://faraday//lib/faraday/options/request_options.rb#7
2491
+ def bind; end
2492
+
2493
+ # source://faraday//lib/faraday/options/request_options.rb#7
2494
+ def bind=(_); end
2495
+
2496
+ # source://faraday//lib/faraday/options/request_options.rb#7
2497
+ def boundary; end
2498
+
2499
+ # source://faraday//lib/faraday/options/request_options.rb#7
2500
+ def boundary=(_); end
2501
+
2502
+ # source://faraday//lib/faraday/options/request_options.rb#7
2503
+ def context; end
2504
+
2505
+ # source://faraday//lib/faraday/options/request_options.rb#7
2506
+ def context=(_); end
2507
+
2508
+ # source://faraday//lib/faraday/options/request_options.rb#7
2509
+ def oauth; end
2510
+
2511
+ # source://faraday//lib/faraday/options/request_options.rb#7
2512
+ def oauth=(_); end
2513
+
2514
+ # source://faraday//lib/faraday/options/request_options.rb#7
2515
+ def on_data; end
2516
+
2517
+ # source://faraday//lib/faraday/options/request_options.rb#7
2518
+ def on_data=(_); end
2519
+
2520
+ # source://faraday//lib/faraday/options/request_options.rb#7
2521
+ def open_timeout; end
2522
+
2523
+ # source://faraday//lib/faraday/options/request_options.rb#7
2524
+ def open_timeout=(_); end
2525
+
2526
+ # source://faraday//lib/faraday/options/request_options.rb#7
2527
+ def params_encoder; end
2528
+
2529
+ # source://faraday//lib/faraday/options/request_options.rb#7
2530
+ def params_encoder=(_); end
2531
+
2532
+ # source://faraday//lib/faraday/options/request_options.rb#7
2533
+ def proxy; end
2534
+
2535
+ # source://faraday//lib/faraday/options/request_options.rb#7
2536
+ def proxy=(_); end
2537
+
2538
+ # source://faraday//lib/faraday/options/request_options.rb#7
2539
+ def read_timeout; end
2540
+
2541
+ # source://faraday//lib/faraday/options/request_options.rb#7
2542
+ def read_timeout=(_); end
2543
+
2544
+ # source://faraday//lib/faraday/options/request_options.rb#19
2545
+ def stream_response?; end
2546
+
2547
+ # source://faraday//lib/faraday/options/request_options.rb#7
2548
+ def timeout; end
2549
+
2550
+ # source://faraday//lib/faraday/options/request_options.rb#7
2551
+ def timeout=(_); end
2552
+
2553
+ # source://faraday//lib/faraday/options/request_options.rb#7
2554
+ def write_timeout; end
2555
+
2556
+ # source://faraday//lib/faraday/options/request_options.rb#7
2557
+ def write_timeout=(_); end
2558
+
2559
+ class << self
2560
+ # source://faraday//lib/faraday/options/request_options.rb#7
2561
+ def [](*_arg0); end
2562
+
2563
+ # source://faraday//lib/faraday/options/request_options.rb#7
2564
+ def inspect; end
2565
+
2566
+ # source://faraday//lib/faraday/options/request_options.rb#7
2567
+ def keyword_init?; end
2568
+
2569
+ # source://faraday//lib/faraday/options/request_options.rb#7
2570
+ def members; end
2571
+
2572
+ # source://faraday//lib/faraday/options/request_options.rb#7
2573
+ def new(*_arg0); end
2574
+ end
2575
+ end
2576
+
2577
+ # Raised by Faraday::Response::RaiseError in case of a 408 response.
2578
+ #
2579
+ # source://faraday//lib/faraday/error.rb#150
2580
+ class Faraday::RequestTimeoutError < ::Faraday::ClientError; end
2581
+
2582
+ # Raised by Faraday::Response::RaiseError in case of a 404 response.
2583
+ #
2584
+ # source://faraday//lib/faraday/error.rb#142
2585
+ class Faraday::ResourceNotFound < ::Faraday::ClientError; end
2586
+
2587
+ # Response represents an HTTP response from making an HTTP request.
2588
+ #
2589
+ # source://faraday//lib/faraday/response.rb#7
2590
+ class Faraday::Response
2591
+ extend ::Forwardable
2592
+ extend ::Faraday::MiddlewareRegistry
2593
+
2594
+ # @return [Response] a new instance of Response
2595
+ #
2596
+ # source://faraday//lib/faraday/response.rb#11
2597
+ def initialize(env = T.unsafe(nil)); end
2598
+
2599
+ # source://faraday//lib/faraday/response.rb#30
2600
+ def [](*_arg0, **_arg1, &_arg2); end
2601
+
2602
+ # Expand the env with more properties, without overriding existing ones.
2603
+ # Useful for applying request params after restoring a marshalled Response.
2604
+ #
2605
+ # source://faraday//lib/faraday/response.rb#84
2606
+ def apply_request(request_env); end
2607
+
2608
+ # source://faraday//lib/faraday/response.rb#32
2609
+ def body; end
2610
+
2611
+ # Returns the value of attribute env.
2612
+ #
2613
+ # source://faraday//lib/faraday/response.rb#16
2614
+ def env; end
2615
+
2616
+ # source://faraday//lib/faraday/response.rb#53
2617
+ def finish(env); end
2618
+
2619
+ # @return [Boolean]
2620
+ #
2621
+ # source://faraday//lib/faraday/response.rb#40
2622
+ def finished?; end
2623
+
2624
+ # source://faraday//lib/faraday/response.rb#26
2625
+ def headers; end
2626
+
2627
+ # because @on_complete_callbacks cannot be marshalled
2628
+ #
2629
+ # source://faraday//lib/faraday/response.rb#74
2630
+ def marshal_dump; end
2631
+
2632
+ # source://faraday//lib/faraday/response.rb#78
2633
+ def marshal_load(env); end
2634
+
2635
+ # source://faraday//lib/faraday/response.rb#44
2636
+ def on_complete(&block); end
2637
+
2638
+ # source://faraday//lib/faraday/response.rb#22
2639
+ def reason_phrase; end
2640
+
2641
+ # source://faraday//lib/faraday/response.rb#18
2642
+ def status; end
2643
+
2644
+ # @return [Boolean]
2645
+ #
2646
+ # source://faraday//lib/faraday/response.rb#61
2647
+ def success?; end
2648
+
2649
+ # source://faraday//lib/faraday/response.rb#65
2650
+ def to_hash; end
2651
+
2652
+ # source://faraday//lib/faraday/response.rb#36
2653
+ def url; end
2654
+ end
2655
+
2656
+ # Parse response bodies as JSON.
2657
+ #
2658
+ # source://faraday//lib/faraday/response/json.rb#8
2659
+ class Faraday::Response::Json < ::Faraday::Middleware
2660
+ # @return [Json] a new instance of Json
2661
+ #
2662
+ # source://faraday//lib/faraday/response/json.rb#9
2663
+ def initialize(app = T.unsafe(nil), parser_options: T.unsafe(nil), content_type: T.unsafe(nil), preserve_raw: T.unsafe(nil)); end
2664
+
2665
+ # source://faraday//lib/faraday/response/json.rb#18
2666
+ def on_complete(env); end
2667
+
2668
+ private
2669
+
2670
+ # source://faraday//lib/faraday/response/json.rb#31
2671
+ def parse(body); end
2672
+
2673
+ # @return [Boolean]
2674
+ #
2675
+ # source://faraday//lib/faraday/response/json.rb#39
2676
+ def parse_response?(env); end
2677
+
2678
+ # source://faraday//lib/faraday/response/json.rb#57
2679
+ def process_parser_options; end
2680
+
2681
+ # source://faraday//lib/faraday/response/json.rb#24
2682
+ def process_response(env); end
2683
+
2684
+ # @return [Boolean]
2685
+ #
2686
+ # source://faraday//lib/faraday/response/json.rb#44
2687
+ def process_response_type?(env); end
2688
+
2689
+ # source://faraday//lib/faraday/response/json.rb#51
2690
+ def response_type(env); end
2691
+ end
2692
+
2693
+ # Logger is a middleware that logs internal events in the HTTP request
2694
+ # lifecycle to a given Logger object. By default, this logs to STDOUT. See
2695
+ # Faraday::Logging::Formatter to see specifically what is logged.
2696
+ #
2697
+ # source://faraday//lib/faraday/response/logger.rb#12
2698
+ class Faraday::Response::Logger < ::Faraday::Middleware
2699
+ # @return [Logger] a new instance of Logger
2700
+ # @yield [@formatter]
2701
+ #
2702
+ # source://faraday//lib/faraday/response/logger.rb#15
2703
+ def initialize(app, logger = T.unsafe(nil), options = T.unsafe(nil)); end
2704
+
2705
+ # source://faraday//lib/faraday/response/logger.rb#23
2706
+ def call(env); end
2707
+
2708
+ # source://faraday//lib/faraday/response/logger.rb#28
2709
+ def on_complete(env); end
2710
+
2711
+ # source://faraday//lib/faraday/response/logger.rb#32
2712
+ def on_error(exc); end
2713
+ end
2714
+
2715
+ # source://faraday//lib/faraday/response/logger.rb#13
2716
+ Faraday::Response::Logger::DEFAULT_OPTIONS = T.let(T.unsafe(nil), Hash)
2717
+
2718
+ # RaiseError is a Faraday middleware that raises exceptions on common HTTP
2719
+ # client or server error responses.
2720
+ #
2721
+ # source://faraday//lib/faraday/response/raise_error.rb#7
2722
+ class Faraday::Response::RaiseError < ::Faraday::Middleware
2723
+ # source://faraday//lib/faraday/response/raise_error.rb#25
2724
+ def on_complete(env); end
2725
+
2726
+ # source://faraday//lib/faraday/response/raise_error.rb#75
2727
+ def query_params(env); end
2728
+
2729
+ # Returns a hash of response data with the following keys:
2730
+ # - status
2731
+ # - headers
2732
+ # - body
2733
+ # - request
2734
+ #
2735
+ # The `request` key is omitted when the middleware is explicitly
2736
+ # configured with the option `include_request: false`.
2737
+ #
2738
+ # source://faraday//lib/faraday/response/raise_error.rb#52
2739
+ def response_values(env); end
2740
+ end
2741
+
2742
+ # source://faraday//lib/faraday/response/raise_error.rb#9
2743
+ Faraday::Response::RaiseError::ClientErrorStatuses = T.let(T.unsafe(nil), Range)
2744
+
2745
+ # source://faraday//lib/faraday/response/raise_error.rb#11
2746
+ Faraday::Response::RaiseError::ClientErrorStatusesWithCustomExceptions = T.let(T.unsafe(nil), Hash)
2747
+
2748
+ # source://faraday//lib/faraday/response/raise_error.rb#23
2749
+ Faraday::Response::RaiseError::DEFAULT_OPTIONS = T.let(T.unsafe(nil), Hash)
2750
+
2751
+ # source://faraday//lib/faraday/response/raise_error.rb#10
2752
+ Faraday::Response::RaiseError::ServerErrorStatuses = T.let(T.unsafe(nil), Range)
2753
+
2754
+ # A unified client error for SSL errors.
2755
+ #
2756
+ # source://faraday//lib/faraday/error.rb#192
2757
+ class Faraday::SSLError < ::Faraday::Error; end
2758
+
2759
+ # SSL-related options.
2760
+ #
2761
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2762
+ class Faraday::SSLOptions < ::Faraday::Options
2763
+ # @return [String] CA file
2764
+ #
2765
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2766
+ def ca_file; end
2767
+
2768
+ # @return [String] CA file
2769
+ #
2770
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2771
+ def ca_file=(_); end
2772
+
2773
+ # @return [String] CA path
2774
+ #
2775
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2776
+ def ca_path; end
2777
+
2778
+ # @return [String] CA path
2779
+ #
2780
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2781
+ def ca_path=(_); end
2782
+
2783
+ # @return [OpenSSL::X509::Store] certificate store
2784
+ #
2785
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2786
+ def cert_store; end
2787
+
2788
+ # @return [OpenSSL::X509::Store] certificate store
2789
+ #
2790
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2791
+ def cert_store=(_); end
2792
+
2793
+ # @return [OpenSSL::X509::Certificate] certificate (Excon only)
2794
+ #
2795
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2796
+ def certificate; end
2797
+
2798
+ # @return [OpenSSL::X509::Certificate] certificate (Excon only)
2799
+ #
2800
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2801
+ def certificate=(_); end
2802
+
2803
+ # @return [String] cipher list in OpenSSL format (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D)
2804
+ #
2805
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2806
+ def ciphers; end
2807
+
2808
+ # @return [String] cipher list in OpenSSL format (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D)
2809
+ #
2810
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2811
+ def ciphers=(_); end
2812
+
2813
+ # @return [String, OpenSSL::X509::Certificate] client certificate
2814
+ #
2815
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2816
+ def client_cert; end
2817
+
2818
+ # @return [String, OpenSSL::X509::Certificate] client certificate
2819
+ #
2820
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2821
+ def client_cert=(_); end
2822
+
2823
+ # @return [String, OpenSSL::PKey::RSA, OpenSSL::PKey::DSA] client key
2824
+ #
2825
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2826
+ def client_key; end
2827
+
2828
+ # @return [String, OpenSSL::PKey::RSA, OpenSSL::PKey::DSA] client key
2829
+ #
2830
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2831
+ def client_key=(_); end
2832
+
2833
+ # source://faraday//lib/faraday/options/ssl_options.rb#67
2834
+ def disable?; end
2835
+
2836
+ # @return [String] Server hostname used for SNI (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLSocket.html#method-i-hostname-3D)
2837
+ #
2838
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2839
+ def hostname; end
2840
+
2841
+ # @return [String] Server hostname used for SNI (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLSocket.html#method-i-hostname-3D)
2842
+ #
2843
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2844
+ def hostname=(_); end
2845
+
2846
+ # @return [String, Symbol] maximum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D)
2847
+ #
2848
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2849
+ def max_version; end
2850
+
2851
+ # @return [String, Symbol] maximum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D)
2852
+ #
2853
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2854
+ def max_version=(_); end
2855
+
2856
+ # @return [String, Symbol] minimum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D)
2857
+ #
2858
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2859
+ def min_version; end
2860
+
2861
+ # @return [String, Symbol] minimum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D)
2862
+ #
2863
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2864
+ def min_version=(_); end
2865
+
2866
+ # @return [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA] private key (Excon only)
2867
+ #
2868
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2869
+ def private_key; end
2870
+
2871
+ # @return [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA] private key (Excon only)
2872
+ #
2873
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2874
+ def private_key=(_); end
2875
+
2876
+ # @return [Boolean] whether to verify SSL certificates or not
2877
+ #
2878
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2879
+ def verify; end
2880
+
2881
+ # @return [Boolean] whether to verify SSL certificates or not
2882
+ #
2883
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2884
+ def verify=(_); end
2885
+
2886
+ # source://faraday//lib/faraday/options/ssl_options.rb#62
2887
+ def verify?; end
2888
+
2889
+ # @return [Integer] maximum depth for the certificate chain verification
2890
+ #
2891
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2892
+ def verify_depth; end
2893
+
2894
+ # @return [Integer] maximum depth for the certificate chain verification
2895
+ #
2896
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2897
+ def verify_depth=(_); end
2898
+
2899
+ # @return [Boolean] whether to enable hostname verification on server certificates
2900
+ # during the handshake or not (see https://github.com/ruby/openssl/pull/60)
2901
+ #
2902
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2903
+ def verify_hostname; end
2904
+
2905
+ # @return [Boolean] whether to enable hostname verification on server certificates
2906
+ # during the handshake or not (see https://github.com/ruby/openssl/pull/60)
2907
+ #
2908
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2909
+ def verify_hostname=(_); end
2910
+
2911
+ # source://faraday//lib/faraday/options/ssl_options.rb#72
2912
+ def verify_hostname?; end
2913
+
2914
+ # @return [Integer] Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
2915
+ #
2916
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2917
+ def verify_mode; end
2918
+
2919
+ # @return [Integer] Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
2920
+ #
2921
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2922
+ def verify_mode=(_); end
2923
+
2924
+ # @return [String, Symbol] SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D)
2925
+ #
2926
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2927
+ def version; end
2928
+
2929
+ # @return [String, Symbol] SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D)
2930
+ #
2931
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2932
+ def version=(_); end
2933
+
2934
+ class << self
2935
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2936
+ def [](*_arg0); end
2937
+
2938
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2939
+ def inspect; end
2940
+
2941
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2942
+ def keyword_init?; end
2943
+
2944
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2945
+ def members; end
2946
+
2947
+ # source://faraday//lib/faraday/options/ssl_options.rb#56
2948
+ def new(*_arg0); end
2949
+ end
2950
+ end
2951
+
2952
+ # Faraday server error class. Represents 5xx status responses.
2953
+ #
2954
+ # source://faraday//lib/faraday/error.rb#169
2955
+ class Faraday::ServerError < ::Faraday::Error; end
2956
+
2957
+ # A unified client error for timeouts.
2958
+ #
2959
+ # source://faraday//lib/faraday/error.rb#173
2960
+ class Faraday::TimeoutError < ::Faraday::ServerError
2961
+ # @return [TimeoutError] a new instance of TimeoutError
2962
+ #
2963
+ # source://faraday//lib/faraday/error.rb#174
2964
+ def initialize(exc = T.unsafe(nil), response = T.unsafe(nil)); end
2965
+ end
2966
+
2967
+ # Raised by Faraday::Response::RaiseError in case of a 429 response.
2968
+ #
2969
+ # source://faraday//lib/faraday/error.rb#165
2970
+ class Faraday::TooManyRequestsError < ::Faraday::ClientError; end
2971
+
2972
+ # Raised by Faraday::Response::RaiseError in case of a 401 response.
2973
+ #
2974
+ # source://faraday//lib/faraday/error.rb#134
2975
+ class Faraday::UnauthorizedError < ::Faraday::ClientError; end
2976
+
2977
+ # Raised by Faraday::Response::RaiseError in case of a 422 response.
2978
+ #
2979
+ # source://faraday//lib/faraday/error.rb#158
2980
+ class Faraday::UnprocessableContentError < ::Faraday::ClientError; end
2981
+
2982
+ # Used to provide compatibility with legacy error name.
2983
+ #
2984
+ # source://faraday//lib/faraday/error.rb#162
2985
+ Faraday::UnprocessableEntityError = Faraday::UnprocessableContentError
2986
+
2987
+ # Utils contains various static helper methods.
2988
+ #
2989
+ # source://faraday//lib/faraday/utils/headers.rb#4
2990
+ module Faraday::Utils
2991
+ private
2992
+
2993
+ # Normalize URI() behavior across Ruby versions
2994
+ #
2995
+ # url - A String or URI.
2996
+ #
2997
+ # Returns a parsed URI.
2998
+ #
2999
+ # source://faraday//lib/faraday/utils.rb#70
3000
+ def URI(url); end
3001
+
3002
+ # source://faraday//lib/faraday/utils.rb#55
3003
+ def basic_header_from(login, pass); end
3004
+
3005
+ # source://faraday//lib/faraday/utils.rb#16
3006
+ def build_nested_query(params); end
3007
+
3008
+ # source://faraday//lib/faraday/utils.rb#12
3009
+ def build_query(params); end
3010
+
3011
+ # Recursive hash merge
3012
+ #
3013
+ # source://faraday//lib/faraday/utils.rb#113
3014
+ def deep_merge(source, hash); end
3015
+
3016
+ # Recursive hash update
3017
+ #
3018
+ # source://faraday//lib/faraday/utils.rb#101
3019
+ def deep_merge!(target, hash); end
3020
+
3021
+ # source://faraday//lib/faraday/utils.rb#51
3022
+ def default_params_encoder; end
3023
+
3024
+ # source://faraday//lib/faraday/utils.rb#20
3025
+ def default_space_encoding; end
3026
+
3027
+ # source://faraday//lib/faraday/utils.rb#80
3028
+ def default_uri_parser; end
3029
+
3030
+ # source://faraday//lib/faraday/utils.rb#84
3031
+ def default_uri_parser=(parser); end
3032
+
3033
+ # source://faraday//lib/faraday/utils.rb#30
3034
+ def escape(str); end
3035
+
3036
+ # Receives a String or URI and returns just
3037
+ # the path with the query string sorted.
3038
+ #
3039
+ # source://faraday//lib/faraday/utils.rb#94
3040
+ def normalize_path(url); end
3041
+
3042
+ # source://faraday//lib/faraday/utils.rb#47
3043
+ def parse_nested_query(query); end
3044
+
3045
+ # Adapted from Rack
3046
+ #
3047
+ # source://faraday//lib/faraday/utils.rb#43
3048
+ def parse_query(query); end
3049
+
3050
+ # source://faraday//lib/faraday/utils.rb#117
3051
+ def sort_query_params(query); end
3052
+
3053
+ # source://faraday//lib/faraday/utils.rb#36
3054
+ def unescape(str); end
3055
+
3056
+ class << self
3057
+ # Normalize URI() behavior across Ruby versions
3058
+ #
3059
+ # url - A String or URI.
3060
+ #
3061
+ # Returns a parsed URI.
3062
+ #
3063
+ # source://faraday//lib/faraday/utils.rb#70
3064
+ def URI(url); end
3065
+
3066
+ # source://faraday//lib/faraday/utils.rb#55
3067
+ def basic_header_from(login, pass); end
3068
+
3069
+ # source://faraday//lib/faraday/utils.rb#16
3070
+ def build_nested_query(params); end
3071
+
3072
+ # source://faraday//lib/faraday/utils.rb#12
3073
+ def build_query(params); end
3074
+
3075
+ # Recursive hash merge
3076
+ #
3077
+ # source://faraday//lib/faraday/utils.rb#113
3078
+ def deep_merge(source, hash); end
3079
+
3080
+ # Recursive hash update
3081
+ #
3082
+ # source://faraday//lib/faraday/utils.rb#101
3083
+ def deep_merge!(target, hash); end
3084
+
3085
+ # source://faraday//lib/faraday/utils.rb#51
3086
+ def default_params_encoder; end
3087
+
3088
+ # Sets the attribute default_params_encoder
3089
+ #
3090
+ # @param value the value to set the attribute default_params_encoder to.
3091
+ #
3092
+ # source://faraday//lib/faraday/utils.rb#62
3093
+ def default_params_encoder=(_arg0); end
3094
+
3095
+ # source://faraday//lib/faraday/utils.rb#20
3096
+ def default_space_encoding; end
3097
+
3098
+ # Sets the attribute default_space_encoding
3099
+ #
3100
+ # @param value the value to set the attribute default_space_encoding to.
3101
+ #
3102
+ # source://faraday//lib/faraday/utils.rb#25
3103
+ def default_space_encoding=(_arg0); end
3104
+
3105
+ # source://faraday//lib/faraday/utils.rb#80
3106
+ def default_uri_parser; end
3107
+
3108
+ # source://faraday//lib/faraday/utils.rb#84
3109
+ def default_uri_parser=(parser); end
3110
+
3111
+ # source://faraday//lib/faraday/utils.rb#30
3112
+ def escape(str); end
3113
+
3114
+ # Receives a String or URI and returns just
3115
+ # the path with the query string sorted.
3116
+ #
3117
+ # source://faraday//lib/faraday/utils.rb#94
3118
+ def normalize_path(url); end
3119
+
3120
+ # source://faraday//lib/faraday/utils.rb#47
3121
+ def parse_nested_query(query); end
3122
+
3123
+ # Adapted from Rack
3124
+ #
3125
+ # source://faraday//lib/faraday/utils.rb#43
3126
+ def parse_query(query); end
3127
+
3128
+ # source://faraday//lib/faraday/utils.rb#117
3129
+ def sort_query_params(query); end
3130
+
3131
+ # source://faraday//lib/faraday/utils.rb#36
3132
+ def unescape(str); end
3133
+ end
3134
+ end
3135
+
3136
+ # source://faraday//lib/faraday/utils.rb#40
3137
+ Faraday::Utils::DEFAULT_SEP = T.let(T.unsafe(nil), Regexp)
3138
+
3139
+ # source://faraday//lib/faraday/utils.rb#28
3140
+ Faraday::Utils::ESCAPE_RE = T.let(T.unsafe(nil), Regexp)
3141
+
3142
+ # A case-insensitive Hash that preserves the original case of a header
3143
+ # when set.
3144
+ #
3145
+ # Adapted from Rack::Utils::HeaderHash
3146
+ #
3147
+ # source://faraday//lib/faraday/utils/headers.rb#9
3148
+ class Faraday::Utils::Headers < ::Hash
3149
+ # @return [Headers] a new instance of Headers
3150
+ #
3151
+ # source://faraday//lib/faraday/utils/headers.rb#20
3152
+ def initialize(hash = T.unsafe(nil)); end
3153
+
3154
+ # source://faraday//lib/faraday/utils/headers.rb#52
3155
+ def [](key); end
3156
+
3157
+ # source://faraday//lib/faraday/utils/headers.rb#57
3158
+ def []=(key, val); end
3159
+
3160
+ # source://faraday//lib/faraday/utils/headers.rb#71
3161
+ def delete(key); end
3162
+
3163
+ # source://faraday//lib/faraday/utils/headers.rb#80
3164
+ def dig(key, *rest); end
3165
+
3166
+ # source://faraday//lib/faraday/utils/headers.rb#65
3167
+ def fetch(key, *_arg1, **_arg2, &_arg3); end
3168
+
3169
+ # @return [Boolean]
3170
+ #
3171
+ # source://faraday//lib/faraday/utils/headers.rb#90
3172
+ def has_key?(key); end
3173
+
3174
+ # @return [Boolean]
3175
+ #
3176
+ # source://faraday//lib/faraday/utils/headers.rb#86
3177
+ def include?(key); end
3178
+
3179
+ # source://faraday//lib/faraday/utils/headers.rb#26
3180
+ def initialize_names; end
3181
+
3182
+ # @return [Boolean]
3183
+ #
3184
+ # source://faraday//lib/faraday/utils/headers.rb#92
3185
+ def key?(key); end
3186
+
3187
+ # @return [Boolean]
3188
+ #
3189
+ # source://faraday//lib/faraday/utils/headers.rb#91
3190
+ def member?(key); end
3191
+
3192
+ # source://faraday//lib/faraday/utils/headers.rb#101
3193
+ def merge(other); end
3194
+
3195
+ # source://faraday//lib/faraday/utils/headers.rb#94
3196
+ def merge!(other); end
3197
+
3198
+ # source://faraday//lib/faraday/utils/headers.rb#117
3199
+ def parse(header_string); end
3200
+
3201
+ # source://faraday//lib/faraday/utils/headers.rb#106
3202
+ def replace(other); end
3203
+
3204
+ # source://faraday//lib/faraday/utils/headers.rb#113
3205
+ def to_hash; end
3206
+
3207
+ # source://faraday//lib/faraday/utils/headers.rb#99
3208
+ def update(other); end
3209
+
3210
+ protected
3211
+
3212
+ # Returns the value of attribute names.
3213
+ #
3214
+ # source://faraday//lib/faraday/utils/headers.rb#135
3215
+ def names; end
3216
+
3217
+ private
3218
+
3219
+ # Join multiple values with a comma.
3220
+ #
3221
+ # source://faraday//lib/faraday/utils/headers.rb#140
3222
+ def add_parsed(key, value); end
3223
+
3224
+ # on dup/clone, we need to duplicate @names hash
3225
+ #
3226
+ # source://faraday//lib/faraday/utils/headers.rb#31
3227
+ def initialize_copy(other); end
3228
+
3229
+ class << self
3230
+ # source://faraday//lib/faraday/utils/headers.rb#14
3231
+ def allocate; end
3232
+
3233
+ # source://faraday//lib/faraday/utils/headers.rb#10
3234
+ def from(value); end
3235
+ end
3236
+ end
3237
+
3238
+ # symbol -> string mapper + cache
3239
+ #
3240
+ # source://faraday//lib/faraday/utils/headers.rb#40
3241
+ Faraday::Utils::Headers::KeyMap = T.let(T.unsafe(nil), Hash)
3242
+
3243
+ # A hash with stringified keys.
3244
+ #
3245
+ # source://faraday//lib/faraday/utils/params_hash.rb#6
3246
+ class Faraday::Utils::ParamsHash < ::Hash
3247
+ # source://faraday//lib/faraday/utils/params_hash.rb#7
3248
+ def [](key); end
3249
+
3250
+ # source://faraday//lib/faraday/utils/params_hash.rb#11
3251
+ def []=(key, value); end
3252
+
3253
+ # source://faraday//lib/faraday/utils/params_hash.rb#15
3254
+ def delete(key); end
3255
+
3256
+ # @return [Boolean]
3257
+ #
3258
+ # source://faraday//lib/faraday/utils/params_hash.rb#23
3259
+ def has_key?(key); end
3260
+
3261
+ # @return [Boolean]
3262
+ #
3263
+ # source://faraday//lib/faraday/utils/params_hash.rb#19
3264
+ def include?(key); end
3265
+
3266
+ # @return [Boolean]
3267
+ #
3268
+ # source://faraday//lib/faraday/utils/params_hash.rb#25
3269
+ def key?(key); end
3270
+
3271
+ # @return [Boolean]
3272
+ #
3273
+ # source://faraday//lib/faraday/utils/params_hash.rb#24
3274
+ def member?(key); end
3275
+
3276
+ # source://faraday//lib/faraday/utils/params_hash.rb#35
3277
+ def merge(params); end
3278
+
3279
+ # source://faraday//lib/faraday/utils/params_hash.rb#33
3280
+ def merge!(params); end
3281
+
3282
+ # source://faraday//lib/faraday/utils/params_hash.rb#44
3283
+ def merge_query(query, encoder = T.unsafe(nil)); end
3284
+
3285
+ # source://faraday//lib/faraday/utils/params_hash.rb#39
3286
+ def replace(other); end
3287
+
3288
+ # source://faraday//lib/faraday/utils/params_hash.rb#50
3289
+ def to_query(encoder = T.unsafe(nil)); end
3290
+
3291
+ # source://faraday//lib/faraday/utils/params_hash.rb#27
3292
+ def update(params); end
3293
+
3294
+ private
3295
+
3296
+ # source://faraday//lib/faraday/utils/params_hash.rb#56
3297
+ def convert_key(key); end
3298
+ end
3299
+
3300
+ # source://faraday//lib/faraday/version.rb#4
3301
+ Faraday::VERSION = T.let(T.unsafe(nil), String)