Module: Craigslist::API

Defined in:
lib/craigslist/api.rb,
lib/craigslist/api/area.rb,
lib/craigslist/api/image.rb,
lib/craigslist/api/money.rb,
lib/craigslist/api/client.rb,
lib/craigslist/api/errors.rb,
lib/craigslist/api/result.rb,
lib/craigslist/api/posting.rb,
lib/craigslist/api/version.rb,
lib/craigslist/api/category.rb,
lib/craigslist/api/envelope.rb,
lib/craigslist/api/reference.rb,
lib/craigslist/api/connection.rb,
lib/craigslist/api/image_info.rb,
lib/craigslist/api/result_set.rb,
lib/craigslist/api/serializer.rb,
lib/craigslist/api/access_token.rb,
lib/craigslist/api/zip_location.rb,
lib/craigslist/api/configuration.rb,
lib/craigslist/api/posting_block.rb,
lib/craigslist/api/posting_stats.rb,
lib/craigslist/api/bulk_transport.rb,
lib/craigslist/api/credit_summary.rb,
lib/craigslist/api/json_transport.rb,
lib/craigslist/api/posting_handle.rb,
lib/craigslist/api/resources/base.rb,
lib/craigslist/api/token_provider.rb,
lib/craigslist/api/response_parser.rb,
lib/craigslist/api/resources/images.rb,
lib/craigslist/api/resources/account.rb,
lib/craigslist/api/resources/billing.rb,
lib/craigslist/api/resources/postings.rb

Overview

Ruby client for the Craigslist bulk posting platform.

Access to bulk posting is granted by Craigslist on a case-by-case basis to high-volume posters, and is limited to paid US categories: jobs (offered), apartment rentals in NYC, and for-sale-by-dealer.

Defined Under Namespace

Modules: Connection, Resources Classes: APIError, AccessToken, Area, AuthenticationError, BulkTransport, Category, Client, Configuration, ConfigurationError, ConnectionError, CreditSummary, Envelope, Error, Image, ImageInfo, JsonTransport, Money, NotFoundError, ParseError, Posting, PostingBlock, PostingHandle, PostingStats, RateLimitError, Reference, RequestError, ResponseError, ResponseParser, Result, ResultSet, Serializer, ServerError, TimeoutError, TokenProvider, ValidationError, ZipLocation

Constant Summary collapse

VERSION =

Current gem version.

"0.1.0"

Class Method Summary collapse

Class Method Details

.newClient

Convenience constructor.

client = Craigslist::API.new(email: ..., password: ..., account_id: ...)


59
60
61
# File 'lib/craigslist/api.rb', line 59

def self.new(...)
  Client.new(...)
end