-
Notifications
You must be signed in to change notification settings - Fork 541
/
billinghistory.go
163 lines (143 loc) · 5.46 KB
/
billinghistory.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package user
import (
"context"
"net/http"
"net/url"
"time"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/apiquery"
"github.com/cloudflare/cloudflare-go/v2/internal/pagination"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
)
// BillingHistoryService contains methods and other services that help with
// interacting with the cloudflare 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 [NewBillingHistoryService] method
// instead.
type BillingHistoryService struct {
Options []option.RequestOption
}
// NewBillingHistoryService 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 NewBillingHistoryService(opts ...option.RequestOption) (r *BillingHistoryService) {
r = &BillingHistoryService{}
r.Options = opts
return
}
// Accesses your billing history object.
func (r *BillingHistoryService) List(ctx context.Context, query BillingHistoryListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[BillingHistory], err error) {
var raw *http.Response
opts = append(r.Options, opts...)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "user/billing/history"
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
}
// Accesses your billing history object.
func (r *BillingHistoryService) ListAutoPaging(ctx context.Context, query BillingHistoryListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[BillingHistory] {
return pagination.NewV4PagePaginationArrayAutoPager(r.List(ctx, query, opts...))
}
type BillingHistory struct {
// Billing item identifier tag.
ID string `json:"id,required"`
// The billing item action.
Action string `json:"action,required"`
// The amount associated with this billing item.
Amount float64 `json:"amount,required"`
// The monetary unit in which pricing information is displayed.
Currency string `json:"currency,required"`
// The billing item description.
Description string `json:"description,required"`
// When the billing item was created.
OccurredAt time.Time `json:"occurred_at,required" format:"date-time"`
// The billing item type.
Type string `json:"type,required"`
Zone BillingHistoryZone `json:"zone,required"`
JSON billingHistoryJSON `json:"-"`
}
// billingHistoryJSON contains the JSON metadata for the struct [BillingHistory]
type billingHistoryJSON struct {
ID apijson.Field
Action apijson.Field
Amount apijson.Field
Currency apijson.Field
Description apijson.Field
OccurredAt apijson.Field
Type apijson.Field
Zone apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *BillingHistory) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r billingHistoryJSON) RawJSON() string {
return r.raw
}
type BillingHistoryZone struct {
Name interface{} `json:"name"`
JSON billingHistoryZoneJSON `json:"-"`
}
// billingHistoryZoneJSON contains the JSON metadata for the struct
// [BillingHistoryZone]
type billingHistoryZoneJSON struct {
Name apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *BillingHistoryZone) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r billingHistoryZoneJSON) RawJSON() string {
return r.raw
}
type BillingHistoryListParams struct {
// The billing item action.
Action param.Field[string] `query:"action"`
// When the billing item was created.
OccuredAt param.Field[time.Time] `query:"occured_at" format:"date-time"`
// When the billing item was created.
OccurredAt param.Field[time.Time] `query:"occurred_at" format:"date-time"`
// Field to order billing history by.
Order param.Field[BillingHistoryListParamsOrder] `query:"order"`
// Page number of paginated results.
Page param.Field[float64] `query:"page"`
// Number of items per page.
PerPage param.Field[float64] `query:"per_page"`
// The billing item type.
Type param.Field[string] `query:"type"`
}
// URLQuery serializes [BillingHistoryListParams]'s query parameters as
// `url.Values`.
func (r BillingHistoryListParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Field to order billing history by.
type BillingHistoryListParamsOrder string
const (
BillingHistoryListParamsOrderType BillingHistoryListParamsOrder = "type"
BillingHistoryListParamsOrderOccuredAt BillingHistoryListParamsOrder = "occured_at"
BillingHistoryListParamsOrderAction BillingHistoryListParamsOrder = "action"
)
func (r BillingHistoryListParamsOrder) IsKnown() bool {
switch r {
case BillingHistoryListParamsOrderType, BillingHistoryListParamsOrderOccuredAt, BillingHistoryListParamsOrderAction:
return true
}
return false
}