Module: Sendle::Api

Defined in:
lib/sendle/api.rb,
lib/sendle/api/utils.rb,
lib/sendle/api/version.rb,
lib/sendle/api/constants.rb,
lib/sendle/api/sugars/show.rb,
lib/sendle/api/actions/base.rb,
lib/sendle/api/actions/show.rb,
lib/sendle/api/sugars/index.rb,
lib/sendle/api/actions/index.rb,
lib/sendle/api/sugars/create.rb,
lib/sendle/api/actions/create.rb,
lib/sendle/api/responses/json.rb,
lib/sendle/api/responses/pong.rb,
lib/sendle/api/sugars/destroy.rb,
lib/sendle/api/actions/destroy.rb,
lib/sendle/api/factories/errors.rb,
lib/sendle/api/errors/invalid_plan.rb,
lib/sendle/api/errors/unauthorized.rb,
lib/sendle/api/errors/missing_params.rb,
lib/sendle/api/errors/missing_api_key.rb,
lib/sendle/api/errors/payment_required.rb,
lib/sendle/api/errors/missing_sendle_id.rb,
lib/sendle/api/errors/precondition_failed.rb,
lib/sendle/api/errors/unprocessable_entity.rb

Defined Under Namespace

Modules: Actions, Errors, Factories, Responses, Sugars Classes: Order, Ping, Quote, Resource, Utils

Constant Summary collapse

VERSION =
"0.0.13"
PLAN_EASY =
'Easy'
PLAN_PREMIUM =
'Premium'
PLAN_PRO =
'Pro'
PLANS =
[ PLAN_EASY, PLAN_PREMIUM, PLAN_PRO ]
ORDER_STATUS_PAYMENT =
'Payment'
ORDER_STATUS_PICKUP =
'Pickup'
ORDER_STATUS_IN_TRANSIT =
'In Transit'
ORDER_STATUS_DELIVERED =
'Delivered'
ORDER_STATUS_CANCELLED =
'Cancelled'
ORDER_STATUSES =
[ ORDER_STATUS_PAYMENT,
 ORDER_STATUS_PICKUP,
 ORDER_STATUS_IN_TRANSIT,
 ORDER_STATUS_DELIVERED,
 ORDER_STATUS_CANCELLED 
]

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_keyObject

Returns the value of attribute api_key.



54
55
56
# File 'lib/sendle/api.rb', line 54

def api_key
  @api_key
end

.sandboxObject

Returns the value of attribute sandbox.



54
55
56
# File 'lib/sendle/api.rb', line 54

def sandbox
  @sandbox
end

.sendle_idObject

Returns the value of attribute sendle_id.



54
55
56
# File 'lib/sendle/api.rb', line 54

def sendle_id
  @sendle_id
end

Class Method Details

.base_urlObject



56
57
58
# File 'lib/sendle/api.rb', line 56

def base_url
  sandbox ? "https://sandbox.sendle.com/api/" : "https://www.sendle.com/api/"
end