square_connect 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGES.md +5 -0
- data/CONTRIBUTING.md +5 -0
- data/LICENSE.txt +202 -0
- data/README.md +47 -0
- data/lib/square_connect.rb +88 -0
- data/lib/square_connect/api/customer_api.rb +354 -0
- data/lib/square_connect/api/customer_card_api.rb +163 -0
- data/lib/square_connect/api/location_api.rb +82 -0
- data/lib/square_connect/api/refund_api.rb +179 -0
- data/lib/square_connect/api/transaction_api.rb +387 -0
- data/lib/square_connect/api_client.rb +337 -0
- data/lib/square_connect/api_error.rb +31 -0
- data/lib/square_connect/configuration.rb +163 -0
- data/lib/square_connect/models/address.rb +288 -0
- data/lib/square_connect/models/capture_transaction_response.rb +160 -0
- data/lib/square_connect/models/card.rb +233 -0
- data/lib/square_connect/models/card_brand.rb +147 -0
- data/lib/square_connect/models/charge_request.rb +257 -0
- data/lib/square_connect/models/charge_response.rb +171 -0
- data/lib/square_connect/models/country.rb +147 -0
- data/lib/square_connect/models/create_customer_card_request.rb +180 -0
- data/lib/square_connect/models/create_customer_card_response.rb +171 -0
- data/lib/square_connect/models/create_customer_request.rb +246 -0
- data/lib/square_connect/models/create_customer_response.rb +171 -0
- data/lib/square_connect/models/create_refund_request.rb +191 -0
- data/lib/square_connect/models/create_refund_response.rb +171 -0
- data/lib/square_connect/models/currency.rb +147 -0
- data/lib/square_connect/models/customer.rb +292 -0
- data/lib/square_connect/models/delete_customer_card_response.rb +160 -0
- data/lib/square_connect/models/delete_customer_response.rb +160 -0
- data/lib/square_connect/models/error.rb +209 -0
- data/lib/square_connect/models/error_category.rb +147 -0
- data/lib/square_connect/models/error_code.rb +147 -0
- data/lib/square_connect/models/list_customers_request.rb +158 -0
- data/lib/square_connect/models/list_customers_response.rb +184 -0
- data/lib/square_connect/models/list_locations_response.rb +173 -0
- data/lib/square_connect/models/list_refunds_request.rb +200 -0
- data/lib/square_connect/models/list_refunds_response.rb +184 -0
- data/lib/square_connect/models/list_transactions_request.rb +200 -0
- data/lib/square_connect/models/list_transactions_response.rb +184 -0
- data/lib/square_connect/models/location.rb +204 -0
- data/lib/square_connect/models/location_capability.rb +147 -0
- data/lib/square_connect/models/money.rb +178 -0
- data/lib/square_connect/models/refund.rb +255 -0
- data/lib/square_connect/models/refund_status.rb +147 -0
- data/lib/square_connect/models/retrieve_customer_response.rb +171 -0
- data/lib/square_connect/models/retrieve_transaction_response.rb +171 -0
- data/lib/square_connect/models/sort_order.rb +147 -0
- data/lib/square_connect/models/tender.rb +277 -0
- data/lib/square_connect/models/tender_card_details.rb +198 -0
- data/lib/square_connect/models/tender_card_details_entry_method.rb +147 -0
- data/lib/square_connect/models/tender_card_details_status.rb +147 -0
- data/lib/square_connect/models/tender_cash_details.rb +169 -0
- data/lib/square_connect/models/tender_type.rb +147 -0
- data/lib/square_connect/models/transaction.rb +237 -0
- data/lib/square_connect/models/transaction_product.rb +147 -0
- data/lib/square_connect/models/update_customer_request.rb +246 -0
- data/lib/square_connect/models/update_customer_response.rb +171 -0
- data/lib/square_connect/models/void_transaction_response.rb +160 -0
- data/lib/square_connect/version.rb +13 -0
- data/square_connect.gemspec +32 -0
- metadata +286 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 2450e79746e4ced5399510f8792b30f0ecf3d7b7
|
4
|
+
data.tar.gz: e8b039a0ac5e579c7d80d64b4c75bf6561104087
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: dfeac07d26ac053117336bde427b97eb606314b38234765b6fb63bfd4b0782c751bbeee71777cb04d1223b365543984e44f087d1511ac1ec7ee936cc939e3fff
|
7
|
+
data.tar.gz: 34264b57627602750d85d1b3d278ba9741dbf7317792e910c6807a1dee9112b777367e965059e4d6c3da043881aabf11deb4236b307a50a0cf348d0896c0afc0
|
data/CHANGES.md
ADDED
data/CONTRIBUTING.md
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
Connect v2 SDKs
|
2
|
+
===============
|
3
|
+
|
4
|
+
This repository contains the released Ruby client SDK. Check out our other
|
5
|
+
repository for the specification and template files we used to generate this.
|
6
|
+
|
7
|
+
Usage
|
8
|
+
-----
|
9
|
+
|
10
|
+
### Ruby
|
11
|
+
|
12
|
+
The Ruby SDK is published as a gem. Simply run:
|
13
|
+
|
14
|
+
```
|
15
|
+
$ gem install square_connect
|
16
|
+
```
|
17
|
+
|
18
|
+
Or add this line to your Gemfile:
|
19
|
+
|
20
|
+
```
|
21
|
+
gem 'square_connect'
|
22
|
+
```
|
23
|
+
|
24
|
+
Contributing
|
25
|
+
------------
|
26
|
+
|
27
|
+
Send bug reports, feature requests, and code contributions to API specifications
|
28
|
+
repository, as this repository contains only the generated SDK code.
|
29
|
+
|
30
|
+
License
|
31
|
+
-------
|
32
|
+
|
33
|
+
```
|
34
|
+
Copyright 2016 Square, Inc.
|
35
|
+
|
36
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
37
|
+
you may not use this file except in compliance with the License.
|
38
|
+
You may obtain a copy of the License at
|
39
|
+
|
40
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
41
|
+
|
42
|
+
Unless required by applicable law or agreed to in writing, software
|
43
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
44
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
45
|
+
See the License for the specific language governing permissions and
|
46
|
+
limitations under the License.
|
47
|
+
```
|
@@ -0,0 +1,88 @@
|
|
1
|
+
=begin
|
2
|
+
Square Connect API
|
3
|
+
|
4
|
+
OpenAPI spec version: 2.0
|
5
|
+
|
6
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
7
|
+
|
8
|
+
|
9
|
+
=end
|
10
|
+
|
11
|
+
# Common files
|
12
|
+
require 'square_connect/api_client'
|
13
|
+
require 'square_connect/api_error'
|
14
|
+
require 'square_connect/version'
|
15
|
+
require 'square_connect/configuration'
|
16
|
+
|
17
|
+
# Models
|
18
|
+
require 'square_connect/models/card_brand'
|
19
|
+
require 'square_connect/models/country'
|
20
|
+
require 'square_connect/models/currency'
|
21
|
+
require 'square_connect/models/error_category'
|
22
|
+
require 'square_connect/models/error_code'
|
23
|
+
require 'square_connect/models/location_capability'
|
24
|
+
require 'square_connect/models/refund_status'
|
25
|
+
require 'square_connect/models/sort_order'
|
26
|
+
require 'square_connect/models/tender_card_details_entry_method'
|
27
|
+
require 'square_connect/models/tender_card_details_status'
|
28
|
+
require 'square_connect/models/tender_type'
|
29
|
+
require 'square_connect/models/transaction_product'
|
30
|
+
require 'square_connect/models/address'
|
31
|
+
require 'square_connect/models/capture_transaction_response'
|
32
|
+
require 'square_connect/models/card'
|
33
|
+
require 'square_connect/models/charge_request'
|
34
|
+
require 'square_connect/models/charge_response'
|
35
|
+
require 'square_connect/models/create_customer_card_request'
|
36
|
+
require 'square_connect/models/create_customer_card_response'
|
37
|
+
require 'square_connect/models/create_customer_request'
|
38
|
+
require 'square_connect/models/create_customer_response'
|
39
|
+
require 'square_connect/models/create_refund_request'
|
40
|
+
require 'square_connect/models/create_refund_response'
|
41
|
+
require 'square_connect/models/customer'
|
42
|
+
require 'square_connect/models/delete_customer_card_response'
|
43
|
+
require 'square_connect/models/delete_customer_response'
|
44
|
+
require 'square_connect/models/error'
|
45
|
+
require 'square_connect/models/list_customers_request'
|
46
|
+
require 'square_connect/models/list_customers_response'
|
47
|
+
require 'square_connect/models/list_locations_response'
|
48
|
+
require 'square_connect/models/list_refunds_request'
|
49
|
+
require 'square_connect/models/list_refunds_response'
|
50
|
+
require 'square_connect/models/list_transactions_request'
|
51
|
+
require 'square_connect/models/list_transactions_response'
|
52
|
+
require 'square_connect/models/location'
|
53
|
+
require 'square_connect/models/money'
|
54
|
+
require 'square_connect/models/refund'
|
55
|
+
require 'square_connect/models/retrieve_customer_response'
|
56
|
+
require 'square_connect/models/retrieve_transaction_response'
|
57
|
+
require 'square_connect/models/tender'
|
58
|
+
require 'square_connect/models/tender_card_details'
|
59
|
+
require 'square_connect/models/tender_cash_details'
|
60
|
+
require 'square_connect/models/transaction'
|
61
|
+
require 'square_connect/models/update_customer_request'
|
62
|
+
require 'square_connect/models/update_customer_response'
|
63
|
+
require 'square_connect/models/void_transaction_response'
|
64
|
+
|
65
|
+
# APIs
|
66
|
+
require 'square_connect/api/customer_card_api'
|
67
|
+
require 'square_connect/api/refund_api'
|
68
|
+
require 'square_connect/api/transaction_api'
|
69
|
+
require 'square_connect/api/customer_api'
|
70
|
+
require 'square_connect/api/location_api'
|
71
|
+
|
72
|
+
module SquareConnect
|
73
|
+
class << self
|
74
|
+
# Customize default settings for the SDK using block.
|
75
|
+
# SquareConnect.configure do |config|
|
76
|
+
# config.username = "xxx"
|
77
|
+
# config.password = "xxx"
|
78
|
+
# end
|
79
|
+
# If no block given, return the default Configuration object.
|
80
|
+
def configure
|
81
|
+
if block_given?
|
82
|
+
yield(Configuration.default)
|
83
|
+
else
|
84
|
+
Configuration.default
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
@@ -0,0 +1,354 @@
|
|
1
|
+
=begin
|
2
|
+
Square Connect API
|
3
|
+
|
4
|
+
OpenAPI spec version: 2.0
|
5
|
+
|
6
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
7
|
+
|
8
|
+
|
9
|
+
=end
|
10
|
+
|
11
|
+
require "uri"
|
12
|
+
|
13
|
+
module SquareConnect
|
14
|
+
class CustomerApi
|
15
|
+
attr_accessor :api_client
|
16
|
+
|
17
|
+
def initialize(api_client = ApiClient.default)
|
18
|
+
@api_client = api_client
|
19
|
+
end
|
20
|
+
|
21
|
+
# ListCustomers
|
22
|
+
# Lists a business's customers.
|
23
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [String] :cursor
|
26
|
+
# @return [ListCustomersResponse]
|
27
|
+
def list_customers(authorization, opts = {})
|
28
|
+
data, status_code, headers = list_customers_with_http_info(authorization, opts)
|
29
|
+
return data
|
30
|
+
end
|
31
|
+
|
32
|
+
# ListCustomers
|
33
|
+
# Lists a business's customers.
|
34
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @option opts [String] :cursor
|
37
|
+
# @return [Array<(ListCustomersResponse, Fixnum, Hash)>] ListCustomersResponse data, response status code and response headers
|
38
|
+
def list_customers_with_http_info(authorization, opts = {})
|
39
|
+
if @api_client.config.debugging
|
40
|
+
@api_client.config.logger.debug "Calling API: CustomerApi#list_customers ..."
|
41
|
+
end
|
42
|
+
|
43
|
+
# verify the required parameter 'authorization' is set
|
44
|
+
fail "Missing the required parameter 'authorization' when calling list_customers" if authorization.nil?
|
45
|
+
|
46
|
+
# resource path
|
47
|
+
path = "/v2/customers".sub('{format}','json')
|
48
|
+
|
49
|
+
# query parameters
|
50
|
+
query_params = {}
|
51
|
+
query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
|
52
|
+
|
53
|
+
# header parameters
|
54
|
+
header_params = {}
|
55
|
+
|
56
|
+
# HTTP header 'Accept' (if needed)
|
57
|
+
_header_accept = ['application/json']
|
58
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
59
|
+
|
60
|
+
# HTTP header 'Content-Type'
|
61
|
+
_header_content_type = ['application/json']
|
62
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
63
|
+
header_params[:'Authorization'] = authorization
|
64
|
+
|
65
|
+
# form parameters
|
66
|
+
form_params = {}
|
67
|
+
|
68
|
+
# http body (model)
|
69
|
+
post_body = nil
|
70
|
+
|
71
|
+
auth_names = []
|
72
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
73
|
+
:header_params => header_params,
|
74
|
+
:query_params => query_params,
|
75
|
+
:form_params => form_params,
|
76
|
+
:body => post_body,
|
77
|
+
:auth_names => auth_names,
|
78
|
+
:return_type => 'ListCustomersResponse')
|
79
|
+
if @api_client.config.debugging
|
80
|
+
@api_client.config.logger.debug "API called: CustomerApi#list_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
|
+
end
|
82
|
+
return data, status_code, headers
|
83
|
+
end
|
84
|
+
|
85
|
+
# CreateCustomer
|
86
|
+
# Creates a new customer for the business, which can have associated cards on file.
|
87
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
88
|
+
# @param body An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.
|
89
|
+
# @param [Hash] opts the optional parameters
|
90
|
+
# @return [CreateCustomerResponse]
|
91
|
+
def create_customer(authorization, body, opts = {})
|
92
|
+
data, status_code, headers = create_customer_with_http_info(authorization, body, opts)
|
93
|
+
return data
|
94
|
+
end
|
95
|
+
|
96
|
+
# CreateCustomer
|
97
|
+
# Creates a new customer for the business, which can have associated cards on file.
|
98
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
99
|
+
# @param body An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.
|
100
|
+
# @param [Hash] opts the optional parameters
|
101
|
+
# @return [Array<(CreateCustomerResponse, Fixnum, Hash)>] CreateCustomerResponse data, response status code and response headers
|
102
|
+
def create_customer_with_http_info(authorization, body, opts = {})
|
103
|
+
if @api_client.config.debugging
|
104
|
+
@api_client.config.logger.debug "Calling API: CustomerApi#create_customer ..."
|
105
|
+
end
|
106
|
+
|
107
|
+
# verify the required parameter 'authorization' is set
|
108
|
+
fail "Missing the required parameter 'authorization' when calling create_customer" if authorization.nil?
|
109
|
+
|
110
|
+
# verify the required parameter 'body' is set
|
111
|
+
fail "Missing the required parameter 'body' when calling create_customer" if body.nil?
|
112
|
+
|
113
|
+
# resource path
|
114
|
+
path = "/v2/customers".sub('{format}','json')
|
115
|
+
|
116
|
+
# query parameters
|
117
|
+
query_params = {}
|
118
|
+
|
119
|
+
# header parameters
|
120
|
+
header_params = {}
|
121
|
+
|
122
|
+
# HTTP header 'Accept' (if needed)
|
123
|
+
_header_accept = ['application/json']
|
124
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
125
|
+
|
126
|
+
# HTTP header 'Content-Type'
|
127
|
+
_header_content_type = ['application/json']
|
128
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
129
|
+
header_params[:'Authorization'] = authorization
|
130
|
+
|
131
|
+
# form parameters
|
132
|
+
form_params = {}
|
133
|
+
|
134
|
+
# http body (model)
|
135
|
+
post_body = @api_client.object_to_http_body(body)
|
136
|
+
|
137
|
+
auth_names = []
|
138
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
139
|
+
:header_params => header_params,
|
140
|
+
:query_params => query_params,
|
141
|
+
:form_params => form_params,
|
142
|
+
:body => post_body,
|
143
|
+
:auth_names => auth_names,
|
144
|
+
:return_type => 'CreateCustomerResponse')
|
145
|
+
if @api_client.config.debugging
|
146
|
+
@api_client.config.logger.debug "API called: CustomerApi#create_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
147
|
+
end
|
148
|
+
return data, status_code, headers
|
149
|
+
end
|
150
|
+
|
151
|
+
# RetrieveCustomer
|
152
|
+
# Returns details for a single customer.
|
153
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
154
|
+
# @param customer_id
|
155
|
+
# @param [Hash] opts the optional parameters
|
156
|
+
# @return [RetrieveCustomerResponse]
|
157
|
+
def retrieve_customer(authorization, customer_id, opts = {})
|
158
|
+
data, status_code, headers = retrieve_customer_with_http_info(authorization, customer_id, opts)
|
159
|
+
return data
|
160
|
+
end
|
161
|
+
|
162
|
+
# RetrieveCustomer
|
163
|
+
# Returns details for a single customer.
|
164
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
165
|
+
# @param customer_id
|
166
|
+
# @param [Hash] opts the optional parameters
|
167
|
+
# @return [Array<(RetrieveCustomerResponse, Fixnum, Hash)>] RetrieveCustomerResponse data, response status code and response headers
|
168
|
+
def retrieve_customer_with_http_info(authorization, customer_id, opts = {})
|
169
|
+
if @api_client.config.debugging
|
170
|
+
@api_client.config.logger.debug "Calling API: CustomerApi#retrieve_customer ..."
|
171
|
+
end
|
172
|
+
|
173
|
+
# verify the required parameter 'authorization' is set
|
174
|
+
fail "Missing the required parameter 'authorization' when calling retrieve_customer" if authorization.nil?
|
175
|
+
|
176
|
+
# verify the required parameter 'customer_id' is set
|
177
|
+
fail "Missing the required parameter 'customer_id' when calling retrieve_customer" if customer_id.nil?
|
178
|
+
|
179
|
+
# resource path
|
180
|
+
path = "/v2/customers/{customer_id}".sub('{format}','json').sub('{' + 'customer_id' + '}', customer_id.to_s)
|
181
|
+
|
182
|
+
# query parameters
|
183
|
+
query_params = {}
|
184
|
+
|
185
|
+
# header parameters
|
186
|
+
header_params = {}
|
187
|
+
|
188
|
+
# HTTP header 'Accept' (if needed)
|
189
|
+
_header_accept = ['application/json']
|
190
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
191
|
+
|
192
|
+
# HTTP header 'Content-Type'
|
193
|
+
_header_content_type = ['application/json']
|
194
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
195
|
+
header_params[:'Authorization'] = authorization
|
196
|
+
|
197
|
+
# form parameters
|
198
|
+
form_params = {}
|
199
|
+
|
200
|
+
# http body (model)
|
201
|
+
post_body = nil
|
202
|
+
|
203
|
+
auth_names = []
|
204
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
205
|
+
:header_params => header_params,
|
206
|
+
:query_params => query_params,
|
207
|
+
:form_params => form_params,
|
208
|
+
:body => post_body,
|
209
|
+
:auth_names => auth_names,
|
210
|
+
:return_type => 'RetrieveCustomerResponse')
|
211
|
+
if @api_client.config.debugging
|
212
|
+
@api_client.config.logger.debug "API called: CustomerApi#retrieve_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
213
|
+
end
|
214
|
+
return data, status_code, headers
|
215
|
+
end
|
216
|
+
|
217
|
+
# UpdateCustomer
|
218
|
+
# Updates the details of an existing customer.
|
219
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
220
|
+
# @param customer_id The customer to update.
|
221
|
+
# @param body An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.
|
222
|
+
# @param [Hash] opts the optional parameters
|
223
|
+
# @return [UpdateCustomerResponse]
|
224
|
+
def update_customer(authorization, customer_id, body, opts = {})
|
225
|
+
data, status_code, headers = update_customer_with_http_info(authorization, customer_id, body, opts)
|
226
|
+
return data
|
227
|
+
end
|
228
|
+
|
229
|
+
# UpdateCustomer
|
230
|
+
# Updates the details of an existing customer.
|
231
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
232
|
+
# @param customer_id The customer to update.
|
233
|
+
# @param body An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.
|
234
|
+
# @param [Hash] opts the optional parameters
|
235
|
+
# @return [Array<(UpdateCustomerResponse, Fixnum, Hash)>] UpdateCustomerResponse data, response status code and response headers
|
236
|
+
def update_customer_with_http_info(authorization, customer_id, body, opts = {})
|
237
|
+
if @api_client.config.debugging
|
238
|
+
@api_client.config.logger.debug "Calling API: CustomerApi#update_customer ..."
|
239
|
+
end
|
240
|
+
|
241
|
+
# verify the required parameter 'authorization' is set
|
242
|
+
fail "Missing the required parameter 'authorization' when calling update_customer" if authorization.nil?
|
243
|
+
|
244
|
+
# verify the required parameter 'customer_id' is set
|
245
|
+
fail "Missing the required parameter 'customer_id' when calling update_customer" if customer_id.nil?
|
246
|
+
|
247
|
+
# verify the required parameter 'body' is set
|
248
|
+
fail "Missing the required parameter 'body' when calling update_customer" if body.nil?
|
249
|
+
|
250
|
+
# resource path
|
251
|
+
path = "/v2/customers/{customer_id}".sub('{format}','json').sub('{' + 'customer_id' + '}', customer_id.to_s)
|
252
|
+
|
253
|
+
# query parameters
|
254
|
+
query_params = {}
|
255
|
+
|
256
|
+
# header parameters
|
257
|
+
header_params = {}
|
258
|
+
|
259
|
+
# HTTP header 'Accept' (if needed)
|
260
|
+
_header_accept = ['application/json']
|
261
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
262
|
+
|
263
|
+
# HTTP header 'Content-Type'
|
264
|
+
_header_content_type = ['application/json']
|
265
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
266
|
+
header_params[:'Authorization'] = authorization
|
267
|
+
|
268
|
+
# form parameters
|
269
|
+
form_params = {}
|
270
|
+
|
271
|
+
# http body (model)
|
272
|
+
post_body = @api_client.object_to_http_body(body)
|
273
|
+
|
274
|
+
auth_names = []
|
275
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
276
|
+
:header_params => header_params,
|
277
|
+
:query_params => query_params,
|
278
|
+
:form_params => form_params,
|
279
|
+
:body => post_body,
|
280
|
+
:auth_names => auth_names,
|
281
|
+
:return_type => 'UpdateCustomerResponse')
|
282
|
+
if @api_client.config.debugging
|
283
|
+
@api_client.config.logger.debug "API called: CustomerApi#update_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
284
|
+
end
|
285
|
+
return data, status_code, headers
|
286
|
+
end
|
287
|
+
|
288
|
+
# DeleteCustomer
|
289
|
+
# Deletes a customer from a business.
|
290
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
291
|
+
# @param customer_id
|
292
|
+
# @param [Hash] opts the optional parameters
|
293
|
+
# @return [DeleteCustomerResponse]
|
294
|
+
def delete_customer(authorization, customer_id, opts = {})
|
295
|
+
data, status_code, headers = delete_customer_with_http_info(authorization, customer_id, opts)
|
296
|
+
return data
|
297
|
+
end
|
298
|
+
|
299
|
+
# DeleteCustomer
|
300
|
+
# Deletes a customer from a business.
|
301
|
+
# @param authorization The value to provide in the Authorization header of\nyour request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
302
|
+
# @param customer_id
|
303
|
+
# @param [Hash] opts the optional parameters
|
304
|
+
# @return [Array<(DeleteCustomerResponse, Fixnum, Hash)>] DeleteCustomerResponse data, response status code and response headers
|
305
|
+
def delete_customer_with_http_info(authorization, customer_id, opts = {})
|
306
|
+
if @api_client.config.debugging
|
307
|
+
@api_client.config.logger.debug "Calling API: CustomerApi#delete_customer ..."
|
308
|
+
end
|
309
|
+
|
310
|
+
# verify the required parameter 'authorization' is set
|
311
|
+
fail "Missing the required parameter 'authorization' when calling delete_customer" if authorization.nil?
|
312
|
+
|
313
|
+
# verify the required parameter 'customer_id' is set
|
314
|
+
fail "Missing the required parameter 'customer_id' when calling delete_customer" if customer_id.nil?
|
315
|
+
|
316
|
+
# resource path
|
317
|
+
path = "/v2/customers/{customer_id}".sub('{format}','json').sub('{' + 'customer_id' + '}', customer_id.to_s)
|
318
|
+
|
319
|
+
# query parameters
|
320
|
+
query_params = {}
|
321
|
+
|
322
|
+
# header parameters
|
323
|
+
header_params = {}
|
324
|
+
|
325
|
+
# HTTP header 'Accept' (if needed)
|
326
|
+
_header_accept = ['application/json']
|
327
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
328
|
+
|
329
|
+
# HTTP header 'Content-Type'
|
330
|
+
_header_content_type = ['application/json']
|
331
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
332
|
+
header_params[:'Authorization'] = authorization
|
333
|
+
|
334
|
+
# form parameters
|
335
|
+
form_params = {}
|
336
|
+
|
337
|
+
# http body (model)
|
338
|
+
post_body = nil
|
339
|
+
|
340
|
+
auth_names = []
|
341
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
342
|
+
:header_params => header_params,
|
343
|
+
:query_params => query_params,
|
344
|
+
:form_params => form_params,
|
345
|
+
:body => post_body,
|
346
|
+
:auth_names => auth_names,
|
347
|
+
:return_type => 'DeleteCustomerResponse')
|
348
|
+
if @api_client.config.debugging
|
349
|
+
@api_client.config.logger.debug "API called: CustomerApi#delete_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
350
|
+
end
|
351
|
+
return data, status_code, headers
|
352
|
+
end
|
353
|
+
end
|
354
|
+
end
|