-
Notifications
You must be signed in to change notification settings - Fork 471
/
Copy pathsource.go
353 lines (303 loc) · 14.2 KB
/
source.go
1
2
3
4
5
6
7
8
9
10
11
12
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
47
48
49
50
51
52
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
87
88
89
90
91
92
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
package stripe
import (
"encoding/json"
"github.com/stripe/stripe-go/v72/form"
)
// SourceCodeVerificationFlowStatus represents the possible statuses of a code verification flow.
type SourceCodeVerificationFlowStatus string
// List of values that SourceCodeVerificationFlowStatus can take.
const (
SourceCodeVerificationFlowStatusFailed SourceCodeVerificationFlowStatus = "failed"
SourceCodeVerificationFlowStatusPending SourceCodeVerificationFlowStatus = "pending"
SourceCodeVerificationFlowStatusSucceeded SourceCodeVerificationFlowStatus = "succeeded"
)
// SourceFlow represents the possible flows of a source object.
type SourceFlow string
// List of values that SourceFlow can take.
const (
SourceFlowCodeVerification SourceFlow = "code_verification"
SourceFlowNone SourceFlow = "none"
SourceFlowReceiver SourceFlow = "receiver"
SourceFlowRedirect SourceFlow = "redirect"
)
// SourceMandateAcceptanceStatus represents the possible failure reasons of a redirect flow.
type SourceMandateAcceptanceStatus string
// List of values that SourceMandateAcceptanceStatus can take.
const (
SourceMandateAcceptanceStatusAccepted SourceMandateAcceptanceStatus = "accepted"
SourceMandateAcceptanceStatusRefused SourceMandateAcceptanceStatus = "refused"
)
// SourceMandateNotificationMethod represents the possible methods of notification for a mandate.
type SourceMandateNotificationMethod string
// List of values that SourceMandateNotificationMethod can take.
const (
SourceMandateNotificationMethodEmail SourceMandateNotificationMethod = "email"
SourceMandateNotificationMethodManual SourceMandateNotificationMethod = "manual"
SourceMandateNotificationMethodNone SourceMandateNotificationMethod = "none"
)
// SourceSourceOrderItemType describes the type of source order items on source
// orders for sources.
type SourceSourceOrderItemType string
// The list of possible values for source order item types.
const (
SourceSourceOrderItemTypeDiscount SourceSourceOrderItemType = "discount"
SourceSourceOrderItemTypeSKU SourceSourceOrderItemType = "sku"
SourceSourceOrderItemTypeShipping SourceSourceOrderItemType = "shipping"
SourceSourceOrderItemTypeTax SourceSourceOrderItemType = "tax"
)
// SourceRedirectFlowFailureReason represents the possible failure reasons of a redirect flow.
type SourceRedirectFlowFailureReason string
// List of values that SourceRedirectFlowFailureReason can take.
const (
SourceRedirectFlowFailureReasonDeclined SourceRedirectFlowFailureReason = "declined"
SourceRedirectFlowFailureReasonProcessingError SourceRedirectFlowFailureReason = "processing_error"
SourceRedirectFlowFailureReasonUserAbort SourceRedirectFlowFailureReason = "user_abort"
)
// SourceRedirectFlowStatus represents the possible statuses of a redirect flow.
type SourceRedirectFlowStatus string
// List of values that SourceRedirectFlowStatus can take.
const (
SourceRedirectFlowStatusFailed SourceRedirectFlowStatus = "failed"
SourceRedirectFlowStatusNotRequired SourceRedirectFlowStatus = "not_required"
SourceRedirectFlowStatusPending SourceRedirectFlowStatus = "pending"
SourceRedirectFlowStatusSucceeded SourceRedirectFlowStatus = "succeeded"
)
// SourceRefundAttributesMethod are the possible method to retrieve a receiver's refund attributes.
type SourceRefundAttributesMethod string
// List of values that SourceRefundAttributesMethod can take.
const (
SourceRefundAttributesMethodEmail SourceRefundAttributesMethod = "email"
SourceRefundAttributesMethodManual SourceRefundAttributesMethod = "manual"
)
// SourceRefundAttributesStatus are the possible status of a receiver's refund attributes.
type SourceRefundAttributesStatus string
// List of values that SourceRefundAttributesStatus can take.
const (
SourceRefundAttributesStatusAvailable SourceRefundAttributesStatus = "available"
SourceRefundAttributesStatusMissing SourceRefundAttributesStatus = "missing"
SourceRefundAttributesStatusRequested SourceRefundAttributesStatus = "requested"
)
// SourceStatus represents the possible statuses of a source object.
type SourceStatus string
// List of values that SourceStatus can take.
const (
SourceStatusCanceled SourceStatus = "canceled"
SourceStatusChargeable SourceStatus = "chargeable"
SourceStatusConsumed SourceStatus = "consumed"
SourceStatusFailed SourceStatus = "failed"
SourceStatusPending SourceStatus = "pending"
)
// SourceUsage represents the possible usages of a source object.
type SourceUsage string
// List of values that SourceUsage can take.
const (
SourceUsageReusable SourceUsage = "reusable"
SourceUsageSingleUse SourceUsage = "single_use"
)
// SourceOwnerParams is the set of parameters allowed for the owner hash on
// source creation or update.
type SourceOwnerParams struct {
Address *AddressParams `form:"address"`
Email *string `form:"email"`
Name *string `form:"name"`
Phone *string `form:"phone"`
}
// RedirectParams is the set of parameters allowed for the redirect hash on
// source creation or update.
type RedirectParams struct {
ReturnURL *string `form:"return_url"`
}
// SourceOrderItemsParams is the set of parameters allowed for the items on a
// source order for a source.
type SourceOrderItemsParams struct {
Amount *int64 `form:"amount"`
Currency *string `form:"currency"`
Description *string `form:"description"`
Parent *string `form:"parent"`
Quantity *int64 `form:"quantity"`
Type *string `form:"type"`
}
// SourceOrderParams is the set of parameters allowed for the source order of a
// source.
type SourceOrderParams struct {
Items []*SourceOrderItemsParams `form:"items"`
Shipping *ShippingDetailsParams `form:"shipping"`
}
// SourceObjectParams is the set of parameters allowed on source creation or update.
type SourceObjectParams struct {
Params `form:"*"`
Amount *int64 `form:"amount"`
Currency *string `form:"currency"`
Customer *string `form:"customer"`
Flow *string `form:"flow"`
Mandate *SourceMandateParams `form:"mandate"`
OriginalSource *string `form:"original_source"`
Owner *SourceOwnerParams `form:"owner"`
Receiver *SourceReceiverParams `form:"receiver"`
Redirect *RedirectParams `form:"redirect"`
SourceOrder *SourceOrderParams `form:"source_order"`
StatementDescriptor *string `form:"statement_descriptor"`
Token *string `form:"token"`
Type *string `form:"type"`
TypeData map[string]string `form:"-"`
Usage *string `form:"usage"`
}
// SourceMandateAcceptanceParams describes the set of parameters allowed for the `acceptance`
// hash on source creation or update.
type SourceMandateAcceptanceParams struct {
Date *int64 `form:"date"`
IP *string `form:"ip"`
Offline *SourceMandateAcceptanceOfflineParams `form:"offline"`
Online *SourceMandateAcceptanceOnlineParams `form:"online"`
Status *string `form:"status"`
Type *string `form:"type"`
UserAgent *string `form:"user_agent"`
}
// SourceMandateAcceptanceOnlineParams describes the set of parameters for online accepted mandate
type SourceMandateAcceptanceOnlineParams struct {
Date *int64 `form:"date"`
IP *string `form:"ip"`
UserAgent *string `form:"user_agent"`
}
// SourceMandateAcceptanceOfflineParams describes the set of parameters for offline accepted mandate
type SourceMandateAcceptanceOfflineParams struct {
ContactEmail *string `form:"contact_email"`
}
// SourceMandateParams describes the set of parameters allowed for the `mandate` hash on
// source creation or update.
type SourceMandateParams struct {
Amount *int64 `form:"amount"`
Acceptance *SourceMandateAcceptanceParams `form:"acceptance"`
Currency *string `form:"currency"`
Interval *string `form:"interval"`
NotificationMethod *string `form:"notification_method"`
}
// SourceReceiverParams is the set of parameters allowed for the `receiver` hash on
// source creation or update.
type SourceReceiverParams struct {
RefundAttributesMethod *string `form:"refund_attributes_method"`
}
// SourceObjectDetachParams is the set of parameters that can be used when detaching
// a source from a customer.
type SourceObjectDetachParams struct {
Params `form:"*"`
Customer *string `form:"-"`
}
// SourceOwner describes the owner hash on a source.
type SourceOwner struct {
Address *Address `json:"address,omitempty"`
Email string `json:"email"`
Name string `json:"name"`
Phone string `json:"phone"`
VerifiedAddress *Address `json:"verified_address,omitempty"`
VerifiedEmail string `json:"verified_email"`
VerifiedName string `json:"verified_name"`
VerifiedPhone string `json:"verified_phone"`
}
// RedirectFlow informs of the state of a redirect authentication flow.
type RedirectFlow struct {
FailureReason SourceRedirectFlowFailureReason `json:"failure_reason"`
ReturnURL string `json:"return_url"`
Status SourceRedirectFlowStatus `json:"status"`
URL string `json:"url"`
}
// ReceiverFlow informs of the state of a receiver authentication flow.
type ReceiverFlow struct {
Address string `json:"address"`
AmountCharged int64 `json:"amount_charged"`
AmountReceived int64 `json:"amount_received"`
AmountReturned int64 `json:"amount_returned"`
RefundAttributesMethod SourceRefundAttributesMethod `json:"refund_attributes_method"`
RefundAttributesStatus SourceRefundAttributesStatus `json:"refund_attributes_status"`
}
// CodeVerificationFlow informs of the state of a verification authentication flow.
type CodeVerificationFlow struct {
AttemptsRemaining int64 `json:"attempts_remaining"`
Status SourceCodeVerificationFlowStatus `json:"status"`
}
// SourceMandateAcceptance describes a source mandate acceptance state.
type SourceMandateAcceptance struct {
Date int64 `json:"date"`
IP string `json:"ip"`
Status SourceMandateAcceptanceStatus `json:"status"`
UserAgent string `json:"user_agent"`
}
// SourceMandate describes a source mandate.
type SourceMandate struct {
Acceptance *SourceMandateAcceptance `json:"acceptance"`
NotificationMethod SourceMandateNotificationMethod `json:"notification_method"`
Reference string `json:"reference"`
URL string `json:"url"`
}
// SourceSourceOrderItems describes the items on source orders for sources.
type SourceSourceOrderItems struct {
Amount int64 `json:"amount"`
Currency Currency `json:"currency"`
Description string `json:"description"`
Quantity int64 `json:"quantity"`
Type SourceSourceOrderItemType `json:"type"`
}
// SourceSourceOrder describes a source order for a source.
type SourceSourceOrder struct {
Amount int64 `json:"amount"`
Currency Currency `json:"currency"`
Email string `json:"email"`
Items *[]SourceSourceOrderItems `json:"items"`
Shipping *ShippingDetails `json:"shipping"`
}
// Source is the resource representing a Source.
// For more details see https://stripe.com/docs/api#sources.
type Source struct {
APIResource
Amount int64 `json:"amount"`
ClientSecret string `json:"client_secret"`
CodeVerification *CodeVerificationFlow `json:"code_verification,omitempty"`
Created int64 `json:"created"`
Currency Currency `json:"currency"`
Customer string `json:"customer"`
Flow SourceFlow `json:"flow"`
ID string `json:"id"`
Livemode bool `json:"livemode"`
Mandate *SourceMandate `json:"mandate"`
Metadata map[string]string `json:"metadata"`
Owner *SourceOwner `json:"owner"`
Receiver *ReceiverFlow `json:"receiver,omitempty"`
Redirect *RedirectFlow `json:"redirect,omitempty"`
StatementDescriptor string `json:"statement_descriptor"`
SourceOrder *SourceSourceOrder `json:"source_order"`
Status SourceStatus `json:"status"`
Type string `json:"type"`
TypeData map[string]interface{}
Usage SourceUsage `json:"usage"`
}
// AppendTo implements custom encoding logic for SourceObjectParams so that the special
// "TypeData" value for is sent as the correct parameter based on the Source type
func (p *SourceObjectParams) AppendTo(body *form.Values, keyParts []string) {
if len(p.TypeData) > 0 && p.Type == nil {
panic("You can not fill TypeData if you don't explicitly set Type")
}
for k, vs := range p.TypeData {
body.Add(form.FormatKey(append(keyParts, StringValue(p.Type), k)), vs)
}
}
// UnmarshalJSON handles deserialization of an Source. This custom unmarshaling
// is needed to extract the type specific data (accessible under `TypeData`)
// but stored in JSON under a hash named after the `type` of the source.
func (s *Source) UnmarshalJSON(data []byte) error {
type source Source
var v source
if err := json.Unmarshal(data, &v); err != nil {
return err
}
*s = Source(v)
var raw map[string]interface{}
if err := json.Unmarshal(data, &raw); err != nil {
return err
}
if d, ok := raw[s.Type]; ok {
if m, ok := d.(map[string]interface{}); ok {
s.TypeData = m
}
}
return nil
}