-
Notifications
You must be signed in to change notification settings - Fork 1
/
financialaccountfinancialtransaction.go
160 lines (141 loc) · 6.94 KB
/
financialaccountfinancialtransaction.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package lithic
import (
"context"
"errors"
"fmt"
"net/http"
"net/url"
"time"
"github.com/lithic-com/lithic-go/internal/apiquery"
"github.com/lithic-com/lithic-go/internal/pagination"
"github.com/lithic-com/lithic-go/internal/param"
"github.com/lithic-com/lithic-go/internal/requestconfig"
"github.com/lithic-com/lithic-go/option"
)
// FinancialAccountFinancialTransactionService contains methods and other services
// that help with interacting with the lithic API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewFinancialAccountFinancialTransactionService] method instead.
type FinancialAccountFinancialTransactionService struct {
Options []option.RequestOption
}
// NewFinancialAccountFinancialTransactionService generates a new service that
// applies the given options to each request. These options are applied after the
// parent client's options (if there is one), and before any request-specific
// options.
func NewFinancialAccountFinancialTransactionService(opts ...option.RequestOption) (r *FinancialAccountFinancialTransactionService) {
r = &FinancialAccountFinancialTransactionService{}
r.Options = opts
return
}
// Get the financial transaction for the provided token.
func (r *FinancialAccountFinancialTransactionService) Get(ctx context.Context, financialAccountToken string, financialTransactionToken string, opts ...option.RequestOption) (res *FinancialTransaction, err error) {
opts = append(r.Options[:], opts...)
if financialAccountToken == "" {
err = errors.New("missing required financial_account_token parameter")
return
}
if financialTransactionToken == "" {
err = errors.New("missing required financial_transaction_token parameter")
return
}
path := fmt.Sprintf("financial_accounts/%s/financial_transactions/%s", financialAccountToken, financialTransactionToken)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
return
}
// List the financial transactions for a given financial account.
func (r *FinancialAccountFinancialTransactionService) List(ctx context.Context, financialAccountToken string, query FinancialTransactionListParams, opts ...option.RequestOption) (res *pagination.SinglePage[FinancialTransaction], err error) {
var raw *http.Response
opts = append(r.Options, opts...)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := fmt.Sprintf("financial_accounts/%s/financial_transactions", financialAccountToken)
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, query, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// List the financial transactions for a given financial account.
func (r *FinancialAccountFinancialTransactionService) ListAutoPaging(ctx context.Context, financialAccountToken string, query FinancialTransactionListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[FinancialTransaction] {
return pagination.NewSinglePageAutoPager(r.List(ctx, financialAccountToken, query, opts...))
}
type FinancialTransactionListParams struct {
// Date string in RFC 3339 format. Only entries created after the specified time
// will be included. UTC time zone.
Begin param.Field[time.Time] `query:"begin" format:"date-time"`
// Financial Transaction category to be returned.
Category param.Field[FinancialTransactionListParamsCategory] `query:"category"`
// Date string in RFC 3339 format. Only entries created before the specified time
// will be included. UTC time zone.
End param.Field[time.Time] `query:"end" format:"date-time"`
// A cursor representing an item's token before which a page of results should end.
// Used to retrieve the previous page of results before this item.
EndingBefore param.Field[string] `query:"ending_before"`
// Financial Transaction result to be returned.
Result param.Field[FinancialTransactionListParamsResult] `query:"result"`
// A cursor representing an item's token after which a page of results should
// begin. Used to retrieve the next page of results after this item.
StartingAfter param.Field[string] `query:"starting_after"`
// Financial Transaction status to be returned.
Status param.Field[FinancialTransactionListParamsStatus] `query:"status"`
}
// URLQuery serializes [FinancialTransactionListParams]'s query parameters as
// `url.Values`.
func (r FinancialTransactionListParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatComma,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Financial Transaction category to be returned.
type FinancialTransactionListParamsCategory string
const (
FinancialTransactionListParamsCategoryACH FinancialTransactionListParamsCategory = "ACH"
FinancialTransactionListParamsCategoryCard FinancialTransactionListParamsCategory = "CARD"
FinancialTransactionListParamsCategoryTransfer FinancialTransactionListParamsCategory = "TRANSFER"
)
func (r FinancialTransactionListParamsCategory) IsKnown() bool {
switch r {
case FinancialTransactionListParamsCategoryACH, FinancialTransactionListParamsCategoryCard, FinancialTransactionListParamsCategoryTransfer:
return true
}
return false
}
// Financial Transaction result to be returned.
type FinancialTransactionListParamsResult string
const (
FinancialTransactionListParamsResultApproved FinancialTransactionListParamsResult = "APPROVED"
FinancialTransactionListParamsResultDeclined FinancialTransactionListParamsResult = "DECLINED"
)
func (r FinancialTransactionListParamsResult) IsKnown() bool {
switch r {
case FinancialTransactionListParamsResultApproved, FinancialTransactionListParamsResultDeclined:
return true
}
return false
}
// Financial Transaction status to be returned.
type FinancialTransactionListParamsStatus string
const (
FinancialTransactionListParamsStatusDeclined FinancialTransactionListParamsStatus = "DECLINED"
FinancialTransactionListParamsStatusExpired FinancialTransactionListParamsStatus = "EXPIRED"
FinancialTransactionListParamsStatusPending FinancialTransactionListParamsStatus = "PENDING"
FinancialTransactionListParamsStatusReturned FinancialTransactionListParamsStatus = "RETURNED"
FinancialTransactionListParamsStatusSettled FinancialTransactionListParamsStatus = "SETTLED"
FinancialTransactionListParamsStatusVoided FinancialTransactionListParamsStatus = "VOIDED"
)
func (r FinancialTransactionListParamsStatus) IsKnown() bool {
switch r {
case FinancialTransactionListParamsStatusDeclined, FinancialTransactionListParamsStatusExpired, FinancialTransactionListParamsStatusPending, FinancialTransactionListParamsStatusReturned, FinancialTransactionListParamsStatusSettled, FinancialTransactionListParamsStatusVoided:
return true
}
return false
}