Class: Tpaga::CustomerApi

Inherits:
Object show all
Defined in:
lib/tpaga/api/customer_api.rb

Class Method Summary collapse

Class Method Details

.create_customer(body, opts = {}) ⇒ Customer

Add a new Customer to the Merchant Creates a new ‘Customer` associated to the Merchant. There are no mandatory parameters to create the `Customer`, but filling all the fields is highly recomended.

Parameters:

  • body —

    Customer object to be added to the Merchant, it has the following fieldsn- id its the id of the ‘Customer` thats going to be generated after creation.n- firstName which is the `Customer`'s first name.n- lastName which is the `Customer`'s last name.n- gender of the `Customer` which can be Male (M), Female (F) or Not Available (N/A)n- address which is the `Customer`'s home address.n- email which is the `Customer`'s e-mail address with proper formatting ( i. e. [email protected])n- phone which is the `Customer`'s phone number

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/tpaga/api/customer_api.rb', line 13

def self.create_customer(body, opts = {})

  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling create_customer" if body.nil?


  # resource path
  path = "/customer".sub('{format}', 'json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(body)


  auth_names = ['api_key']
  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = Customer.new() and obj.build_from_hash(response)
end

.delete_customer_by_id(id, opts = {}) ⇒ nil

Deletes a Customer by ID Deletes a ‘Customer` when its `id` matches the parameter. Only available when `Customer` does not have associated payment methods.

Parameters:

  • id —

    Identification of customer to be deleted

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/tpaga/api/customer_api.rb', line 93

def self.delete_customer_by_id(id, opts = {})

  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling delete_customer_by_id" if id.nil?


  # resource path
  path = "/customer/{id}".sub('{format}', 'json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  Swagger::Request.new(:DELETE, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
  nil
end

.get_customer_by_id(id, opts = {}) ⇒ Customer

Retrieve a Customer by ID Get the details of an existing ‘Customer`. This method only requires an unique `Customer` identifier `id` that was returned upon `Customer` creation.

Parameters:

  • id —

    Identification of ‘Customer` to be retrieved

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/tpaga/api/customer_api.rb', line 53

def self.get_customer_by_id(id, opts = {})

  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling get_customer_by_id" if id.nil?


  # resource path
  path = "/customer/{id}".sub('{format}', 'json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = Customer.new() and obj.build_from_hash(response)
end