@@ -25,18 +25,26 @@ class Client < Knockapi::Internal::Transport::BaseClient
2525 # @return [Knockapi::Resources::Recipients]
2626 attr_reader :recipients
2727
28+ # A user is an individual from your system, represented in Knock. They are most
29+ # commonly a recipient of a notification.
2830 # @return [Knockapi::Resources::Users]
2931 attr_reader :users
3032
33+ # An object represents a resource in your system that you want to map into Knock.
3134 # @return [Knockapi::Resources::Objects]
3235 attr_reader :objects
3336
37+ # A tenant represents a top-level entity from your system, like a company,
38+ # organization, account, or workspace.
3439 # @return [Knockapi::Resources::Tenants]
3540 attr_reader :tenants
3641
42+ # A bulk operation is a set of changes applied across zero or more records
43+ # triggered via a call to the Knock API and performed asynchronously.
3744 # @return [Knockapi::Resources::BulkOperations]
3845 attr_reader :bulk_operations
3946
47+ # A message sent to a single recipient on a channel.
4048 # @return [Knockapi::Resources::Messages]
4149 attr_reader :messages
4250
@@ -46,15 +54,20 @@ class Client < Knockapi::Internal::Transport::BaseClient
4654 # @return [Knockapi::Resources::Integrations]
4755 attr_reader :integrations
4856
57+ # A workflow is a structured set of steps that is triggered to produce
58+ # notifications sent over channels.
4959 # @return [Knockapi::Resources::Workflows]
5060 attr_reader :workflows
5161
62+ # A schedule is a per-recipient, timezone-aware configuration for when to invoke a
63+ # workflow.
5264 # @return [Knockapi::Resources::Schedules]
5365 attr_reader :schedules
5466
5567 # @return [Knockapi::Resources::Channels]
5668 attr_reader :channels
5769
70+ # An Audience is a segment of users.
5871 # @return [Knockapi::Resources::Audiences]
5972 attr_reader :audiences
6073
0 commit comments