Class: ChartMogul::Customer

Inherits:
APIResource show all
Includes:
API::Actions::Create, API::Actions::Custom, API::Actions::Destroy, API::Actions::Retrieve, API::Actions::Update
Defined in:
lib/chartmogul/customer.rb

Constant Summary

Constants inherited from APIResource

APIResource::BACKOFF_FACTOR, APIResource::INTERVAL, APIResource::INTERVAL_RANDOMNESS, APIResource::MAX_INTERVAL, APIResource::RETRY_EXCEPTIONS, APIResource::RETRY_STATUSES, APIResource::THREAD_CONNECTION_KEY

Class Method Summary collapse

Instance Method Summary collapse

Methods included from API::Actions::Update

included, #update!

Methods included from API::Actions::Retrieve

included

Methods included from API::Actions::Destroy

#destroy!, included

Methods included from API::Actions::Custom

#custom!, #custom_without_assign!, included

Methods included from API::Actions::Create

#create!, included

Methods inherited from APIResource

connection, handle_other_error, handle_request_error, handling_errors, immutable_keys, set_immutable_keys, set_resource_name, set_resource_path, set_resource_root_key

Methods inherited from Object

#allowed_for_write?, #assign_all_attributes, #assign_writeable_attributes, attributes, define_private_writer, define_reader, define_writer, #initialize, #instance_attributes, new_from_json, readonly_attr, #serialize_for_write, #serialized_value_for_attr, writeable_attr, writeable_attributes

Constructor Details

This class inherits a constructor from ChartMogul::Object

Class Method Details

.all(options = {}) ⇒ Object 



46
47
48
 
# File 'lib/chartmogul/customer.rb', line 46

def self.all(options = {})
  Customers.all(options)
end

.find_by_external_id(external_id) ⇒ Object 



54
55
56
 
# File 'lib/chartmogul/customer.rb', line 54

def self.find_by_external_id(external_id)
  all(external_id: external_id).first
end

.merge!(into_uuid:, from_uuid:) ⇒ Object 



58
59
60
61
62
63
64
65
 
# File 'lib/chartmogul/customer.rb', line 58

def self.merge!(into_uuid:, from_uuid:)
  options = {
    from: { customer_uuid: from_uuid },
    into: { customer_uuid: into_uuid }
  }
  custom!(:post, '/v1/customers/merges', options)
  true
end

.search(email, options = {}) ⇒ Object 



50
51
52
 
# File 'lib/chartmogul/customer.rb', line 50

def self.search(email, options = {})
  Customers.search(email, options)
end

Instance Method Details

#add_custom_attributes!(*custom_attrs) ⇒ Object 



116
117
118
119
120
 
# File 'lib/chartmogul/customer.rb', line 116

def add_custom_attributes!(*custom_attrs)
  self.custom_attributes = custom_without_assign!(:post,
                                                  "/v1/customers/#{uuid}/attributes/custom",
                                                  custom: custom_attrs)[:custom]
end

#add_tags!(*tags) ⇒ Object 



104
105
106
107
108
 
# File 'lib/chartmogul/customer.rb', line 104

def add_tags!(*tags)
  self.tags = custom_without_assign!(:post,
                                     "/v1/customers/#{uuid}/attributes/tags",
                                     tags: tags)[:tags]
end

#contacts(options = {}) ⇒ Object 



79
80
81
 
# File 'lib/chartmogul/customer.rb', line 79

def contacts(options = {})
  Contacts.all(options.merge(customer_uuid: uuid))
end

#create_contact(options = {}) ⇒ Object 



83
84
85
 
# File 'lib/chartmogul/customer.rb', line 83

def create_contact(options = {})
  Contact.create!(options.merge(customer_uuid: uuid))
end

#create_note(options = {}) ⇒ Object 



91
92
93
 
# File 'lib/chartmogul/customer.rb', line 91

def create_note(options = {})
  Note.create!(options.merge(customer_uuid: uuid))
end

#custom_attributes ⇒ Object 



100
101
102
 
# File 'lib/chartmogul/customer.rb', line 100

def custom_attributes
  @attributes[:custom]
end

#invoices(options = {}) ⇒ Object 



71
72
73
 
# File 'lib/chartmogul/customer.rb', line 71

def invoices(options = {})
  @invoices ||= ChartMogul::CustomerInvoices.all(uuid, options)
end

#invoices=(invoices_array) ⇒ Object 



75
76
77
 
# File 'lib/chartmogul/customer.rb', line 75

def invoices=(invoices_array)
  @invoices = ChartMogul::CustomerInvoices.new(customer_uuid: uuid, invoices: invoices_array)
end

#merge_into!(other_customer) ⇒ Object 



134
135
136
137
138
139
140
141
 
# File 'lib/chartmogul/customer.rb', line 134

def merge_into!(other_customer)
  options = {
    from: { customer_uuid: uuid },
    into: { customer_uuid: other_customer.uuid }
  }
  custom!(:post, '/v1/customers/merges', options)
  true
end

#notes(options = {}) ⇒ Object 



87
88
89
 
# File 'lib/chartmogul/customer.rb', line 87

def notes(options = {})
  Notes.all(options.merge(customer_uuid: uuid))
end

#remove_custom_attributes!(*custom_attrs) ⇒ Object 



128
129
130
131
132
 
# File 'lib/chartmogul/customer.rb', line 128

def remove_custom_attributes!(*custom_attrs)
  self.custom_attributes = custom_without_assign!(:delete,
                                                  "/v1/customers/#{uuid}/attributes/custom",
                                                  custom: custom_attrs)
end

#remove_tags!(*tags) ⇒ Object 



110
111
112
113
114
 
# File 'lib/chartmogul/customer.rb', line 110

def remove_tags!(*tags)
  self.tags = custom_without_assign!(:delete,
                                     "/v1/customers/#{uuid}/attributes/tags",
                                     tags: tags)[:tags]
end

#subscriptions(options = {}) ⇒ Object 



67
68
69
 
# File 'lib/chartmogul/customer.rb', line 67

def subscriptions(options = {})
  @subscriptions ||= ChartMogul::Subscription.all(uuid, options)
end

#tags ⇒ Object

Enrichment



96
97
98
 
# File 'lib/chartmogul/customer.rb', line 96

def tags
  @attributes[:tags]
end

#update_custom_attributes!(custom_attrs = {}) ⇒ Object 



122
123
124
125
126
 
# File 'lib/chartmogul/customer.rb', line 122

def update_custom_attributes!(custom_attrs = {})
  self.custom_attributes = custom_without_assign!(:put,
                                                  "/v1/customers/#{uuid}/attributes/custom",
                                                  custom: custom_attrs)[:custom]
end