Class: MetrifoxSDK::Customers::Module

Inherits:
BaseModule
  • Object
show all
Defined in:
lib/metrifox_sdk/customers/module.rb

Instance Attribute Summary

Attributes inherited from BaseModule

#client

Instance Method Summary collapse

Methods inherited from BaseModule

#initialize

Constructor Details

This class inherits a constructor from MetrifoxSDK::BaseModule

Instance Method Details

#archive(customer_key) ⇒ Object 



47
48
49
50
 
# File 'lib/metrifox_sdk/customers/module.rb', line 47

def archive(customer_key)
  validate_api_key!
  api.customer_archive_request(base_url, api_key, customer_key)
end

#bulk_create(request_payload) ⇒ Object 



67
68
69
70
 
# File 'lib/metrifox_sdk/customers/module.rb', line 67

def bulk_create(request_payload)
  validate_api_key!
  api.bulk_create_request(base_url, api_key, request_payload)
end

#create(request_payload) ⇒ Object 



7
8
9
10
 
# File 'lib/metrifox_sdk/customers/module.rb', line 7

def create(request_payload)
  validate_api_key!
  api.customer_create_request(base_url, api_key, request_payload)
end

#delete(request_payload) ⇒ Object 



43
44
45
 
# File 'lib/metrifox_sdk/customers/module.rb', line 43

def delete(request_payload)
  delete_customer(request_payload)
end

#delete_customer(request_payload) ⇒ Object 



38
39
40
41
 
# File 'lib/metrifox_sdk/customers/module.rb', line 38

def delete_customer(request_payload)
  validate_api_key!
  api.customer_delete_request(base_url, api_key, request_payload)
end

#get(request_payload) ⇒ Object 



22
23
24
 
# File 'lib/metrifox_sdk/customers/module.rb', line 22

def get(request_payload)
  get_customer(request_payload)
end

#get_customer(request_payload) ⇒ Object 



17
18
19
20
 
# File 'lib/metrifox_sdk/customers/module.rb', line 17

def get_customer(request_payload)
  validate_api_key!
  api.customer_get_request(base_url, api_key, request_payload)
end

#get_details(request_payload) ⇒ Object 



26
27
28
29
 
# File 'lib/metrifox_sdk/customers/module.rb', line 26

def get_details(request_payload)
  validate_api_key!
  api.customer_details_get_request(base_url, api_key, request_payload)
end

#has_active_subscription?(customer_key:) ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
34
35
36
 
# File 'lib/metrifox_sdk/customers/module.rb', line 31

def has_active_subscription?(customer_key:)
  validate_api_key!
  result = api.customer_active_subscription_request(base_url, api_key, customer_key)
  data = result["data"] || {}
  data["has_active_subscription"]
end

#list(request_payload = {}) ⇒ Object 



57
58
59
60
 
# File 'lib/metrifox_sdk/customers/module.rb', line 57

def list(request_payload = {})
  validate_api_key!
  api.customer_list_request(base_url, api_key, request_payload)
end

#unarchive(customer_key) ⇒ Object 



52
53
54
55
 
# File 'lib/metrifox_sdk/customers/module.rb', line 52

def unarchive(customer_key)
  validate_api_key!
  api.customer_unarchive_request(base_url, api_key, customer_key)
end

#update(customer_key, request_payload) ⇒ Object 



12
13
14
15
 
# File 'lib/metrifox_sdk/customers/module.rb', line 12

def update(customer_key, request_payload)
  validate_api_key!
  api.customer_update_request(base_url, api_key, customer_key, request_payload)
end

#upload_csv(file_path) ⇒ Object 



62
63
64
65
 
# File 'lib/metrifox_sdk/customers/module.rb', line 62

def upload_csv(file_path)
  validate_api_key!
  api.upload_customers_csv(base_url, api_key, file_path)
end