Class: Roistat::Client

Inherits:
Object
  • Object
show all
Defined in:
sig/roistat.rbs,
lib/roistat/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, project: nil, project_required: true, base_url: nil, timeout: nil, open_timeout: nil, binary_tempfile_threshold: nil) ⇒ Client

Returns a new instance of Client.



21
 
# File 'sig/roistat.rbs', line 21

def initialize: (

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



7
8
9
 
# File 'lib/roistat/client.rb', line 7

def api_key
  @api_key
end

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



7
8
9
 
# File 'lib/roistat/client.rb', line 7

def base_url
  @base_url
end

#binary_tempfile_threshold ⇒ Object (readonly)

Returns the value of attribute binary_tempfile_threshold.



7
8
9
 
# File 'lib/roistat/client.rb', line 7

def binary_tempfile_threshold
  @binary_tempfile_threshold
end

#open_timeout ⇒ Object (readonly)

Returns the value of attribute open_timeout.



7
8
9
 
# File 'lib/roistat/client.rb', line 7

def open_timeout
  @open_timeout
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



7
8
9
 
# File 'lib/roistat/client.rb', line 7

def project
  @project
end

#timeout ⇒ Object (readonly)

Returns the value of attribute timeout.



7
8
9
 
# File 'lib/roistat/client.rb', line 7

def timeout
  @timeout
end

Instance Method Details

#access ⇒ Roistat::Resources::Access

Returns:



37
 
# File 'sig/roistat.rbs', line 37

def access: () -> Roistat::Resources::Access

#analytics ⇒ Roistat::Resources::Analytics

Returns:



49
 
# File 'sig/roistat.rbs', line 49

def analytics: () -> Roistat::Resources::Analytics

#billing ⇒ Roistat::Resources::Billing

Returns:



40
 
# File 'sig/roistat.rbs', line 40

def billing: () -> Roistat::Resources::Billing

#calltracking ⇒ Roistat::Resources::Calltracking

Returns:



41
 
# File 'sig/roistat.rbs', line 41

def calltracking: () -> Roistat::Resources::Calltracking

#channels ⇒ Roistat::Resources::Channels

Returns:



50
 
# File 'sig/roistat.rbs', line 50

def channels: () -> Roistat::Resources::Channels

#clients ⇒ Roistat::Resources::Clients

Returns:



46
 
# File 'sig/roistat.rbs', line 46

def clients: () -> Roistat::Resources::Clients

#dashboards ⇒ Roistat::Resources::Dashboards

Returns:



38
 
# File 'sig/roistat.rbs', line 38

def dashboards: () -> Roistat::Resources::Dashboards

#emailtracking ⇒ Roistat::Resources::Emailtracking

Returns:



54
 
# File 'sig/roistat.rbs', line 54

def emailtracking: () -> Roistat::Resources::Emailtracking

#events ⇒ Roistat::Resources::Events

Returns:



48
 
# File 'sig/roistat.rbs', line 48

def events: () -> Roistat::Resources::Events

#get(path, params: {}, parse: :json) ⇒ Object

Parameters:

  • (String)
  • params: (Hash[Symbol | String, untyped]) (defaults to: {})
  • parse: (Symbol) (defaults to: :json)

Returns:

  • (Object) 


31
 
# File 'sig/roistat.rbs', line 31

def get: (String, ?params: Hash[Symbol | String, untyped], ?parse: Symbol) -> untyped

#indicators ⇒ Roistat::Resources::Indicators

Returns:



52
 
# File 'sig/roistat.rbs', line 52

def indicators: () -> Roistat::Resources::Indicators

#lead_hunter ⇒ Roistat::Resources::LeadHunter

Returns:



53
 
# File 'sig/roistat.rbs', line 53

def lead_hunter: () -> Roistat::Resources::LeadHunter

#leads ⇒ Roistat::Resources::Leads

Returns:



44
 
# File 'sig/roistat.rbs', line 44

def leads: () -> Roistat::Resources::Leads

#managers ⇒ Roistat::Resources::Managers

Returns:



45
 
# File 'sig/roistat.rbs', line 45

def managers: () -> Roistat::Resources::Managers

#mediaplan ⇒ Roistat::Resources::Mediaplan

Returns:



56
 
# File 'sig/roistat.rbs', line 56

def mediaplan: () -> Roistat::Resources::Mediaplan

#orders ⇒ Roistat::Resources::Orders

Returns:



42
 
# File 'sig/roistat.rbs', line 42

def orders: () -> Roistat::Resources::Orders

#post(path, params: {}, body: nil, parse: :json) ⇒ Object

Parameters:

  • (String)
  • params: (Hash[Symbol | String, untyped]) (defaults to: {})
  • body: (Object) (defaults to: nil)
  • parse: (Symbol) (defaults to: :json)

Returns:

  • (Object) 


32
 
# File 'sig/roistat.rbs', line 32

def post: (String, ?params: Hash[Symbol | String, untyped], ?body: untyped, ?parse: Symbol) -> untyped

#post_multipart(path, params: {}, form: {}, parse: :json) ⇒ Object

Parameters:

  • (String)
  • params: (Hash[Symbol | String, untyped]) (defaults to: {})
  • form: (Hash[Symbol | String, untyped]) (defaults to: {})
  • parse: (Symbol) (defaults to: :json)

Returns:

  • (Object) 


33
 
# File 'sig/roistat.rbs', line 33

def post_multipart: (String, ?params: Hash[Symbol | String, untyped], ?form: Hash[Symbol | String, untyped], ?parse: Symbol) -> untyped

#projects ⇒ Roistat::Resources::Projects

Returns:



36
 
# File 'sig/roistat.rbs', line 36

def projects: () -> Roistat::Resources::Projects

#proxy_leads ⇒ Roistat::Resources::ProxyLeads

Returns:



43
 
# File 'sig/roistat.rbs', line 43

def proxy_leads: () -> Roistat::Resources::ProxyLeads

#request(method, path, params: {}, body: nil, parse: :json) ⇒ Object

Parameters:

  • (Symbol, String)
  • (String)
  • params: (Hash[Symbol | String, untyped]) (defaults to: {})
  • body: (Object) (defaults to: nil)
  • parse: (Symbol) (defaults to: :json)

Returns:

  • (Object) 


34
 
# File 'sig/roistat.rbs', line 34

def request: (Symbol | String, String, ?params: Hash[Symbol | String, untyped], ?body: untyped, ?parse: Symbol) -> untyped

#sms ⇒ Roistat::Resources::Sms

Returns:



55
 
# File 'sig/roistat.rbs', line 55

def sms: () -> Roistat::Resources::Sms

#speech ⇒ Roistat::Resources::Speech

Returns:



57
 
# File 'sig/roistat.rbs', line 57

def speech: () -> Roistat::Resources::Speech

#statistics ⇒ Roistat::Resources::Statistics

Returns:



51
 
# File 'sig/roistat.rbs', line 51

def statistics: () -> Roistat::Resources::Statistics

#visits ⇒ Roistat::Resources::Visits

Returns:



47
 
# File 'sig/roistat.rbs', line 47

def visits: () -> Roistat::Resources::Visits

#vpbx ⇒ Roistat::Resources::Vpbx

Returns:



58
 
# File 'sig/roistat.rbs', line 58

def vpbx: () -> Roistat::Resources::Vpbx

#widgets ⇒ Roistat::Resources::Widgets

Returns:



39
 
# File 'sig/roistat.rbs', line 39

def widgets: () -> Roistat::Resources::Widgets