Class: Zavudev::Client

Inherits:
Internal::Transport::BaseClient show all
Defined in:
lib/zavudev/client.rb

Constant Summary collapse

DEFAULT_MAX_RETRIES =

Default max number of retries to attempt after a failed retryable request.

2
DEFAULT_TIMEOUT_IN_SECONDS =

Default per-request timeout.

60.0
DEFAULT_INITIAL_RETRY_DELAY =

Default initial retry delay in seconds. Overall delay is calculated using exponential backoff + jitter.

0.5
DEFAULT_MAX_RETRY_DELAY =

Default max retry delay in seconds.

8.0

Constants inherited from Internal::Transport::BaseClient

Internal::Transport::BaseClient::MAX_REDIRECTS, Internal::Transport::BaseClient::PLATFORM_HEADERS

Instance Attribute Summary collapse

Attributes inherited from Internal::Transport::BaseClient

#base_url, #headers, #idempotency_header, #initial_retry_delay, #max_retries, #max_retry_delay, #requester, #timeout

Instance Method Summary collapse

Methods inherited from Internal::Transport::BaseClient

follow_redirect, #inspect, reap_connection!, #request, #send_request, should_retry?, validate!

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(api_key: ENV["ZAVUDEV_API_KEY"], base_url: ENV["ZAVUDEV_BASE_URL"], max_retries: self.class::DEFAULT_MAX_RETRIES, timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS, initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY, max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY) ⇒ Client

Creates and returns a new client for interacting with the API.

‘“api.example.com/v2/”`. Defaults to `ENV`

Parameters:

  • api_key (String, nil) (defaults to: ENV["ZAVUDEV_API_KEY"]) —

    Defaults to ‘ENV`

  • base_url (String, nil) (defaults to: ENV["ZAVUDEV_BASE_URL"]) —

    Override the default base URL for the API, e.g.,

  • max_retries (Integer) (defaults to: self.class::DEFAULT_MAX_RETRIES) —

    Max number of retries to attempt after a failed retryable request.

  • timeout (Float) (defaults to: self.class::DEFAULT_TIMEOUT_IN_SECONDS)
  • initial_retry_delay (Float) (defaults to: self.class::DEFAULT_INITIAL_RETRY_DELAY)
  • max_retry_delay (Float) (defaults to: self.class::DEFAULT_MAX_RETRY_DELAY) 


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/zavudev/client.rb', line 95

def initialize(
  api_key: ENV["ZAVUDEV_API_KEY"],
  base_url: ENV["ZAVUDEV_BASE_URL"],
  max_retries: self.class::DEFAULT_MAX_RETRIES,
  timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
  initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
  max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
)
  base_url ||= "https://api.zavu.dev"

  if api_key.nil?
    raise ArgumentError.new("api_key is required, and can be set via environ: \"ZAVUDEV_API_KEY\"")
  end

  @api_key = api_key.to_s

  super(
    base_url: base_url,
    timeout: timeout,
    max_retries: max_retries,
    initial_retry_delay: initial_retry_delay,
    max_retry_delay: max_retry_delay
  )

  @messages = Zavudev::Resources::Messages.new(client: self)
  @templates = Zavudev::Resources::Templates.new(client: self)
  @senders = Zavudev::Resources::Senders.new(client: self)
  @contacts = Zavudev::Resources::Contacts.new(client: self)
  @broadcasts = Zavudev::Resources::Broadcasts.new(client: self)
  @introspect = Zavudev::Resources::Introspect.new(client: self)
  @phone_numbers = Zavudev::Resources::PhoneNumbers.new(client: self)
  @addresses = Zavudev::Resources::Addresses.new(client: self)
  @regulatory_documents = Zavudev::Resources::RegulatoryDocuments.new(client: self)
  @invitations = Zavudev::Resources::Invitations.new(client: self)
  @exports = Zavudev::Resources::Exports.new(client: self)
  @urls = Zavudev::Resources::URLs.new(client: self)
  @balance = Zavudev::Resources::Balance.new(client: self)
  @plan = Zavudev::Resources::Plan.new(client: self)
  @usage = Zavudev::Resources::Usage.new(client: self)
  @sub_accounts = Zavudev::Resources::SubAccounts.new(client: self)
  @number_10dlc = Zavudev::Resources::Number10dlc.new(client: self)
end

Instance Attribute Details

#addresses ⇒ Zavudev::Resources::Addresses (readonly)

Returns:



43
44
45
 
# File 'lib/zavudev/client.rb', line 43

def addresses
  @addresses
end

#api_key ⇒ String (readonly)

Returns:

  • (String) 


19
20
21
 
# File 'lib/zavudev/client.rb', line 19

def api_key
  @api_key
end

#balance ⇒ Zavudev::Resources::Balance (readonly)

Returns:



58
59
60
 
# File 'lib/zavudev/client.rb', line 58

def balance
  @balance
end

#broadcasts ⇒ Zavudev::Resources::Broadcasts (readonly)

Returns:



34
35
36
 
# File 'lib/zavudev/client.rb', line 34

def broadcasts
  @broadcasts
end

#contacts ⇒ Zavudev::Resources::Contacts (readonly)

Returns:



31
32
33
 
# File 'lib/zavudev/client.rb', line 31

def contacts
  @contacts
end

#exports ⇒ Zavudev::Resources::Exports (readonly)

Returns:



52
53
54
 
# File 'lib/zavudev/client.rb', line 52

def exports
  @exports
end

#introspect ⇒ Zavudev::Resources::Introspect (readonly)

Returns:



37
38
39
 
# File 'lib/zavudev/client.rb', line 37

def introspect
  @introspect
end

#invitations ⇒ Zavudev::Resources::Invitations (readonly)

Returns:



49
50
51
 
# File 'lib/zavudev/client.rb', line 49

def invitations
  @invitations
end

#messages ⇒ Zavudev::Resources::Messages (readonly)

Returns:



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

def messages
  @messages
end

#number_10dlc ⇒ Zavudev::Resources::Number10dlc (readonly)

Returns:



70
71
72
 
# File 'lib/zavudev/client.rb', line 70

def number_10dlc
  @number_10dlc
end

#phone_numbers ⇒ Zavudev::Resources::PhoneNumbers (readonly)

Returns:



40
41
42
 
# File 'lib/zavudev/client.rb', line 40

def phone_numbers
  @phone_numbers
end

#plan ⇒ Zavudev::Resources::Plan (readonly)

Returns:



61
62
63
 
# File 'lib/zavudev/client.rb', line 61

def plan
  @plan
end

#regulatory_documents ⇒ Zavudev::Resources::RegulatoryDocuments (readonly)

Returns:



46
47
48
 
# File 'lib/zavudev/client.rb', line 46

def regulatory_documents
  @regulatory_documents
end

#senders ⇒ Zavudev::Resources::Senders (readonly)

Returns:



28
29
30
 
# File 'lib/zavudev/client.rb', line 28

def senders
  @senders
end

#sub_accounts ⇒ Zavudev::Resources::SubAccounts (readonly)

Returns:



67
68
69
 
# File 'lib/zavudev/client.rb', line 67

def sub_accounts
  @sub_accounts
end

#templates ⇒ Zavudev::Resources::Templates (readonly)

Returns:



25
26
27
 
# File 'lib/zavudev/client.rb', line 25

def templates
  @templates
end

#urls ⇒ Zavudev::Resources::URLs (readonly)

Returns:



55
56
57
 
# File 'lib/zavudev/client.rb', line 55

def urls
  @urls
end

#usage ⇒ Zavudev::Resources::Usage (readonly)

Returns:



64
65
66
 
# File 'lib/zavudev/client.rb', line 64

def usage
  @usage
end