Class: Nylas::Client

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

Overview

Methods to retrieve data from the Nylas API as Ruby objects.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, api_uri: Config::DEFAULT_REGION_URL, timeout: nil) ⇒ Client

Initializes a client session.

Parameters:

  • api_key (String, nil) —

    API key to use for the client session.

  • api_uri (String) (defaults to: Config::DEFAULT_REGION_URL) —

    Client session's host.

  • timeout (Integer, nil) (defaults to: nil) —

    Timeout value to use for the client session.



25
26
27
28
29
30
31
 
# File 'lib/nylas/client.rb', line 25

def initialize(api_key:,
               api_uri: Config::DEFAULT_REGION_URL,
               timeout: nil)
  @api_key = api_key
  @api_uri = api_uri
  @timeout = timeout || 90
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



18
19
20
 
# File 'lib/nylas/client.rb', line 18

def api_key
  @api_key
end

#api_uri ⇒ Object (readonly)

Returns the value of attribute api_uri.



18
19
20
 
# File 'lib/nylas/client.rb', line 18

def api_uri
  @api_uri
end

#timeout ⇒ Object (readonly)

Returns the value of attribute timeout.



18
19
20
 
# File 'lib/nylas/client.rb', line 18

def timeout
  @timeout
end

Instance Method Details

#applications ⇒ Nylas::Applications

The application resources for your Nylas application.

Returns:



36
37
38
 
# File 'lib/nylas/client.rb', line 36

def applications
  Applications.new(self)
end

#attachments ⇒ Nylas::Attachments

The attachments resources for your Nylas application.

Returns:



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

def attachments
  Attachments.new(self)
end

#auth ⇒ Nylas::Auth

The auth resources for your Nylas application.

Returns:

  • (Nylas::Auth) —

    Auth resources for your Nylas application.



50
51
52
 
# File 'lib/nylas/client.rb', line 50

def auth
  Auth.new(self)
end

#calendars ⇒ Nylas::Calendars

The calendar resources for your Nylas application.

Returns:



57
58
59
 
# File 'lib/nylas/client.rb', line 57

def calendars
  Calendars.new(self)
end

#connectors ⇒ Nylas::Connectors

The connector resources for your Nylas application.

Returns:



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

def connectors
  Connectors.new(self)
end

#contacts ⇒ Nylas::Contacts

The contact resources for your Nylas application.

Returns:



71
72
73
 
# File 'lib/nylas/client.rb', line 71

def contacts
  Contacts.new(self)
end

#domains ⇒ Nylas::Domains

The domain resources for your Nylas application.

Returns:



148
149
150
 
# File 'lib/nylas/client.rb', line 148

def domains
  Domains.new(self)
end

#drafts ⇒ Nylas::Drafts

The draft resources for your Nylas application.

Returns:

  • (Nylas::Drafts) —

    Draft resources for your Nylas application.



78
79
80
 
# File 'lib/nylas/client.rb', line 78

def drafts
  Drafts.new(self)
end

#events ⇒ Nylas::Events

The event resources for your Nylas application.

Returns:



85
86
87
 
# File 'lib/nylas/client.rb', line 85

def events
  Events.new(self)
end

#folders ⇒ Nylas::Folder

The folder resources for your Nylas application.

Returns:

  • (Nylas::Folder) —

    Folder resources for your Nylas application



92
93
94
 
# File 'lib/nylas/client.rb', line 92

def folders
  Folders.new(self)
end

#grants ⇒ Nylas::Grants

The grants resources for your Nylas application.

Returns:



99
100
101
 
# File 'lib/nylas/client.rb', line 99

def grants
  Grants.new(self)
end

#lists ⇒ Nylas::Lists

The list resources for your Nylas application.

Returns:

  • (Nylas::Lists) —

    List resources for your Nylas application



106
107
108
 
# File 'lib/nylas/client.rb', line 106

def lists
  Lists.new(self)
end

#messages ⇒ Nylas::Messages

The message resources for your Nylas application.

Returns:



113
114
115
 
# File 'lib/nylas/client.rb', line 113

def messages
  Messages.new(self)
end

#notetakers ⇒ Nylas::Notetakers

The Notetaker resources for your Nylas application.

Returns:



167
168
169
 
# File 'lib/nylas/client.rb', line 167

def notetakers
  Notetakers.new(self)
end

#policies ⇒ Nylas::Policies

The policy resources for your Nylas application.

Returns:



127
128
129
 
# File 'lib/nylas/client.rb', line 127

def policies
  Policies.new(self)
end

#rules ⇒ Nylas::Rules

The rule resources for your Nylas application.

Returns:

  • (Nylas::Rules) —

    Rule resources for your Nylas application.



134
135
136
 
# File 'lib/nylas/client.rb', line 134

def rules
  Rules.new(self)
end

#scheduler ⇒ Nylas::Scheduler

The Scheduler resources for your Nylas application.

Returns:



161
162
163
 
# File 'lib/nylas/client.rb', line 161

def scheduler
  Scheduler.new(self)
end

#threads ⇒ Nylas::Threads

The thread resources for your Nylas application.

Returns:



120
121
122
 
# File 'lib/nylas/client.rb', line 120

def threads
  Threads.new(self)
end

#webhooks ⇒ Nylas::Webhooks

The webhook resources for your Nylas application.

Returns:



155
156
157
 
# File 'lib/nylas/client.rb', line 155

def webhooks
  Webhooks.new(self)
end

#workspaces ⇒ Nylas::Workspaces

The workspace resources for your Nylas application.

Returns:



141
142
143
 
# File 'lib/nylas/client.rb', line 141

def workspaces
  Workspaces.new(self)
end