Class: ZendeskAPI::Resource

Inherits:
DataResource show all
Extended by:
Read
Includes:
Create, Destroy, Update
Defined in:
lib/zendesk_api/resource.rb

Overview

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

Direct Known Subclasses

Activity, Bookmark, Category, Forum, ForumSubscription, Group, GroupMembership, MobileDevice, OAuthClient, Organization, OrganizationField, Request, Rule, SingularResource, Ticket, Ticket::Tag, TicketField, Topic, TopicSubscription, User, User::Identity, UserField

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

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 Attribute Details

- (ZendeskAPI::Association) association Originally defined in class Data

The association

Returns:

  • (ZendeskAPI::Association) —

    The association

- (Hash) attributes (readonly) Also known as: to_param Originally defined in class Data

The resource's attributes

Returns:

  • (Hash) —

    The resource's attributes

- (Object) error Originally defined in class DataResource

Returns the value of attribute error

- (Object) error_message Originally defined in class DataResource

Returns the value of attribute error_message

- (Array) errors Originally defined in class Data

The last received errors

Returns:

  • (Array) —

    The last received errors

- (Object) response Originally defined in class Data

Place to dump the last response

Class Method Details

+ (Object) find(client, options = {}) Originally defined in module Read

Finds, returning nil if it fails

+ (Object) find!(client, options = {}) Originally defined in module Read

Finds a resource by an id and any options passed in. A custom path to search at can be passed into opts. It defaults to the Data.resource_name of the class.

Parameters:

  • client (Client) —

    The Client object to be used

  • options (Hash) (defaults to: {}) —

    Any additional GET parameters to be added

Raises:

  • (ArgumentError)

Instance Method Details

- (Object) clear_associations Originally defined in module Save

Removes all cached associations

- (Object) destroy Originally defined in module Destroy

- (Boolean) destroy! Originally defined in module Destroy

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

Returns:

  • (Boolean) —

    Successful?

- (Boolean) destroyed? Originally defined in module Destroy

Has this object been deleted?

Returns:

  • (Boolean)

- (Object) save(options = {}) Originally defined in module Save

Saves, returning false if it fails and attaching the errors

- (Boolean) save!(options = {}) 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?

- (Object) save_associations Originally defined in module Save

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