Table of Contents - desk_api-0.6.2 Documentation
Pages
-
README
- DeskApi a client for API v2
- An official Desk API Client
- Getting Started
- Installation
- Configuration
- Authentication Mechanism
- Basic Authentication
- OAuth 1.0a
- Trust is our #1 value
- First Environmental Variables
- Second Configuration Option
- Third Configuration Option
- Resources
- Create Read Update Delete
- Getters & Setters
- Find
- Pagination
all
andeach_page
- List params
- Sorting
- Links
- Lazy loading
- Embedding
- Downloading Attachments
- API Errors
- License
Classes and Modules
- DeskApi
- DeskApi::Client
- DeskApi::Configuration
- DeskApi::Default
- DeskApi::Error
- DeskApi::Error::BadGateway
- DeskApi::Error::BadRequest
- DeskApi::Error::ClientError
- DeskApi::Error::ConfigurationError
- DeskApi::Error::Conflict
- DeskApi::Error::FollowRedirectError
- DeskApi::Error::Forbidden
- DeskApi::Error::GatewayTimeout
- DeskApi::Error::InternalServerError
- DeskApi::Error::MethodNotAllowed
- DeskApi::Error::NotAcceptable
- DeskApi::Error::NotFound
- DeskApi::Error::ParserError
- DeskApi::Error::ServerError
- DeskApi::Error::ServiceUnavailable
- DeskApi::Error::TooManyRequests
- DeskApi::Error::Unauthorized
- DeskApi::Error::UnprocessableEntity
- DeskApi::Error::UnsupportedMediaType
- DeskApi::RateLimit
- DeskApi::Request
- DeskApi::Request::EncodeDates
- DeskApi::Request::EncodeJson
- DeskApi::Request::OAuth
- DeskApi::Request::Retry
- DeskApi::Request::Retry::matcher;
- DeskApi::Resource
- DeskApi::Resource::Download
- DeskApi::Resource::Pagination
- DeskApi::Resource::QueryParams
- DeskApi::Resource::SCRUD
- DeskApi::Response
- DeskApi::Response::FollowRedirects
- DeskApi::Response::ParseDates
- DeskApi::Response::ParseJson
- DeskApi::Response::RaiseError
Methods
- ::build_self_link — DeskApi::Resource
- ::client — DeskApi
- ::connection_options — DeskApi::Default
- ::consumer_key — DeskApi::Default
- ::consumer_secret — DeskApi::Default
- ::descendants — DeskApi::Error
- ::endpoint — DeskApi::Default
- ::error_message — DeskApi::Error
- ::errors — DeskApi::Error
- ::errors — DeskApi::Request::Retry
- ::from_response — DeskApi::Error
- ::included — DeskApi::Configuration
- ::inherited — DeskApi::Error
- ::keys — DeskApi::Configuration
- ::method_missing — DeskApi
- ::new — DeskApi::Client
- ::new — DeskApi::Error
- ::new — DeskApi::Error::FollowRedirectError
- ::new — DeskApi::RateLimit
- ::new — DeskApi::Request::OAuth
- ::new — DeskApi::Request::Retry
- ::new — DeskApi::Resource
- ::new — DeskApi::Response::RaiseError
- ::options — DeskApi::Default
- ::password — DeskApi::Default
- ::register_middleware — DeskApi::Configuration
- ::subdomain — DeskApi::Default
- ::token — DeskApi::Default
- ::token_secret — DeskApi::Default
- ::username — DeskApi::Default
- #all — DeskApi::Resource::Pagination
- #authorize_request — DeskApi::Configuration
- #backtrace — DeskApi::Error
- #basic_auth — DeskApi::Configuration
- #by_id — DeskApi::Resource::SCRUD
- #by_url — DeskApi::Client
- #calc — DeskApi::Request::Retry
- #call — DeskApi::Request::EncodeDates
- #call — DeskApi::Request::EncodeJson
- #call — DeskApi::Request::OAuth
- #call — DeskApi::Request::Retry
- #call — DeskApi::Response::FollowRedirects
- #clean_base_url — DeskApi::Resource::SCRUD
- #configure — DeskApi::Configuration
- #connection — DeskApi::Client
- #create — DeskApi::Resource::SCRUD
- #credentials? — DeskApi::Configuration
- #delete — DeskApi::Resource::SCRUD
- #download — DeskApi::Resource::Download
- #each_page — DeskApi::Resource::Pagination
- #embed — DeskApi::Resource::QueryParams
- #encode_dates — DeskApi::Request::EncodeDates
- #error_hash — DeskApi::Error
- #exception_matcher — DeskApi::Request::Retry
- #exec! — DeskApi::Resource
- #filter_links — DeskApi::Resource::SCRUD
- #filter_suppress_rules — DeskApi::Resource::SCRUD
- #filter_update_actions — DeskApi::Resource::SCRUD
- #find — DeskApi::Resource::SCRUD
- #get_embedded_resource — DeskApi::Resource
- #get_field_value — DeskApi::Resource
- #get_href — DeskApi::Resource
- #get_linked_resource — DeskApi::Resource
- #get_self — DeskApi::Resource
- #href — DeskApi::Resource
- #href= — DeskApi::Resource
- #interval — DeskApi::Request::Retry
- #is_embedded? — DeskApi::Resource
- #is_field? — DeskApi::Resource
- #is_link? — DeskApi::Resource
- #limit — DeskApi::RateLimit
- #load — DeskApi::Resource
- #load! — DeskApi::Resource
- #loaded? — DeskApi::Resource
- #method_missing — DeskApi::Client
- #method_missing — DeskApi::Resource
- #new_resource — DeskApi::Resource
- #next! — DeskApi::Resource
- #oauth — DeskApi::Request::OAuth
- #oauth — DeskApi::Configuration
- #on_complete — DeskApi::Response::ParseDates
- #on_complete — DeskApi::Response::ParseJson
- #on_complete — DeskApi::Response::RaiseError
- #options — DeskApi::Configuration
- #parse_dates — DeskApi::Response::ParseDates
- #perform — DeskApi::Response::FollowRedirects
- #query_params — DeskApi::Resource::QueryParams
- #query_params= — DeskApi::Resource::QueryParams
- #query_params_include? — DeskApi::Resource::QueryParams
- #reload! — DeskApi::Resource
- #remaining — DeskApi::RateLimit
- #request — DeskApi::Client
- #reset! — DeskApi::Resource
- #reset! — DeskApi::Configuration
- #reset_env — DeskApi::Response::FollowRedirects
- #reset_in — DeskApi::RateLimit
- #resource_type — DeskApi::Resource
- #respond_to? — DeskApi::Resource
- #retry_after — DeskApi::RateLimit
- #search — DeskApi::Resource::SCRUD
- #setup — DeskApi::Configuration
- #to_hash — DeskApi::Resource
- #update — DeskApi::Resource::SCRUD
- #validate_credentials! — DeskApi::Configuration
- #validate_endpoint! — DeskApi::Configuration