Module: CDEKApiClient

Defined in:
lib/cdek_api_client.rb,
lib/cdek_api_client/client.rb,
lib/cdek_api_client/version.rb,
lib/cdek_api_client/api/order.rb,
lib/cdek_api_client/api/tariff.rb,
lib/cdek_api_client/api/webhook.rb,
lib/cdek_api_client/api/location.rb,
lib/cdek_api_client/entities/item.rb,
lib/cdek_api_client/api/track_order.rb,
lib/cdek_api_client/entities/sender.rb,
lib/cdek_api_client/entities/package.rb,
lib/cdek_api_client/entities/payment.rb,
lib/cdek_api_client/entities/service.rb,
lib/cdek_api_client/entities/webhook.rb,
lib/cdek_api_client/entities/location.rb,
lib/cdek_api_client/entities/recipient.rb,
lib/cdek_api_client/entities/order_data.rb,
lib/cdek_api_client/entities/tariff_data.rb,
lib/cdek_api_client/entities/validatable.rb,
lib/cdek_api_client/entities/currency_mapper.rb

Overview

Validatable module provides validation capabilities for entities.

Defined Under Namespace

Modules: API, Entities Classes: Client, Error

Constant Summary collapse

VERSION = 
'0.2.1'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.client_id ⇒ String

Returns The client ID for authentication.

Returns:

  • (String) —

    The client ID for authentication.



53
54
55
 
# File 'lib/cdek_api_client.rb', line 53

def client_id
  @client_id
end

.client_secret ⇒ String

Returns The client secret for authentication.

Returns:

  • (String) —

    The client secret for authentication.



57
58
59
 
# File 'lib/cdek_api_client.rb', line 57

def client_secret
  @client_secret
end

Class Method Details

.client ⇒ CDEKApiClient::Client

Returns the CDEK API client.

Returns:



62
63
64
 
# File 'lib/cdek_api_client.rb', line 62

def self.client
  @client ||= CDEKApiClient::Client.new(client_id, client_secret)
end

.configure {|self| ... } ⇒ Object

Configures the client with the provided block.

Yields:

  • (self) —

    Yields the client to the provided block.



47
48
49
 
# File 'lib/cdek_api_client.rb', line 47

def configure
  yield self
end