Module: CDEKApiClient

Defined in:
lib/cdek_api_client.rb,
lib/cdek_api_client/client.rb,
lib/cdek_api_client/config.rb,
lib/cdek_api_client/version.rb,
lib/cdek_api_client/api/order.rb,
lib/cdek_api_client/api/print.rb,
lib/cdek_api_client/api/tariff.rb,
lib/cdek_api_client/api/courier.rb,
lib/cdek_api_client/api/payment.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/entities/check.rb,
lib/cdek_api_client/api/track_order.rb,
lib/cdek_api_client/entities/sender.rb,
lib/cdek_api_client/entities/barcode.rb,
lib/cdek_api_client/entities/intakes.rb,
lib/cdek_api_client/entities/invoice.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/agreement.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/auth_response.rb,
lib/cdek_api_client/entities/currency_mapper.rb,
lib/cdek_api_client/entities/auth_error_response.rb,
lib/cdek_api_client/entities/intake_available_days_request.rb,
lib/cdek_api_client/entities/intake_available_days_response.rb

Overview

Validatable module provides validation capabilities for entities.

Defined Under Namespace

Modules: API, Config, Entities Classes: Client, Error

Constant Summary collapse

VERSION = 
'0.3.0'

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.



65
66
67
 
# File 'lib/cdek_api_client.rb', line 65

def client_id
  @client_id
end

.client_secret ⇒ String

Returns The client secret for authentication.

Returns:

  • (String) —

    The client secret for authentication.



69
70
71
 
# File 'lib/cdek_api_client.rb', line 69

def client_secret
  @client_secret
end

Class Method Details

.client ⇒ CDEKApiClient::Client

Returns the CDEK API client.

Returns:



74
75
76
 
# File 'lib/cdek_api_client.rb', line 74

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.



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

def configure
  yield self
end