Class: Nimbu::Endpoints::Channels::Entries
- Inherits:
-
Nimbu::Endpoint
- Object
- Nimbu::Endpoint
- Nimbu::Endpoints::Channels::Entries
- Defined in:
- lib/nimbu-api/endpoints/channels/entries.rb
Constant Summary
Constants included from Request
Request::METHODS, Request::METHODS_WITH_BODIES
Constants included from Utils::Constants
Utils::Constants::ACCEPT, Utils::Constants::ACCEPTED_OAUTH_SCOPES, Utils::Constants::ACCEPT_CHARSET, Utils::Constants::CACHE_CONTROL, Utils::Constants::CONTENT_LENGTH, Utils::Constants::CONTENT_TYPE, Utils::Constants::DATE, Utils::Constants::ETAG, Utils::Constants::HEADER_LAST, Utils::Constants::HEADER_LINK, Utils::Constants::HEADER_NEXT, Utils::Constants::LOCATION, Utils::Constants::META_FIRST, Utils::Constants::META_LAST, Utils::Constants::META_NEXT, Utils::Constants::META_PREV, Utils::Constants::META_REL, Utils::Constants::NIMBU_SITE, Utils::Constants::OAUTH_SCOPES, Utils::Constants::PARAM_PAGE, Utils::Constants::PARAM_PER_PAGE, Utils::Constants::PARAM_START_PAGE, Utils::Constants::RATELIMIT_LIMIT, Utils::Constants::RATELIMIT_REMAINING, Utils::Constants::SERVER, Utils::Constants::USER_AGENT
Constants included from Connection
Instance Attribute Summary
Attributes inherited from Nimbu::Endpoint
Attributes included from Authentication
Instance Method Summary collapse
- #count(*args) ⇒ Object
- #create(*args) ⇒ Object
- #delete(*args) ⇒ Object (also: #remove)
- #first(*args) ⇒ Object
- #get(*args) ⇒ Object (also: #find)
- #list(*args, &block) ⇒ Object (also: #all)
- #list_deleted(*args) ⇒ Object (also: #list_removed)
- #update(*args) ⇒ Object (also: #edit)
Methods inherited from Nimbu::Endpoint
#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval
Methods included from Request
#delete_request, #get_request, #patch_request, #post_request, #put_request, #request
Methods included from Connection
#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack
Methods included from Authentication
#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token
Constructor Details
This class inherits a constructor from Nimbu::Endpoint
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Nimbu::Endpoint
Instance Method Details
#count(*args) ⇒ Object
33 34 35 36 37 |
# File 'lib/nimbu-api/endpoints/channels/entries.rb', line 33 def count(*args) arguments(args, required: [:channel_id]) get_request("/channels/#{channel_id}/entries/count", arguments.params) end |
#create(*args) ⇒ Object
46 47 48 49 50 |
# File 'lib/nimbu-api/endpoints/channels/entries.rb', line 46 def create(*args) arguments(args, required: [:channel_id]) post_request("/channels/#{channel_id}/entries", arguments.params, with_attachments: true) end |
#delete(*args) ⇒ Object Also known as: remove
59 60 61 62 63 |
# File 'lib/nimbu-api/endpoints/channels/entries.rb', line 59 def delete(*args) arguments(args, required: [:channel_id, :entry_id]) delete_request("/channels/#{channel_id}/entries/#{entry_id}", arguments.params) end |
#first(*args) ⇒ Object
20 21 22 23 24 |
# File 'lib/nimbu-api/endpoints/channels/entries.rb', line 20 def first(*args) arguments(args, required: [:channel_id]) get_request("/channels/#{channel_id}/entries", arguments.params.merge(limit: 1)).first end |
#get(*args) ⇒ Object Also known as: find
39 40 41 42 43 |
# File 'lib/nimbu-api/endpoints/channels/entries.rb', line 39 def get(*args) arguments(args, required: [:channel_id, :entry_id]) get_request("/channels/#{channel_id}/entries/#{entry_id}", arguments.params) end |
#list(*args, &block) ⇒ Object Also known as: all
7 8 9 10 11 12 13 14 15 16 17 |
# File 'lib/nimbu-api/endpoints/channels/entries.rb', line 7 def list(*args, &block) arguments(args, required: [:channel_id]) response = get_request("/channels/#{channel_id}/entries", arguments.params) if block_given? response.each(&block) else response end end |
#list_deleted(*args) ⇒ Object Also known as: list_removed
26 27 28 29 30 |
# File 'lib/nimbu-api/endpoints/channels/entries.rb', line 26 def list_deleted(*args) arguments(args, required: [:channel_id]) get_request("/channels/#{channel_id}/entries/deleted", arguments.params) end |
#update(*args) ⇒ Object Also known as: edit
52 53 54 55 56 |
# File 'lib/nimbu-api/endpoints/channels/entries.rb', line 52 def update(*args) arguments(args, required: [:channel_id, :entry_id]) patch_request("/channels/#{channel_id}/entries/#{entry_id}", arguments.params, with_attachments: true) end |