paypal-sdk-adaptivepayments 1.96.0
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +17 -0
- data/README.md +163 -0
- data/Rakefile +14 -0
- data/lib/paypal-sdk/adaptive_payments/api.rb +21 -0
- data/lib/paypal-sdk/adaptive_payments/data_types.rb +998 -0
- data/lib/paypal-sdk/adaptive_payments/services.rb +325 -0
- data/lib/paypal-sdk/adaptive_payments/version.rb +7 -0
- data/lib/paypal-sdk/adaptive_payments.rb +16 -0
- data/lib/paypal-sdk-adaptivepayments.rb +2 -0
- data/spec/adaptive_payments_spec.rb +27 -0
- data/spec/config/cert_key.pem +33 -0
- data/spec/config/paypal.yml +25 -0
- data/spec/convert_currency_spec.rb +39 -0
- data/spec/spec_helper.rb +6 -0
- metadata +86 -0
@@ -0,0 +1,998 @@
|
|
1
|
+
# Stub objects for AdaptivePayments
|
2
|
+
# Auto generated code
|
3
|
+
|
4
|
+
require 'paypal-sdk-core'
|
5
|
+
|
6
|
+
module PayPal::SDK
|
7
|
+
module AdaptivePayments
|
8
|
+
module DataTypes
|
9
|
+
|
10
|
+
class DataType < Core::API::DataTypes::Base
|
11
|
+
def self.load_members
|
12
|
+
add_attribute :xmlns
|
13
|
+
add_attribute :type, :namespace => :xsi
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
class EnumType < Core::API::DataTypes::Enum
|
18
|
+
end
|
19
|
+
|
20
|
+
class AccountIdentifier < DataType
|
21
|
+
def self.load_members
|
22
|
+
object_of :email, String
|
23
|
+
object_of :phone, PhoneNumberType
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
|
28
|
+
|
29
|
+
class BaseAddress < DataType
|
30
|
+
def self.load_members
|
31
|
+
object_of :line1, String, :required => true
|
32
|
+
object_of :line2, String
|
33
|
+
object_of :city, String, :required => true
|
34
|
+
object_of :state, String
|
35
|
+
object_of :postalCode, String
|
36
|
+
object_of :countryCode, String, :required => true
|
37
|
+
object_of :type, String
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
|
42
|
+
|
43
|
+
# Details about the end user of the application invoking this service.
|
44
|
+
class ClientDetailsType < DataType
|
45
|
+
def self.load_members
|
46
|
+
object_of :ipAddress, String
|
47
|
+
object_of :deviceId, String
|
48
|
+
object_of :applicationId, String
|
49
|
+
object_of :model, String
|
50
|
+
object_of :geoLocation, String
|
51
|
+
object_of :customerType, String
|
52
|
+
object_of :partnerName, String
|
53
|
+
object_of :customerId, String
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
|
58
|
+
|
59
|
+
class CurrencyType < DataType
|
60
|
+
def self.load_members
|
61
|
+
object_of :code, String, :required => true
|
62
|
+
object_of :amount, Float, :required => true
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
# This type contains the detailed error information resulting from the service operation.
|
69
|
+
class ErrorData < DataType
|
70
|
+
def self.load_members
|
71
|
+
object_of :errorId, Integer
|
72
|
+
object_of :domain, String
|
73
|
+
object_of :subdomain, String
|
74
|
+
object_of :severity, ErrorSeverity
|
75
|
+
object_of :category, ErrorCategory
|
76
|
+
object_of :message, String
|
77
|
+
object_of :exceptionId, String
|
78
|
+
array_of :parameter, ErrorParameter
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
class ErrorParameter < DataType
|
85
|
+
def self.load_members
|
86
|
+
add_attribute :name, :required => true
|
87
|
+
object_of :value, String, :required => true
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
# This specifies a fault, encapsulating error data, with specific error codes.
|
94
|
+
class FaultMessage < DataType
|
95
|
+
def self.load_members
|
96
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
97
|
+
array_of :error, ErrorData
|
98
|
+
end
|
99
|
+
end
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
class PhoneNumberType < DataType
|
104
|
+
def self.load_members
|
105
|
+
object_of :countryCode, String, :required => true
|
106
|
+
object_of :phoneNumber, String, :required => true
|
107
|
+
object_of :extension, String
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
# This specifies the list of parameters with every request to the service.
|
114
|
+
class RequestEnvelope < DataType
|
115
|
+
def self.load_members
|
116
|
+
# This specifies the required detail level that is needed by a client application pertaining to a particular data component (e.g., Item, Transaction, etc.). The detail level is specified in the DetailLevelCodeType which has all the enumerated values of the detail level for each component.
|
117
|
+
object_of :detailLevel, DetailLevelCode
|
118
|
+
# This should be the standard RFC 3066 language identification tag, e.g., en_US.
|
119
|
+
object_of :errorLanguage, String, :required => true
|
120
|
+
end
|
121
|
+
end
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
# This specifies a list of parameters with every response from a service.
|
126
|
+
class ResponseEnvelope < DataType
|
127
|
+
def self.load_members
|
128
|
+
object_of :timestamp, DateTime, :required => true
|
129
|
+
# Application level acknowledgment code.
|
130
|
+
object_of :ack, AckCode, :required => true
|
131
|
+
object_of :correlationId, String, :required => true
|
132
|
+
object_of :build, String, :required => true
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
# AckCodeType This code identifies the acknowledgment code types that could be used to communicate the status of processing a (request) message to an application. This code would be used as part of a response message that contains an application level acknowledgment element.
|
139
|
+
class AckCode < EnumType
|
140
|
+
self.options = { 'SUCCESS' => 'Success', 'FAILURE' => 'Failure', 'WARNING' => 'Warning', 'SUCCESSWITHWARNING' => 'SuccessWithWarning', 'FAILUREWITHWARNING' => 'FailureWithWarning' }
|
141
|
+
end
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
class DayOfWeek < EnumType
|
146
|
+
self.options = { 'NODAYSPECIFIED' => 'NO_DAY_SPECIFIED', 'SUNDAY' => 'SUNDAY', 'MONDAY' => 'MONDAY', 'TUESDAY' => 'TUESDAY', 'WEDNESDAY' => 'WEDNESDAY', 'THURSDAY' => 'THURSDAY', 'FRIDAY' => 'FRIDAY', 'SATURDAY' => 'SATURDAY' }
|
147
|
+
end
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
# DetailLevelCodeType
|
152
|
+
class DetailLevelCode < EnumType
|
153
|
+
self.options = { 'RETURNALL' => 'ReturnAll' }
|
154
|
+
end
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
class ErrorCategory < EnumType
|
159
|
+
self.options = { 'SYSTEM' => 'System', 'APPLICATION' => 'Application', 'REQUEST' => 'Request' }
|
160
|
+
end
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
class ErrorSeverity < EnumType
|
165
|
+
self.options = { 'ERROR' => 'Error', 'WARNING' => 'Warning' }
|
166
|
+
end
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
class Address < DataType
|
171
|
+
def self.load_members
|
172
|
+
object_of :addresseeName, String
|
173
|
+
object_of :baseAddress, BaseAddress, :required => true
|
174
|
+
object_of :addressId, String
|
175
|
+
end
|
176
|
+
end
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
class AddressList < DataType
|
181
|
+
def self.load_members
|
182
|
+
array_of :address, Address, :required => true
|
183
|
+
end
|
184
|
+
end
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
# A list of ISO currency codes.
|
189
|
+
class CurrencyCodeList < DataType
|
190
|
+
def self.load_members
|
191
|
+
array_of :currencyCode, String, :required => true
|
192
|
+
end
|
193
|
+
end
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
# A list of estimated currency conversions for a base currency.
|
198
|
+
class CurrencyConversionList < DataType
|
199
|
+
def self.load_members
|
200
|
+
object_of :baseAmount, CurrencyType, :required => true
|
201
|
+
object_of :currencyList, CurrencyList, :required => true
|
202
|
+
end
|
203
|
+
end
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
# A table that contains a list of estimated currency conversions for a base currency in each row.
|
208
|
+
class CurrencyConversionTable < DataType
|
209
|
+
def self.load_members
|
210
|
+
array_of :currencyConversionList, CurrencyConversionList, :required => true
|
211
|
+
end
|
212
|
+
end
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
# A list of ISO currencies.
|
217
|
+
class CurrencyList < DataType
|
218
|
+
def self.load_members
|
219
|
+
array_of :currency, CurrencyType, :required => true
|
220
|
+
end
|
221
|
+
end
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
# Customizable options that a client application can specify for display purposes.
|
226
|
+
class DisplayOptions < DataType
|
227
|
+
def self.load_members
|
228
|
+
object_of :emailHeaderImageUrl, String
|
229
|
+
object_of :emailMarketingImageUrl, String
|
230
|
+
object_of :headerImageUrl, String
|
231
|
+
object_of :businessName, String
|
232
|
+
end
|
233
|
+
end
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
class ErrorList < DataType
|
238
|
+
def self.load_members
|
239
|
+
array_of :error, ErrorData, :required => true
|
240
|
+
end
|
241
|
+
end
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
class FundingConstraint < DataType
|
246
|
+
def self.load_members
|
247
|
+
object_of :allowedFundingType, FundingTypeList
|
248
|
+
end
|
249
|
+
end
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
# FundingTypeInfo represents one allowed funding type.
|
254
|
+
class FundingTypeInfo < DataType
|
255
|
+
def self.load_members
|
256
|
+
object_of :fundingType, String, :required => true
|
257
|
+
end
|
258
|
+
end
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
class FundingTypeList < DataType
|
263
|
+
def self.load_members
|
264
|
+
array_of :fundingTypeInfo, FundingTypeInfo, :required => true
|
265
|
+
end
|
266
|
+
end
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
# Describes the conversion between 2 currencies.
|
271
|
+
class CurrencyConversion < DataType
|
272
|
+
def self.load_members
|
273
|
+
object_of :from, CurrencyType, :required => true
|
274
|
+
object_of :to, CurrencyType, :required => true
|
275
|
+
object_of :exchangeRate, Float, :required => true
|
276
|
+
end
|
277
|
+
end
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
# Funding source information.
|
282
|
+
class FundingSource < DataType
|
283
|
+
def self.load_members
|
284
|
+
object_of :lastFourOfAccountNumber, String
|
285
|
+
object_of :type, String, :required => true
|
286
|
+
object_of :displayName, String
|
287
|
+
object_of :fundingSourceId, String
|
288
|
+
object_of :allowed, Boolean
|
289
|
+
end
|
290
|
+
end
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
# Amount to be charged to a particular funding source.
|
295
|
+
class FundingPlanCharge < DataType
|
296
|
+
def self.load_members
|
297
|
+
object_of :charge, CurrencyType, :required => true
|
298
|
+
object_of :fundingSource, FundingSource, :required => true
|
299
|
+
end
|
300
|
+
end
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
# FundingPlan describes the funding sources to be used for a specific payment.
|
305
|
+
class FundingPlan < DataType
|
306
|
+
def self.load_members
|
307
|
+
object_of :fundingPlanId, String, :required => true
|
308
|
+
object_of :fundingAmount, CurrencyType, :required => true
|
309
|
+
object_of :backupFundingSource, FundingSource
|
310
|
+
object_of :senderFees, CurrencyType
|
311
|
+
object_of :currencyConversion, CurrencyConversion
|
312
|
+
array_of :charge, FundingPlanCharge, :required => true
|
313
|
+
end
|
314
|
+
end
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
# Details about the party that initiated this payment. The API user is making this payment on behalf of the initiator. The initiator can simply be an institution or a customer of the institution.
|
319
|
+
class InitiatingEntity < DataType
|
320
|
+
def self.load_members
|
321
|
+
object_of :institutionCustomer, InstitutionCustomer
|
322
|
+
end
|
323
|
+
end
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
# The customer of the initiating institution
|
328
|
+
class InstitutionCustomer < DataType
|
329
|
+
def self.load_members
|
330
|
+
# The unique identifier as assigned to the institution.
|
331
|
+
object_of :institutionId, String, :required => true
|
332
|
+
# The first (given) name of the end consumer as known by the institution.
|
333
|
+
object_of :firstName, String, :required => true
|
334
|
+
# The last (family) name of the end consumer as known by the institution.
|
335
|
+
object_of :lastName, String, :required => true
|
336
|
+
# The full name of the end consumer as known by the institution.
|
337
|
+
object_of :displayName, String, :required => true
|
338
|
+
# The unique identifier as assigned to the end consumer by the institution.
|
339
|
+
object_of :institutionCustomerId, String, :required => true
|
340
|
+
# The two-character ISO country code of the home country of the end consumer
|
341
|
+
object_of :countryCode, String, :required => true
|
342
|
+
object_of :email, String
|
343
|
+
end
|
344
|
+
end
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
# Describes an individual item for an invoice.
|
349
|
+
class InvoiceItem < DataType
|
350
|
+
def self.load_members
|
351
|
+
object_of :name, String
|
352
|
+
object_of :identifier, String
|
353
|
+
object_of :price, Float
|
354
|
+
object_of :itemPrice, Float
|
355
|
+
object_of :itemCount, Integer
|
356
|
+
end
|
357
|
+
end
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
# Describes a payment for a particular receiver (merchant), contains list of additional per item details.
|
362
|
+
class InvoiceData < DataType
|
363
|
+
def self.load_members
|
364
|
+
array_of :item, InvoiceItem
|
365
|
+
object_of :totalTax, Float
|
366
|
+
object_of :totalShipping, Float
|
367
|
+
end
|
368
|
+
end
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
# The error that resulted from an attempt to make a payment to a receiver.
|
373
|
+
class PayError < DataType
|
374
|
+
def self.load_members
|
375
|
+
object_of :receiver, Receiver, :required => true
|
376
|
+
object_of :error, ErrorData, :required => true
|
377
|
+
end
|
378
|
+
end
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
class PayErrorList < DataType
|
383
|
+
def self.load_members
|
384
|
+
array_of :payError, PayError, :required => true
|
385
|
+
end
|
386
|
+
end
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
# PaymentInfo represents the payment attempt made to a Receiver of a PayRequest. If the execution of the payment has not yet completed, there will not be any transaction details.
|
391
|
+
class PaymentInfo < DataType
|
392
|
+
def self.load_members
|
393
|
+
object_of :transactionId, String
|
394
|
+
object_of :transactionStatus, String
|
395
|
+
object_of :receiver, Receiver, :required => true
|
396
|
+
object_of :refundedAmount, Float
|
397
|
+
object_of :pendingRefund, Boolean
|
398
|
+
object_of :senderTransactionId, String
|
399
|
+
object_of :senderTransactionStatus, String
|
400
|
+
object_of :pendingReason, String
|
401
|
+
end
|
402
|
+
end
|
403
|
+
|
404
|
+
|
405
|
+
|
406
|
+
class PaymentInfoList < DataType
|
407
|
+
def self.load_members
|
408
|
+
array_of :paymentInfo, PaymentInfo, :required => true
|
409
|
+
end
|
410
|
+
end
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
# Receiver is the party where funds are transferred to. A primary receiver receives a payment directly from the sender in a chained split payment. A primary receiver should not be specified when making a single or parallel split payment.
|
415
|
+
class Receiver < DataType
|
416
|
+
def self.load_members
|
417
|
+
object_of :amount, Float, :required => true
|
418
|
+
object_of :email, String
|
419
|
+
object_of :phone, PhoneNumberType
|
420
|
+
object_of :primary, Boolean
|
421
|
+
object_of :invoiceId, String
|
422
|
+
object_of :paymentType, String
|
423
|
+
object_of :paymentSubType, String
|
424
|
+
end
|
425
|
+
end
|
426
|
+
|
427
|
+
|
428
|
+
|
429
|
+
class ReceiverList < DataType
|
430
|
+
def self.load_members
|
431
|
+
array_of :receiver, Receiver, :required => true
|
432
|
+
end
|
433
|
+
end
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
# The sender identifier type contains information to identify a PayPal account.
|
438
|
+
class ReceiverIdentifier < AccountIdentifier
|
439
|
+
def self.load_members
|
440
|
+
end
|
441
|
+
end
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
# Options that apply to the receiver of a payment, allows setting additional details for payment using invoice.
|
446
|
+
class ReceiverOptions < DataType
|
447
|
+
def self.load_members
|
448
|
+
object_of :description, String
|
449
|
+
object_of :customId, String
|
450
|
+
object_of :invoiceData, InvoiceData
|
451
|
+
object_of :receiver, ReceiverIdentifier, :required => true
|
452
|
+
object_of :referrerCode, String
|
453
|
+
end
|
454
|
+
end
|
455
|
+
|
456
|
+
|
457
|
+
|
458
|
+
# RefundInfo represents the refund attempt made to a Receiver of a PayRequest.
|
459
|
+
class RefundInfo < DataType
|
460
|
+
def self.load_members
|
461
|
+
object_of :receiver, Receiver, :required => true
|
462
|
+
object_of :refundStatus, String
|
463
|
+
object_of :refundNetAmount, Float
|
464
|
+
object_of :refundFeeAmount, Float
|
465
|
+
object_of :refundGrossAmount, Float
|
466
|
+
object_of :totalOfAllRefunds, Float
|
467
|
+
object_of :refundHasBecomeFull, Boolean
|
468
|
+
object_of :encryptedRefundTransactionId, String
|
469
|
+
object_of :refundTransactionStatus, String
|
470
|
+
object_of :errorList, ErrorList
|
471
|
+
end
|
472
|
+
end
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
class RefundInfoList < DataType
|
477
|
+
def self.load_members
|
478
|
+
array_of :refundInfo, RefundInfo, :required => true
|
479
|
+
end
|
480
|
+
end
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
# Options that apply to the sender of a payment.
|
485
|
+
class SenderOptions < DataType
|
486
|
+
def self.load_members
|
487
|
+
# Require the user to select a shipping address during the web flow.
|
488
|
+
object_of :requireShippingAddressSelection, Boolean
|
489
|
+
object_of :referrerCode, String
|
490
|
+
end
|
491
|
+
end
|
492
|
+
|
493
|
+
|
494
|
+
|
495
|
+
# Details about the payer's tax info passed in by the merchant or partner.
|
496
|
+
class TaxIdDetails < DataType
|
497
|
+
def self.load_members
|
498
|
+
# Tax id of the merchant/business.
|
499
|
+
object_of :taxId, String
|
500
|
+
# Tax type of the Tax Id.
|
501
|
+
object_of :taxIdType, String
|
502
|
+
end
|
503
|
+
end
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
# The sender identifier type contains information to identify a PayPal account.
|
508
|
+
class SenderIdentifier < AccountIdentifier
|
509
|
+
def self.load_members
|
510
|
+
object_of :useCredentials, Boolean
|
511
|
+
object_of :taxIdDetails, TaxIdDetails
|
512
|
+
end
|
513
|
+
end
|
514
|
+
|
515
|
+
|
516
|
+
|
517
|
+
class UserLimit < DataType
|
518
|
+
def self.load_members
|
519
|
+
object_of :limitType, String, :required => true
|
520
|
+
object_of :limitAmount, CurrencyType, :required => true
|
521
|
+
end
|
522
|
+
end
|
523
|
+
|
524
|
+
|
525
|
+
|
526
|
+
# This type contains the detailed warning information resulting from the service operation.
|
527
|
+
class WarningData < DataType
|
528
|
+
def self.load_members
|
529
|
+
object_of :warningId, Integer
|
530
|
+
object_of :message, String
|
531
|
+
end
|
532
|
+
end
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
class WarningDataList < DataType
|
537
|
+
def self.load_members
|
538
|
+
array_of :warningData, WarningData, :required => true
|
539
|
+
end
|
540
|
+
end
|
541
|
+
|
542
|
+
|
543
|
+
|
544
|
+
# The request to cancel a Preapproval.
|
545
|
+
class CancelPreapprovalRequest < DataType
|
546
|
+
def self.load_members
|
547
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
548
|
+
object_of :preapprovalKey, String, :required => true
|
549
|
+
end
|
550
|
+
end
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
# The result of the CancelPreapprovalRequest.
|
555
|
+
class CancelPreapprovalResponse < DataType
|
556
|
+
def self.load_members
|
557
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
558
|
+
array_of :error, ErrorData
|
559
|
+
end
|
560
|
+
end
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
# The request to confirm a Preapproval.
|
565
|
+
class ConfirmPreapprovalRequest < DataType
|
566
|
+
def self.load_members
|
567
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
568
|
+
object_of :preapprovalKey, String, :required => true
|
569
|
+
object_of :fundingSourceId, String
|
570
|
+
object_of :pin, String
|
571
|
+
end
|
572
|
+
end
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
# The result of the ConfirmPreapprovalRequest.
|
577
|
+
class ConfirmPreapprovalResponse < DataType
|
578
|
+
def self.load_members
|
579
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
580
|
+
array_of :error, ErrorData
|
581
|
+
end
|
582
|
+
end
|
583
|
+
|
584
|
+
|
585
|
+
|
586
|
+
# A request to convert one or more currencies into their estimated values in other currencies.
|
587
|
+
class ConvertCurrencyRequest < DataType
|
588
|
+
def self.load_members
|
589
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
590
|
+
object_of :baseAmountList, CurrencyList, :required => true
|
591
|
+
object_of :convertToCurrencyList, CurrencyCodeList, :required => true
|
592
|
+
# The two-character ISO country code where fx suppposed to happen
|
593
|
+
object_of :countryCode, String
|
594
|
+
object_of :conversionType, String
|
595
|
+
end
|
596
|
+
end
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
# A response that contains a table of estimated converted currencies based on the Convert Currency Request.
|
601
|
+
class ConvertCurrencyResponse < DataType
|
602
|
+
def self.load_members
|
603
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
604
|
+
object_of :estimatedAmountTable, CurrencyConversionTable, :required => true
|
605
|
+
array_of :error, ErrorData
|
606
|
+
end
|
607
|
+
end
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
# The request to execute the payment request.
|
612
|
+
class ExecutePaymentRequest < DataType
|
613
|
+
def self.load_members
|
614
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
615
|
+
object_of :payKey, String, :required => true
|
616
|
+
# Describes the action that is performed by this API
|
617
|
+
object_of :actionType, String
|
618
|
+
object_of :fundingPlanId, String
|
619
|
+
end
|
620
|
+
end
|
621
|
+
|
622
|
+
|
623
|
+
|
624
|
+
# The result of a payment execution.
|
625
|
+
class ExecutePaymentResponse < DataType
|
626
|
+
def self.load_members
|
627
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
628
|
+
object_of :paymentExecStatus, String, :required => true
|
629
|
+
object_of :payErrorList, PayErrorList
|
630
|
+
array_of :error, ErrorData
|
631
|
+
end
|
632
|
+
end
|
633
|
+
|
634
|
+
|
635
|
+
|
636
|
+
# The request to get the allowed funding sources available for a preapproval.
|
637
|
+
class GetAllowedFundingSourcesRequest < DataType
|
638
|
+
def self.load_members
|
639
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
640
|
+
object_of :key, String, :required => true
|
641
|
+
end
|
642
|
+
end
|
643
|
+
|
644
|
+
|
645
|
+
|
646
|
+
# The response to get the backup funding sources available for a preapproval.
|
647
|
+
class GetAllowedFundingSourcesResponse < DataType
|
648
|
+
def self.load_members
|
649
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
650
|
+
array_of :fundingSource, FundingSource
|
651
|
+
array_of :error, ErrorData
|
652
|
+
end
|
653
|
+
end
|
654
|
+
|
655
|
+
|
656
|
+
|
657
|
+
# The request to get the options of a payment request.
|
658
|
+
class GetPaymentOptionsRequest < DataType
|
659
|
+
def self.load_members
|
660
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
661
|
+
object_of :payKey, String, :required => true
|
662
|
+
end
|
663
|
+
end
|
664
|
+
|
665
|
+
|
666
|
+
|
667
|
+
# The response message for the GetPaymentOption request
|
668
|
+
class GetPaymentOptionsResponse < DataType
|
669
|
+
def self.load_members
|
670
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
671
|
+
object_of :initiatingEntity, InitiatingEntity
|
672
|
+
object_of :displayOptions, DisplayOptions
|
673
|
+
object_of :shippingAddressId, String
|
674
|
+
object_of :senderOptions, SenderOptions
|
675
|
+
array_of :receiverOptions, ReceiverOptions
|
676
|
+
array_of :error, ErrorData
|
677
|
+
end
|
678
|
+
end
|
679
|
+
|
680
|
+
|
681
|
+
|
682
|
+
# The request to look up the details of a PayRequest. The PaymentDetailsRequest can be made with either a payKey, trackingId, or a transactionId of the PayRequest.
|
683
|
+
class PaymentDetailsRequest < DataType
|
684
|
+
def self.load_members
|
685
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
686
|
+
object_of :payKey, String
|
687
|
+
object_of :transactionId, String
|
688
|
+
object_of :trackingId, String
|
689
|
+
end
|
690
|
+
end
|
691
|
+
|
692
|
+
|
693
|
+
|
694
|
+
# The details of the PayRequest as specified in the Pay operation.
|
695
|
+
class PaymentDetailsResponse < DataType
|
696
|
+
def self.load_members
|
697
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
698
|
+
object_of :cancelUrl, String, :required => true
|
699
|
+
object_of :currencyCode, String, :required => true
|
700
|
+
object_of :ipnNotificationUrl, String
|
701
|
+
object_of :memo, String
|
702
|
+
object_of :paymentInfoList, PaymentInfoList, :required => true
|
703
|
+
object_of :returnUrl, String, :required => true
|
704
|
+
object_of :senderEmail, String
|
705
|
+
object_of :status, String, :required => true
|
706
|
+
object_of :trackingId, String
|
707
|
+
object_of :payKey, String, :required => true
|
708
|
+
object_of :actionType, String, :required => true
|
709
|
+
object_of :feesPayer, String, :required => true
|
710
|
+
object_of :reverseAllParallelPaymentsOnError, Boolean
|
711
|
+
object_of :preapprovalKey, String
|
712
|
+
object_of :fundingConstraint, FundingConstraint
|
713
|
+
object_of :sender, SenderIdentifier
|
714
|
+
array_of :error, ErrorData
|
715
|
+
end
|
716
|
+
end
|
717
|
+
|
718
|
+
|
719
|
+
|
720
|
+
# The PayRequest contains the payment instructions to make from sender to receivers.
|
721
|
+
class PayRequest < DataType
|
722
|
+
def self.load_members
|
723
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
724
|
+
object_of :clientDetails, ClientDetailsType
|
725
|
+
object_of :actionType, String, :required => true
|
726
|
+
object_of :cancelUrl, String, :required => true
|
727
|
+
object_of :currencyCode, String, :required => true
|
728
|
+
object_of :feesPayer, String
|
729
|
+
object_of :ipnNotificationUrl, String
|
730
|
+
object_of :memo, String
|
731
|
+
object_of :pin, String
|
732
|
+
object_of :preapprovalKey, String
|
733
|
+
object_of :receiverList, ReceiverList, :required => true
|
734
|
+
object_of :reverseAllParallelPaymentsOnError, Boolean
|
735
|
+
object_of :senderEmail, String
|
736
|
+
object_of :returnUrl, String, :required => true
|
737
|
+
object_of :trackingId, String
|
738
|
+
object_of :fundingConstraint, FundingConstraint
|
739
|
+
object_of :sender, SenderIdentifier
|
740
|
+
end
|
741
|
+
end
|
742
|
+
|
743
|
+
|
744
|
+
|
745
|
+
# The PayResponse contains the result of the Pay operation. The payKey and execution status of the request should always be provided.
|
746
|
+
class PayResponse < DataType
|
747
|
+
def self.load_members
|
748
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
749
|
+
object_of :payKey, String, :required => true
|
750
|
+
object_of :paymentExecStatus, String, :required => true
|
751
|
+
object_of :payErrorList, PayErrorList
|
752
|
+
object_of :defaultFundingPlan, FundingPlan
|
753
|
+
object_of :warningDataList, WarningDataList
|
754
|
+
array_of :error, ErrorData
|
755
|
+
end
|
756
|
+
end
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
# The request to look up the details of a Preapproval.
|
761
|
+
class PreapprovalDetailsRequest < DataType
|
762
|
+
def self.load_members
|
763
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
764
|
+
object_of :preapprovalKey, String, :required => true
|
765
|
+
object_of :getBillingAddress, Boolean
|
766
|
+
end
|
767
|
+
end
|
768
|
+
|
769
|
+
|
770
|
+
|
771
|
+
# The details of the Preapproval as specified in the Preapproval operation.
|
772
|
+
class PreapprovalDetailsResponse < DataType
|
773
|
+
def self.load_members
|
774
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
775
|
+
object_of :approved, Boolean, :required => true
|
776
|
+
object_of :cancelUrl, String, :required => true
|
777
|
+
object_of :curPayments, Integer, :required => true
|
778
|
+
object_of :curPaymentsAmount, Float, :required => true
|
779
|
+
object_of :curPeriodAttempts, Integer
|
780
|
+
object_of :curPeriodEndingDate, DateTime
|
781
|
+
object_of :currencyCode, String, :required => true
|
782
|
+
object_of :dateOfMonth, Integer
|
783
|
+
object_of :dayOfWeek, DayOfWeek
|
784
|
+
object_of :endingDate, DateTime
|
785
|
+
object_of :maxAmountPerPayment, Float
|
786
|
+
object_of :maxNumberOfPayments, Integer
|
787
|
+
object_of :maxNumberOfPaymentsPerPeriod, Integer
|
788
|
+
object_of :maxTotalAmountOfAllPayments, Float
|
789
|
+
object_of :paymentPeriod, String
|
790
|
+
object_of :pinType, String
|
791
|
+
object_of :returnUrl, String, :required => true
|
792
|
+
object_of :senderEmail, String
|
793
|
+
object_of :memo, String
|
794
|
+
object_of :startingDate, DateTime, :required => true
|
795
|
+
object_of :status, String, :required => true
|
796
|
+
object_of :ipnNotificationUrl, String
|
797
|
+
object_of :addressList, AddressList
|
798
|
+
object_of :feesPayer, String
|
799
|
+
object_of :displayMaxTotalAmount, Boolean
|
800
|
+
array_of :error, ErrorData
|
801
|
+
end
|
802
|
+
end
|
803
|
+
|
804
|
+
|
805
|
+
|
806
|
+
# A request to create a Preapproval. A Preapproval is an agreement between a Paypal account holder (the sender) and the API caller (the service invoker) to make payment(s) on the the sender's behalf with various limitations defined.
|
807
|
+
class PreapprovalRequest < DataType
|
808
|
+
def self.load_members
|
809
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
810
|
+
object_of :clientDetails, ClientDetailsType
|
811
|
+
object_of :cancelUrl, String, :required => true
|
812
|
+
object_of :currencyCode, String, :required => true
|
813
|
+
object_of :dateOfMonth, Integer
|
814
|
+
object_of :dayOfWeek, DayOfWeek
|
815
|
+
object_of :endingDate, DateTime
|
816
|
+
object_of :maxAmountPerPayment, Float
|
817
|
+
object_of :maxNumberOfPayments, Integer
|
818
|
+
object_of :maxNumberOfPaymentsPerPeriod, Integer
|
819
|
+
object_of :maxTotalAmountOfAllPayments, Float
|
820
|
+
object_of :paymentPeriod, String
|
821
|
+
object_of :returnUrl, String, :required => true
|
822
|
+
object_of :memo, String
|
823
|
+
object_of :ipnNotificationUrl, String
|
824
|
+
object_of :senderEmail, String
|
825
|
+
object_of :startingDate, DateTime, :required => true
|
826
|
+
object_of :pinType, String
|
827
|
+
object_of :feesPayer, String
|
828
|
+
object_of :displayMaxTotalAmount, Boolean
|
829
|
+
object_of :requireInstantFundingSource, Boolean
|
830
|
+
end
|
831
|
+
end
|
832
|
+
|
833
|
+
|
834
|
+
|
835
|
+
# The result of the PreapprovalRequest is a preapprovalKey.
|
836
|
+
class PreapprovalResponse < DataType
|
837
|
+
def self.load_members
|
838
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
839
|
+
object_of :preapprovalKey, String, :required => true
|
840
|
+
array_of :error, ErrorData
|
841
|
+
end
|
842
|
+
end
|
843
|
+
|
844
|
+
|
845
|
+
|
846
|
+
# A request to make a refund based on various criteria. A refund can be made against the entire payKey, an individual transaction belonging to a payKey, a tracking id, or a specific receiver of a payKey.
|
847
|
+
class RefundRequest < DataType
|
848
|
+
def self.load_members
|
849
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
850
|
+
object_of :currencyCode, String
|
851
|
+
object_of :payKey, String
|
852
|
+
object_of :transactionId, String
|
853
|
+
object_of :trackingId, String
|
854
|
+
object_of :receiverList, ReceiverList
|
855
|
+
end
|
856
|
+
end
|
857
|
+
|
858
|
+
|
859
|
+
|
860
|
+
# The result of a Refund request.
|
861
|
+
class RefundResponse < DataType
|
862
|
+
def self.load_members
|
863
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
864
|
+
object_of :currencyCode, String, :required => true
|
865
|
+
object_of :refundInfoList, RefundInfoList, :required => true
|
866
|
+
array_of :error, ErrorData
|
867
|
+
end
|
868
|
+
end
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
# The request to set the options of a payment request.
|
873
|
+
class SetPaymentOptionsRequest < DataType
|
874
|
+
def self.load_members
|
875
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
876
|
+
object_of :payKey, String, :required => true
|
877
|
+
object_of :initiatingEntity, InitiatingEntity
|
878
|
+
object_of :displayOptions, DisplayOptions
|
879
|
+
object_of :shippingAddressId, String
|
880
|
+
object_of :senderOptions, SenderOptions
|
881
|
+
array_of :receiverOptions, ReceiverOptions
|
882
|
+
end
|
883
|
+
end
|
884
|
+
|
885
|
+
|
886
|
+
|
887
|
+
# The response message for the SetPaymentOption request
|
888
|
+
class SetPaymentOptionsResponse < DataType
|
889
|
+
def self.load_members
|
890
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
891
|
+
array_of :error, ErrorData
|
892
|
+
end
|
893
|
+
end
|
894
|
+
|
895
|
+
|
896
|
+
|
897
|
+
# The request to get the funding plans available for a payment.
|
898
|
+
class GetFundingPlansRequest < DataType
|
899
|
+
def self.load_members
|
900
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
901
|
+
object_of :payKey, String, :required => true
|
902
|
+
end
|
903
|
+
end
|
904
|
+
|
905
|
+
|
906
|
+
|
907
|
+
# The response to get the funding plans available for a payment.
|
908
|
+
class GetFundingPlansResponse < DataType
|
909
|
+
def self.load_members
|
910
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
911
|
+
array_of :fundingPlan, FundingPlan
|
912
|
+
array_of :error, ErrorData
|
913
|
+
end
|
914
|
+
end
|
915
|
+
|
916
|
+
|
917
|
+
|
918
|
+
# The request to get the addresses available for a payment.
|
919
|
+
class GetAvailableShippingAddressesRequest < DataType
|
920
|
+
def self.load_members
|
921
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
922
|
+
# The key for which to provide the available addresses. Key can be an AdaptivePayments key such as payKey or preapprovalKey
|
923
|
+
object_of :key, String, :required => true
|
924
|
+
end
|
925
|
+
end
|
926
|
+
|
927
|
+
|
928
|
+
|
929
|
+
# The response to get the shipping addresses available for a payment.
|
930
|
+
class GetAvailableShippingAddressesResponse < DataType
|
931
|
+
def self.load_members
|
932
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
933
|
+
array_of :availableAddress, Address
|
934
|
+
array_of :error, ErrorData
|
935
|
+
end
|
936
|
+
end
|
937
|
+
|
938
|
+
|
939
|
+
|
940
|
+
# The request to get the addresses available for a payment.
|
941
|
+
class GetShippingAddressesRequest < DataType
|
942
|
+
def self.load_members
|
943
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
944
|
+
# The key for which to provide the available addresses. Key can be an AdaptivePayments key such as payKey or preapprovalKey
|
945
|
+
object_of :key, String, :required => true
|
946
|
+
end
|
947
|
+
end
|
948
|
+
|
949
|
+
|
950
|
+
|
951
|
+
# The response to get the shipping addresses available for a payment.
|
952
|
+
class GetShippingAddressesResponse < DataType
|
953
|
+
def self.load_members
|
954
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
955
|
+
object_of :selectedAddress, Address
|
956
|
+
array_of :error, ErrorData
|
957
|
+
end
|
958
|
+
end
|
959
|
+
|
960
|
+
|
961
|
+
|
962
|
+
# The request to get the remaining limits for a user
|
963
|
+
class GetUserLimitsRequest < DataType
|
964
|
+
def self.load_members
|
965
|
+
object_of :requestEnvelope, RequestEnvelope, :required => true
|
966
|
+
# The account identifier for the user
|
967
|
+
object_of :user, AccountIdentifier, :required => true
|
968
|
+
object_of :country, String, :required => true
|
969
|
+
object_of :currencyCode, String, :required => true
|
970
|
+
# List of limit types
|
971
|
+
array_of :limitType, String, :required => true
|
972
|
+
end
|
973
|
+
end
|
974
|
+
|
975
|
+
|
976
|
+
|
977
|
+
# A response that contains a list of remaining limits
|
978
|
+
class GetUserLimitsResponse < DataType
|
979
|
+
def self.load_members
|
980
|
+
object_of :responseEnvelope, ResponseEnvelope, :required => true
|
981
|
+
array_of :userLimit, UserLimit, :required => true
|
982
|
+
object_of :warningDataList, WarningDataList
|
983
|
+
array_of :error, ErrorData
|
984
|
+
end
|
985
|
+
end
|
986
|
+
|
987
|
+
|
988
|
+
|
989
|
+
|
990
|
+
|
991
|
+
constants.each do |data_type_klass|
|
992
|
+
data_type_klass = const_get(data_type_klass)
|
993
|
+
data_type_klass.load_members if defined? data_type_klass.load_members
|
994
|
+
end
|
995
|
+
|
996
|
+
end
|
997
|
+
end
|
998
|
+
end
|