Class: Nimbu::Endpoints::Customers

Inherits:
Nimbu::Endpoint show all
Defined in:
lib/nimbu-api/endpoints/customers.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

Connection::ALLOWED_OPTIONS

Instance Attribute Summary

Attributes inherited from Nimbu::Endpoint

#current_options

Attributes included from Authentication

#scopes

Instance Method Summary collapse

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 



25
26
27
28
29
 
# File 'lib/nimbu-api/endpoints/customers.rb', line 25

def count(*args)
  arguments(args)

  get_request("/customers/count", arguments.params)
end

#create(*args) ⇒ Object 



38
39
40
41
42
 
# File 'lib/nimbu-api/endpoints/customers.rb', line 38

def create(*args)
  arguments(args)

  post_request("/customers", arguments.params)
end

#customizations(*args) ⇒ Object Also known as: fields, custom_fields 



15
16
17
18
19
20
21
 
# File 'lib/nimbu-api/endpoints/customers.rb', line 15

def customizations(*args)
  arguments(args)

  response = get_request("/products/customizations", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

#delete(*args) ⇒ Object Also known as: remove 



51
52
53
54
55
 
# File 'lib/nimbu-api/endpoints/customers.rb', line 51

def delete(*args)
  arguments(args, :required => [:customer_id])

  delete_request("/customers/#{customer_id}", arguments.params)
end

#get(*args) ⇒ Object Also known as: find 



31
32
33
34
35
 
# File 'lib/nimbu-api/endpoints/customers.rb', line 31

def get(*args)
  arguments(args, :required => [:customer_id])

  get_request("/customers/#{customer_id}", arguments.params)
end

#list(*args) ⇒ Object Also known as: all 



6
7
8
9
10
11
12
 
# File 'lib/nimbu-api/endpoints/customers.rb', line 6

def list(*args)
  arguments(args)

  response = get_request("/customers", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

#update(*args) ⇒ Object Also known as: edit 



44
45
46
47
48
 
# File 'lib/nimbu-api/endpoints/customers.rb', line 44

def update(*args)
  arguments(args, :required => [:customer_id])

  patch_request("/customers/#{customer_id}", arguments.params)
end