chargebee-go/addon.go at v4 · chargebee/chargebee-go · GitHub

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
// Code generated by sdk-generator; DO NOT EDIT.
package chargebee

import (
	"encoding/json"
)

type AddonType string

const (
	AddonTypeOnOff     AddonType = "on_off"
	AddonTypeQuantity  AddonType = "quantity"
	AddonTypeTiered    AddonType = "tiered"
	AddonTypeVolume    AddonType = "volume"
	AddonTypeStairstep AddonType = "stairstep"
)

type AddonChargeType string

const (
	AddonChargeTypeRecurring    AddonChargeType = "recurring"
	AddonChargeTypeNonRecurring AddonChargeType = "non_recurring"
)

type AddonPeriodUnit string

const (
	AddonPeriodUnitDay           AddonPeriodUnit = "day"
	AddonPeriodUnitWeek          AddonPeriodUnit = "week"
	AddonPeriodUnitMonth         AddonPeriodUnit = "month"
	AddonPeriodUnitYear          AddonPeriodUnit = "year"
	AddonPeriodUnitNotApplicable AddonPeriodUnit = "not_applicable"
)

type AddonStatus string

const (
	AddonStatusActive   AddonStatus = "active"
	AddonStatusArchived AddonStatus = "archived"
	AddonStatusDeleted  AddonStatus = "deleted"
)

type AddonShippingFrequencyPeriodUnit string

const (
	AddonShippingFrequencyPeriodUnitYear  AddonShippingFrequencyPeriodUnit = "year"
	AddonShippingFrequencyPeriodUnitMonth AddonShippingFrequencyPeriodUnit = "month"
	AddonShippingFrequencyPeriodUnitWeek  AddonShippingFrequencyPeriodUnit = "week"
	AddonShippingFrequencyPeriodUnitDay   AddonShippingFrequencyPeriodUnit = "day"
)

type AddonProrationType string

const (
	AddonProrationTypeSiteDefault AddonProrationType = "site_default"
	AddonProrationTypePartialTerm AddonProrationType = "partial_term"
	AddonProrationTypeFullTerm    AddonProrationType = "full_term"
)

type Addon struct {
	Id           string       `json:"id"`
	Name         string       `json:"name"`
	InvoiceName  string       `json:"invoice_name"`
	Description  string       `json:"description"`
	PricingModel PricingModel `json:"pricing_model"`
	//Deprecated: this field is deprecated
	Type                        AddonType                        `json:"type"`
	ChargeType                  AddonChargeType                  `json:"charge_type"`
	Price                       int64                            `json:"price"`
	CurrencyCode                string                           `json:"currency_code"`
	Period                      int32                            `json:"period"`
	PeriodUnit                  AddonPeriodUnit                  `json:"period_unit"`
	Unit                        string                           `json:"unit"`
	Status                      AddonStatus                      `json:"status"`
	ArchivedAt                  int64                            `json:"archived_at"`
	EnabledInPortal             bool                             `json:"enabled_in_portal"`
	TaxCode                     string                           `json:"tax_code"`
	HsnCode                     string                           `json:"hsn_code"`
	TaxjarProductCode           string                           `json:"taxjar_product_code"`
	AvalaraSaleType             AvalaraSaleType                  `json:"avalara_sale_type"`
	AvalaraTransactionType      int32                            `json:"avalara_transaction_type"`
	AvalaraServiceType          int32                            `json:"avalara_service_type"`
	Sku                         string                           `json:"sku"`
	AccountingCode              string                           `json:"accounting_code"`
	AccountingCategory1         string                           `json:"accounting_category1"`
	AccountingCategory2         string                           `json:"accounting_category2"`
	AccountingCategory3         string                           `json:"accounting_category3"`
	AccountingCategory4         string                           `json:"accounting_category4"`
	IsShippable                 bool                             `json:"is_shippable"`
	ShippingFrequencyPeriod     int32                            `json:"shipping_frequency_period"`
	ShippingFrequencyPeriodUnit AddonShippingFrequencyPeriodUnit `json:"shipping_frequency_period_unit"`
	ResourceVersion             int64                            `json:"resource_version"`
	UpdatedAt                   int64                            `json:"updated_at"`
	PriceInDecimal              string                           `json:"price_in_decimal"`
	IncludedInMrr               bool                             `json:"included_in_mrr"`
	Channel                     Channel                          `json:"channel"`
	ProrationType               AddonProrationType               `json:"proration_type"`
	InvoiceNotes                string                           `json:"invoice_notes"`
	Taxable                     bool                             `json:"taxable"`
	TaxProfileId                string                           `json:"tax_profile_id"`
	MetaData                    json.RawMessage                  `json:"meta_data"`
	Tiers                       []*AddonTier                     `json:"tiers"`
	TaxProvidersFields          []*AddonTaxProvidersField        `json:"tax_providers_fields"`
	ShowDescriptionInInvoices   bool                             `json:"show_description_in_invoices"`
	ShowDescriptionInQuotes     bool                             `json:"show_description_in_quotes"`
	CustomFields                *CustomFields                    `json:"-"`
	Object                      string                           `json:"object"`
}

func (r *Addon) setCustomFields(cf *CustomFields) { r.CustomFields = cf }

func (r *Addon) UnmarshalJSON(data []byte) error {
	type Alias Addon
	return unmarshalObjectWithCustomField(data, r, (*Alias)(r))
}

type AddonTier struct {
	StartingUnit          int32       `json:"starting_unit"`
	EndingUnit            int32       `json:"ending_unit"`
	Price                 int64       `json:"price"`
	StartingUnitInDecimal string      `json:"starting_unit_in_decimal"`
	EndingUnitInDecimal   string      `json:"ending_unit_in_decimal"`
	PriceInDecimal        string      `json:"price_in_decimal"`
	PricingType           PricingType `json:"pricing_type"`
	PackageSize           int32       `json:"package_size"`
	Object                string      `json:"object"`
}

type AddonTaxProvidersField struct {
	ProviderName string `json:"provider_name"`
	FieldId      string `json:"field_id"`
	FieldValue   string `json:"field_value"`
	Object       string `json:"object"`
}

type AddonCreateRequest struct {
	Id                          string                           `json:"id"`
	Name                        string                           `json:"name"`
	InvoiceName                 string                           `json:"invoice_name,omitempty"`
	Description                 string                           `json:"description,omitempty"`
	ChargeType                  AddonChargeType                  `json:"charge_type"`
	Price                       *int64                           `json:"price,omitempty"`
	Tiers                       []*AddonCreateTier               `json:"tiers,omitempty"`
	CurrencyCode                string                           `json:"currency_code,omitempty"`
	Period                      *int32                           `json:"period,omitempty"`
	PeriodUnit                  AddonPeriodUnit                  `json:"period_unit,omitempty"`
	PricingModel                PricingModel                     `json:"pricing_model,omitempty"`
	Unit                        string                           `json:"unit,omitempty"`
	EnabledInPortal             *bool                            `json:"enabled_in_portal,omitempty"`
	Taxable                     *bool                            `json:"taxable,omitempty"`
	TaxProfileId                string                           `json:"tax_profile_id,omitempty"`
	AvalaraSaleType             AvalaraSaleType                  `json:"avalara_sale_type,omitempty"`
	AvalaraTransactionType      *int32                           `json:"avalara_transaction_type,omitempty"`
	AvalaraServiceType          *int32                           `json:"avalara_service_type,omitempty"`
	TaxCode                     string                           `json:"tax_code,omitempty"`
	HsnCode                     string                           `json:"hsn_code,omitempty"`
	TaxjarProductCode           string                           `json:"taxjar_product_code,omitempty"`
	InvoiceNotes                string                           `json:"invoice_notes,omitempty"`
	MetaData                    map[string]interface{}           `json:"meta_data,omitempty"`
	Sku                         string                           `json:"sku,omitempty"`
	AccountingCode              string                           `json:"accounting_code,omitempty"`
	AccountingCategory1         string                           `json:"accounting_category1,omitempty"`
	AccountingCategory2         string                           `json:"accounting_category2,omitempty"`
	AccountingCategory3         string                           `json:"accounting_category3,omitempty"`
	AccountingCategory4         string                           `json:"accounting_category4,omitempty"`
	IsShippable                 *bool                            `json:"is_shippable,omitempty"`
	ShippingFrequencyPeriod     *int32                           `json:"shipping_frequency_period,omitempty"`
	ShippingFrequencyPeriodUnit AddonShippingFrequencyPeriodUnit `json:"shipping_frequency_period_unit,omitempty"`
	IncludedInMrr               *bool                            `json:"included_in_mrr,omitempty"`
	ShowDescriptionInInvoices   *bool                            `json:"show_description_in_invoices,omitempty"`
	ShowDescriptionInQuotes     *bool                            `json:"show_description_in_quotes,omitempty"`
	PriceInDecimal              string                           `json:"price_in_decimal,omitempty"`
	TaxProvidersFields          []*AddonCreateTaxProvidersField  `json:"tax_providers_fields,omitempty"`
	ProrationType               AddonProrationType               `json:"proration_type,omitempty"`
	Status                      AddonStatus                      `json:"status,omitempty"`
	apiRequest                  `json:"-" form:"-"`
}

func (r *AddonCreateRequest) payload() any { return r }

type AddonCreateTier struct {
	StartingUnit          *int32 `json:"starting_unit,omitempty"`
	EndingUnit            *int32 `json:"ending_unit,omitempty"`
	Price                 *int64 `json:"price,omitempty"`
	StartingUnitInDecimal string `json:"starting_unit_in_decimal,omitempty"`
	EndingUnitInDecimal   string `json:"ending_unit_in_decimal,omitempty"`
	PriceInDecimal        string `json:"price_in_decimal,omitempty"`
}

type AddonCreateTaxProvidersField struct {
	ProviderName string `json:"provider_name"`
	FieldId      string `json:"field_id"`
	FieldValue   string `json:"field_value"`
}

type AddonUpdateRequest struct {
	Name                        string                           `json:"name,omitempty"`
	InvoiceName                 string                           `json:"invoice_name,omitempty"`
	Description                 string                           `json:"description,omitempty"`
	ChargeType                  AddonChargeType                  `json:"charge_type,omitempty"`
	Price                       *int64                           `json:"price,omitempty"`
	Tiers                       []*AddonUpdateTier               `json:"tiers,omitempty"`
	CurrencyCode                string                           `json:"currency_code,omitempty"`
	Period                      *int32                           `json:"period,omitempty"`
	PeriodUnit                  AddonPeriodUnit                  `json:"period_unit,omitempty"`
	PricingModel                PricingModel                     `json:"pricing_model,omitempty"`
	Unit                        string                           `json:"unit,omitempty"`
	EnabledInPortal             *bool                            `json:"enabled_in_portal,omitempty"`
	Taxable                     *bool                            `json:"taxable,omitempty"`
	TaxProfileId                string                           `json:"tax_profile_id,omitempty"`
	AvalaraSaleType             AvalaraSaleType                  `json:"avalara_sale_type,omitempty"`
	AvalaraTransactionType      *int32                           `json:"avalara_transaction_type,omitempty"`
	AvalaraServiceType          *int32                           `json:"avalara_service_type,omitempty"`
	TaxCode                     string                           `json:"tax_code,omitempty"`
	HsnCode                     string                           `json:"hsn_code,omitempty"`
	TaxjarProductCode           string                           `json:"taxjar_product_code,omitempty"`
	InvoiceNotes                string                           `json:"invoice_notes,omitempty"`
	MetaData                    map[string]interface{}           `json:"meta_data,omitempty"`
	Sku                         string                           `json:"sku,omitempty"`
	AccountingCode              string                           `json:"accounting_code,omitempty"`
	AccountingCategory1         string                           `json:"accounting_category1,omitempty"`
	AccountingCategory2         string                           `json:"accounting_category2,omitempty"`
	AccountingCategory3         string                           `json:"accounting_category3,omitempty"`
	AccountingCategory4         string                           `json:"accounting_category4,omitempty"`
	IsShippable                 *bool                            `json:"is_shippable,omitempty"`
	ShippingFrequencyPeriod     *int32                           `json:"shipping_frequency_period,omitempty"`
	ShippingFrequencyPeriodUnit AddonShippingFrequencyPeriodUnit `json:"shipping_frequency_period_unit,omitempty"`
	IncludedInMrr               *bool                            `json:"included_in_mrr,omitempty"`
	ShowDescriptionInInvoices   *bool                            `json:"show_description_in_invoices,omitempty"`
	ShowDescriptionInQuotes     *bool                            `json:"show_description_in_quotes,omitempty"`
	PriceInDecimal              string                           `json:"price_in_decimal,omitempty"`
	TaxProvidersFields          []*AddonUpdateTaxProvidersField  `json:"tax_providers_fields,omitempty"`
	ProrationType               AddonProrationType               `json:"proration_type,omitempty"`
	apiRequest                  `json:"-" form:"-"`
}

func (r *AddonUpdateRequest) payload() any { return r }

type AddonUpdateTier struct {
	StartingUnit          *int32 `json:"starting_unit,omitempty"`
	EndingUnit            *int32 `json:"ending_unit,omitempty"`
	Price                 *int64 `json:"price,omitempty"`
	StartingUnitInDecimal string `json:"starting_unit_in_decimal,omitempty"`
	EndingUnitInDecimal   string `json:"ending_unit_in_decimal,omitempty"`
	PriceInDecimal        string `json:"price_in_decimal,omitempty"`
}

type AddonUpdateTaxProvidersField struct {
	ProviderName string `json:"provider_name"`
	FieldId      string `json:"field_id"`
	FieldValue   string `json:"field_value"`
}

type AddonListRequest struct {
	Limit          *int32           `json:"limit,omitempty"`
	Offset         string           `json:"offset,omitempty"`
	Id             *StringFilter    `json:"id,omitempty"`
	Name           *StringFilter    `json:"name,omitempty"`
	PricingModel   *EnumFilter      `json:"pricing_model,omitempty"`
	ChargeType     *EnumFilter      `json:"charge_type,omitempty"`
	Price          *NumberFilter    `json:"price,omitempty"`
	Period         *NumberFilter    `json:"period,omitempty"`
	PeriodUnit     *EnumFilter      `json:"period_unit,omitempty"`
	Status         *EnumFilter      `json:"status,omitempty"`
	UpdatedAt      *TimestampFilter `json:"updated_at,omitempty"`
	CurrencyCode   *StringFilter    `json:"currency_code,omitempty"`
	Channel        *EnumFilter      `json:"channel,omitempty"`
	IncludeDeleted *bool            `json:"include_deleted,omitempty"`
	apiRequest     `json:"-" form:"-"`
}

func (r *AddonListRequest) payload() any { return r }

type AddonRetrieveRequest struct {
	Id         string `json:"-" form:"-"`
	apiRequest `json:"-" form:"-"`
}

func (r *AddonRetrieveRequest) payload() any { return r }

type AddonDeleteRequest struct {
	Id         string `json:"-" form:"-"`
	apiRequest `json:"-" form:"-"`
}

func (r *AddonDeleteRequest) payload() any { return r }

type AddonCopyRequest struct {
	FromSite       string `json:"from_site"`
	IdAtFromSite   string `json:"id_at_from_site"`
	Id             string `json:"id,omitempty"`
	ForSiteMerging *bool  `json:"for_site_merging,omitempty"`
	apiRequest     `json:"-" form:"-"`
}

func (r *AddonCopyRequest) payload() any { return r }

type AddonUnarchiveRequest struct {
	Id         string `json:"-" form:"-"`
	apiRequest `json:"-" form:"-"`
}

func (r *AddonUnarchiveRequest) payload() any { return r }

type AddonCreateResponse struct {
	Addon *Addon `json:"addon,omitempty"`
	apiResponse
}

type AddonUpdateResponse struct {
	Addon *Addon `json:"addon,omitempty"`
	apiResponse
}

type AddonListAddonResponse struct {
	Addon *Addon `json:"addon,omitempty"`
}

type AddonListResponse struct {
	List       []*AddonListAddonResponse `json:"list,omitempty"`
	NextOffset string                    `json:"next_offset,omitempty"`
	apiResponse
}

type AddonRetrieveResponse struct {
	Addon *Addon `json:"addon,omitempty"`
	apiResponse
}

type AddonDeleteResponse struct {
	Addon *Addon `json:"addon,omitempty"`
	apiResponse
}

type AddonCopyResponse struct {
	Addon *Addon `json:"addon,omitempty"`
	apiResponse
}

type AddonUnarchiveResponse struct {
	Addon *Addon `json:"addon,omitempty"`
	apiResponse
}