Class: TrueTrial::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/truetrial/client.rb

Overview

Main entry point for interacting with the TrueTrial API.

Examples:

client = TrueTrial::Client.new(api_key: "tt_live_abc123")
client.orders.list

Constant Summary collapse

DEFAULT_BASE_URL = 
"https://truetrial.test/api/v1"

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, base_url: DEFAULT_BASE_URL) ⇒ Client

Returns a new instance of Client.

Parameters:

  • api_key (String) —

    your TrueTrial API key

  • base_url (String) (defaults to: DEFAULT_BASE_URL) —

    API base URL (defaults to production)



14
15
16
 
# File 'lib/truetrial/client.rb', line 14

def initialize(api_key:, base_url: DEFAULT_BASE_URL)
  @http_client = HttpClient.new(api_key: api_key, base_url: base_url)
end

Instance Method Details

#cancellations ⇒ TrueTrial::Resources::Cancellations

Returns:



39
40
41
 
# File 'lib/truetrial/client.rb', line 39

def cancellations
  @cancellations ||= Resources::Cancellations.new(@http_client)
end

#digital_delivery ⇒ TrueTrial::Resources::DigitalDelivery

Returns:



29
30
31
 
# File 'lib/truetrial/client.rb', line 29

def digital_delivery
  @digital_delivery ||= Resources::DigitalDelivery.new(@http_client)
end

#orders ⇒ TrueTrial::Resources::Orders

Returns:



19
20
21
 
# File 'lib/truetrial/client.rb', line 19

def orders
  @orders ||= Resources::Orders.new(@http_client)
end

#shipments ⇒ TrueTrial::Resources::Shipments

Returns:



24
25
26
 
# File 'lib/truetrial/client.rb', line 24

def shipments
  @shipments ||= Resources::Shipments.new(@http_client)
end

#system ⇒ TrueTrial::Resources::System

Returns:



49
50
51
 
# File 'lib/truetrial/client.rb', line 49

def system
  @system ||= Resources::System.new(@http_client)
end

#temporal ⇒ TrueTrial::Resources::Temporal

Returns:



34
35
36
 
# File 'lib/truetrial/client.rb', line 34

def temporal
  @temporal ||= Resources::Temporal.new(@http_client)
end

#webhooks ⇒ TrueTrial::Resources::Webhooks

Returns:



44
45
46
 
# File 'lib/truetrial/client.rb', line 44

def webhooks
  @webhooks ||= Resources::Webhooks.new(@http_client)
end