Class: Bandwidth::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth/client.rb

Overview

bandwidth client class.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(timeout: 60, max_retries: 0, retry_interval: 1, backoff_factor: 2, retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put get put], environment: Environment::PRODUCTION, base_url: 'https://www.example.com', messaging_basic_auth_user_name: 'TODO: Replace', messaging_basic_auth_password: 'TODO: Replace', multi_factor_auth_basic_auth_user_name: 'TODO: Replace', multi_factor_auth_basic_auth_password: 'TODO: Replace', phone_number_lookup_basic_auth_user_name: 'TODO: Replace', phone_number_lookup_basic_auth_password: 'TODO: Replace', voice_basic_auth_user_name: 'TODO: Replace', voice_basic_auth_password: 'TODO: Replace', web_rtc_basic_auth_user_name: 'TODO: Replace', web_rtc_basic_auth_password: 'TODO: Replace', config: nil) ⇒ Client

Returns a new instance of Client.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/bandwidth/client.rb', line 36

def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
               backoff_factor: 2,
               retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
               retry_methods: %i[get put get put],
               environment: Environment::PRODUCTION,
               base_url: 'https://www.example.com',
               messaging_basic_auth_user_name: 'TODO: Replace',
               messaging_basic_auth_password: 'TODO: Replace',
               multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
               multi_factor_auth_basic_auth_password: 'TODO: Replace',
               phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
               phone_number_lookup_basic_auth_password: 'TODO: Replace',
               voice_basic_auth_user_name: 'TODO: Replace',
               voice_basic_auth_password: 'TODO: Replace',
               web_rtc_basic_auth_user_name: 'TODO: Replace',
               web_rtc_basic_auth_password: 'TODO: Replace', config: nil)
  @config = if config.nil?
              Configuration.new(timeout: timeout, max_retries: max_retries,
                                retry_interval: retry_interval,
                                backoff_factor: backoff_factor,
                                retry_statuses: retry_statuses,
                                retry_methods: retry_methods,
                                environment: environment,
                                base_url: base_url,
                                messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                messaging_basic_auth_password: messaging_basic_auth_password,
                                multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
                                multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
                                phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
                                phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
                                voice_basic_auth_user_name: voice_basic_auth_user_name,
                                voice_basic_auth_password: voice_basic_auth_password,
                                web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
                                web_rtc_basic_auth_password: web_rtc_basic_auth_password)
            else
              config
            end
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



9
10
11
 
# File 'lib/bandwidth/client.rb', line 9

def config
  @config
end

Instance Method Details

#messaging_client ⇒ Messaging::Client

Access to messaging_client controller.

Returns:



12
13
14
 
# File 'lib/bandwidth/client.rb', line 12

def messaging_client
  @messaging_client ||= Messaging::Client.new(config: config)
end

#multi_factor_auth_client ⇒ MultiFactorAuth::Client

Access to multi_factor_auth_client controller.

Returns:



17
18
19
 
# File 'lib/bandwidth/client.rb', line 17

def multi_factor_auth_client
  @multi_factor_auth_client ||= MultiFactorAuth::Client.new(config: config)
end

#phone_number_lookup_client ⇒ PhoneNumberLookup::Client

Access to phone_number_lookup_client controller.

Returns:



22
23
24
 
# File 'lib/bandwidth/client.rb', line 22

def phone_number_lookup_client
  @phone_number_lookup_client ||= PhoneNumberLookup::Client.new(config: config)
end

#voice_client ⇒ Voice::Client

Access to voice_client controller.

Returns:



27
28
29
 
# File 'lib/bandwidth/client.rb', line 27

def voice_client
  @voice_client ||= Voice::Client.new(config: config)
end

#web_rtc_client ⇒ WebRtc::Client

Access to web_rtc_client controller.

Returns:



32
33
34
 
# File 'lib/bandwidth/client.rb', line 32

def web_rtc_client
  @web_rtc_client ||= WebRtc::Client.new(config: config)
end