Class: Square::Customers::Groups::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/square/customers/groups/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Square::Customers::Groups::Client 



8
9
10
 
# File 'lib/square/customers/groups/client.rb', line 8

def initialize(client:)
  @client = client
end

Instance Method Details

#add(request_options: {}, **params) ⇒ Square::Types::AddGroupToCustomerResponse

Adds a group membership to a customer.

The customer is identified by the ‘customer_id` value and the customer group is identified by the `group_id` value.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/square/customers/groups/client.rb', line 114

def add(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "PUT",
    path: "v2/customers/#{params[:customer_id]}/groups/#{params[:group_id]}"
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::AddGroupToCustomerResponse.load(_response.body)
  end

  raise _response.body
end

#create(request_options: {}, **params) ⇒ Square::Types::CreateCustomerGroupResponse

Creates a new customer group for a business.

The request must include the ‘name` value of the group.

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/square/customers/groups/client.rb', line 39

def create(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "POST",
    path: "v2/customers/groups",
    body: params
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::CreateCustomerGroupResponse.load(_response.body)
  end

  raise _response.body
end

#delete(request_options: {}, **params) ⇒ Square::Types::DeleteCustomerGroupResponse

Deletes a customer group as identified by the ‘group_id` value.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/square/customers/groups/client.rb', line 94

def delete(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "DELETE",
    path: "v2/customers/groups/#{params[:group_id]}"
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::DeleteCustomerGroupResponse.load(_response.body)
  end

  raise _response.body
end

#get(request_options: {}, **params) ⇒ Square::Types::GetCustomerGroupResponse

Retrieves a specific customer group as identified by the ‘group_id` value.

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/square/customers/groups/client.rb', line 57

def get(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "GET",
    path: "v2/customers/groups/#{params[:group_id]}"
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::GetCustomerGroupResponse.load(_response.body)
  end

  raise _response.body
end

#list(request_options: {}, **params) ⇒ Square::Types::ListCustomerGroupsResponse

Retrieves the list of customer groups of a business.

Returns:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/square/customers/groups/client.rb', line 15

def list(request_options: {}, **params)
  _query_param_names = %w[cursor limit]
  _query = params.slice(*_query_param_names)
  params.except(*_query_param_names)

  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "GET",
    path: "v2/customers/groups",
    query: _query
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::ListCustomerGroupsResponse.load(_response.body)
  end

  raise _response.body
end

#remove(request_options: {}, **params) ⇒ Square::Types::RemoveGroupFromCustomerResponse

Removes a group membership from a customer.

The customer is identified by the ‘customer_id` value and the customer group is identified by the `group_id` value.

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/square/customers/groups/client.rb', line 134

def remove(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "DELETE",
    path: "v2/customers/#{params[:customer_id]}/groups/#{params[:group_id]}"
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::RemoveGroupFromCustomerResponse.load(_response.body)
  end

  raise _response.body
end

#update(request_options: {}, **params) ⇒ Square::Types::UpdateCustomerGroupResponse

Updates a customer group as identified by the ‘group_id` value.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/square/customers/groups/client.rb', line 74

def update(request_options: {}, **params)
  _path_param_names = ["group_id"]

  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "PUT",
    path: "v2/customers/groups/#{params[:group_id]}",
    body: params.except(*_path_param_names)
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::UpdateCustomerGroupResponse.load(_response.body)
  end

  raise _response.body
end