Class: ZendeskAPI::Resource

Inherits:

DataResource

• Object
• Data
• DataResource
• ZendeskAPI::Resource

Includes:

Create, Destroy, Read, Update

Defined in:

lib/zendesk_api/resource.rb

Overview

Represents a resource that can CRUD (create, read, update, delete).

Direct Known Subclasses

Activity, App, App::Plan, AppInstallation, Bookmark, Brand, Category, DynamicContent::Item, DynamicContent::Item::Variant, Forum, ForumSubscription, Group, GroupMembership, MobileDevice, OauthClient, Organization, OrganizationField, Request, Rule, SingularResource, Target, Ticket, TicketField, TicketForm, Topic, TopicSubscription, User, User::GroupMembership, User::Identity, User::Session, UserField, Voice::Address, Voice::Greeting, Voice::GreetingCategory, Voice::PhoneNumber

Instance Method Summary

• #clear_associations ⇒ Object included from Save

  Removes all cached associations.

• #destroy(&block) ⇒ Object included from Destroy

  Destroys, returning false on error.

• #destroy! ⇒ Boolean included from Destroy

  If this resource hasn't already been deleted, then do so.

• #destroyed? ⇒ Boolean included from Destroy

  Has this object been deleted?.

• #handle_response(response) ⇒ Object included from ResponseHandler
• #reload! ⇒ Object included from Read

  Reloads a resource.

• #save(options = {}, &block) ⇒ Object included from Save

  Saves, returning false if it fails and attaching the errors.

• #save!(options = {}) ⇒ Boolean included from Save

  If this resource hasn't been deleted, then create or save it.

• #save_associations ⇒ Object included from Save

  Saves associations Takes into account inlining, collections, and id setting on the parent resource.

Constructor Details

This class inherits a constructor from ZendeskAPI::Data

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ZendeskAPI::Data

Instance Method Details

#clear_associations ⇒ Object Originally defined in module Save

Removes all cached associations

#destroy(&block) ⇒ Object Originally defined in module Destroy

Destroys, returning false on error.

#destroy! ⇒ Boolean Originally defined in module Destroy

If this resource hasn't already been deleted, then do so.

Returns:

• (Boolean) —

  Successful?

#destroyed? ⇒ Boolean Originally defined in module Destroy

Has this object been deleted?

Returns:

• (Boolean)

#handle_response(response) ⇒ Object Originally defined in module ResponseHandler

#reload! ⇒ Object Originally defined in module Read

Reloads a resource.

#save(options = {}, &block) ⇒ Object Originally defined in module Save

Saves, returning false if it fails and attaching the errors

#save!(options = {}) ⇒ Boolean Originally defined in module Save

If this resource hasn't been deleted, then create or save it. Executes a POST if it is a Data#new_record?, otherwise a PUT. Merges returned attributes on success.

Returns:

• (Boolean) —

  Success?

#save_associations ⇒ Object Originally defined in module Save

Saves associations Takes into account inlining, collections, and id setting on the parent resource.