Skip to content

Commit

Permalink
Update generated code for v1255
Browse files Browse the repository at this point in the history
  • Loading branch information
stripe-openapi[bot] committed Sep 9, 2024
1 parent 627e44b commit 5029ad0
Show file tree
Hide file tree
Showing 8 changed files with 233 additions and 2 deletions.
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1253
v1255
4 changes: 4 additions & 0 deletions client/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ import (
"github.com/stripe/stripe-go/v79/invoiceitem"
"github.com/stripe/stripe-go/v79/invoicelineitem"
"github.com/stripe/stripe-go/v79/invoicepayment"
"github.com/stripe/stripe-go/v79/invoicerenderingtemplate"
issuingauthorization "github.com/stripe/stripe-go/v79/issuing/authorization"
issuingcard "github.com/stripe/stripe-go/v79/issuing/card"
issuingcardholder "github.com/stripe/stripe-go/v79/issuing/cardholder"
Expand Down Expand Up @@ -277,6 +278,8 @@ type API struct {
InvoiceLineItems *invoicelineitem.Client
// InvoicePayments is the client used to invoke /invoices/{invoice}/payments APIs.
InvoicePayments *invoicepayment.Client
// InvoiceRenderingTemplates is the client used to invoke /invoice_rendering_templates APIs.
InvoiceRenderingTemplates *invoicerenderingtemplate.Client
// Invoices is the client used to invoke /invoices APIs.
Invoices *invoice.Client
// IssuingAuthorizations is the client used to invoke /issuing/authorizations APIs.
Expand Down Expand Up @@ -532,6 +535,7 @@ func (a *API) Init(key string, backends *stripe.Backends) {
a.InvoiceItems = &invoiceitem.Client{B: backends.API, Key: key}
a.InvoiceLineItems = &invoicelineitem.Client{B: backends.API, Key: key}
a.InvoicePayments = &invoicepayment.Client{B: backends.API, Key: key}
a.InvoiceRenderingTemplates = &invoicerenderingtemplate.Client{B: backends.API, Key: key}
a.Invoices = &invoice.Client{B: backends.API, Key: key}
a.IssuingAuthorizations = &issuingauthorization.Client{B: backends.API, Key: key}
a.IssuingCardholders = &issuingcardholder.Client{B: backends.API, Key: key}
Expand Down
4 changes: 4 additions & 0 deletions customer.go
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ type CustomerInvoiceSettingsCustomFieldParams struct {
type CustomerInvoiceSettingsRenderingOptionsParams struct {
// How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
AmountTaxDisplay *string `form:"amount_tax_display"`
// ID of the invoice rendering template to use for future invoices.
Template *string `form:"template"`
}

// Default invoice settings for this customer.
Expand Down Expand Up @@ -295,6 +297,8 @@ type CustomerInvoiceSettingsCustomField struct {
type CustomerInvoiceSettingsRenderingOptions struct {
// How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
AmountTaxDisplay string `json:"amount_tax_display"`
// ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.
Template string `json:"template"`
}
type CustomerInvoiceSettings struct {
// Default custom fields to be displayed on invoices for this customer.
Expand Down
8 changes: 8 additions & 0 deletions invoice.go
Original file line number Diff line number Diff line change
Expand Up @@ -580,6 +580,10 @@ type InvoiceRenderingParams struct {
AmountTaxDisplay *string `form:"amount_tax_display"`
// Invoice pdf rendering options
PDF *InvoiceRenderingPDFParams `form:"pdf"`
// ID of the invoice rendering template to use for this invoice.
Template *string `form:"template"`
// The specific version of invoice rendering template to use for this invoice.
TemplateVersion *int64 `form:"template_version"`
}

// The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
Expand Down Expand Up @@ -4751,6 +4755,10 @@ type InvoiceRendering struct {
AmountTaxDisplay string `json:"amount_tax_display"`
// Invoice pdf rendering options
PDF *InvoiceRenderingPDF `json:"pdf"`
// ID of the rendering template that the invoice is formatted by.
Template string `json:"template"`
// Version of the rendering template that the invoice is using.
TemplateVersion int64 `json:"template_version"`
}

// The taxes applied to the shipping rate.
Expand Down
93 changes: 93 additions & 0 deletions invoicerenderingtemplate.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
//
//
// File generated from our OpenAPI spec
//
//

package stripe

// The status of the template, one of `active` or `archived`.
type InvoiceRenderingTemplateStatus string

// List of values that InvoiceRenderingTemplateStatus can take
const (
InvoiceRenderingTemplateStatusActive InvoiceRenderingTemplateStatus = "active"
InvoiceRenderingTemplateStatusArchived InvoiceRenderingTemplateStatus = "archived"
)

// List all templates, ordered by creation date, with the most recently created template appearing first.
type InvoiceRenderingTemplateListParams struct {
ListParams `form:"*"`
// Specifies which fields in the response should be expanded.
Expand []*string `form:"expand"`
Status *string `form:"status"`
}

// AddExpand appends a new field to expand.
func (p *InvoiceRenderingTemplateListParams) AddExpand(f string) {
p.Expand = append(p.Expand, &f)
}

// Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
type InvoiceRenderingTemplateParams struct {
Params `form:"*"`
// Specifies which fields in the response should be expanded.
Expand []*string `form:"expand"`
Version *int64 `form:"version"`
}

// AddExpand appends a new field to expand.
func (p *InvoiceRenderingTemplateParams) AddExpand(f string) {
p.Expand = append(p.Expand, &f)
}

// Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
type InvoiceRenderingTemplateArchiveParams struct {
Params `form:"*"`
// Specifies which fields in the response should be expanded.
Expand []*string `form:"expand"`
}

// AddExpand appends a new field to expand.
func (p *InvoiceRenderingTemplateArchiveParams) AddExpand(f string) {
p.Expand = append(p.Expand, &f)
}

// Unarchive an invoice rendering template so it can be used on new Stripe objects again.
type InvoiceRenderingTemplateUnarchiveParams struct {
Params `form:"*"`
// Specifies which fields in the response should be expanded.
Expand []*string `form:"expand"`
}

// AddExpand appends a new field to expand.
func (p *InvoiceRenderingTemplateUnarchiveParams) AddExpand(f string) {
p.Expand = append(p.Expand, &f)
}

type InvoiceRenderingTemplate struct {
APIResource
// Time at which the object was created. Measured in seconds since the Unix epoch.
Created int64 `json:"created"`
// Unique identifier for the object.
ID string `json:"id"`
// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Livemode bool `json:"livemode"`
// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Metadata map[string]string `json:"metadata"`
// A brief description of the template, hidden from customers
Nickname string `json:"nickname"`
// String representing the object's type. Objects of the same type share the same value.
Object string `json:"object"`
// The status of the template, one of `active` or `archived`.
Status InvoiceRenderingTemplateStatus `json:"status"`
// Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering
Version int64 `json:"version"`
}

// InvoiceRenderingTemplateList is a list of InvoiceRenderingTemplates as retrieved from a list endpoint.
type InvoiceRenderingTemplateList struct {
APIResource
ListMeta
Data []*InvoiceRenderingTemplate `json:"data"`
}
118 changes: 118 additions & 0 deletions invoicerenderingtemplate/client.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
//
//
// File generated from our OpenAPI spec
//
//

// Package invoicerenderingtemplate provides the /invoice_rendering_templates APIs
package invoicerenderingtemplate

import (
"net/http"

stripe "github.com/stripe/stripe-go/v79"
"github.com/stripe/stripe-go/v79/form"
)

// Client is used to invoke /invoice_rendering_templates APIs.
type Client struct {
B stripe.Backend
Key string
}

// Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
func Get(id string, params *stripe.InvoiceRenderingTemplateParams) (*stripe.InvoiceRenderingTemplate, error) {
return getC().Get(id, params)
}

// Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
func (c Client) Get(id string, params *stripe.InvoiceRenderingTemplateParams) (*stripe.InvoiceRenderingTemplate, error) {
path := stripe.FormatURLPath("/v1/invoice_rendering_templates/%s", id)
invoicerenderingtemplate := &stripe.InvoiceRenderingTemplate{}
err := c.B.Call(http.MethodGet, path, c.Key, params, invoicerenderingtemplate)
return invoicerenderingtemplate, err
}

// Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
func Archive(id string, params *stripe.InvoiceRenderingTemplateArchiveParams) (*stripe.InvoiceRenderingTemplate, error) {
return getC().Archive(id, params)
}

// Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
func (c Client) Archive(id string, params *stripe.InvoiceRenderingTemplateArchiveParams) (*stripe.InvoiceRenderingTemplate, error) {
path := stripe.FormatURLPath("/v1/invoice_rendering_templates/%s/archive", id)
invoicerenderingtemplate := &stripe.InvoiceRenderingTemplate{}
err := c.B.Call(
http.MethodPost,
path,
c.Key,
params,
invoicerenderingtemplate,
)
return invoicerenderingtemplate, err
}

// Unarchive an invoice rendering template so it can be used on new Stripe objects again.
func Unarchive(id string, params *stripe.InvoiceRenderingTemplateUnarchiveParams) (*stripe.InvoiceRenderingTemplate, error) {
return getC().Unarchive(id, params)
}

// Unarchive an invoice rendering template so it can be used on new Stripe objects again.
func (c Client) Unarchive(id string, params *stripe.InvoiceRenderingTemplateUnarchiveParams) (*stripe.InvoiceRenderingTemplate, error) {
path := stripe.FormatURLPath(
"/v1/invoice_rendering_templates/%s/unarchive",
id,
)
invoicerenderingtemplate := &stripe.InvoiceRenderingTemplate{}
err := c.B.Call(
http.MethodPost,
path,
c.Key,
params,
invoicerenderingtemplate,
)
return invoicerenderingtemplate, err
}

// List all templates, ordered by creation date, with the most recently created template appearing first.
func List(params *stripe.InvoiceRenderingTemplateListParams) *Iter {
return getC().List(params)
}

// List all templates, ordered by creation date, with the most recently created template appearing first.
func (c Client) List(listParams *stripe.InvoiceRenderingTemplateListParams) *Iter {
return &Iter{
Iter: stripe.GetIter(listParams, func(p *stripe.Params, b *form.Values) ([]interface{}, stripe.ListContainer, error) {
list := &stripe.InvoiceRenderingTemplateList{}
err := c.B.CallRaw(http.MethodGet, "/v1/invoice_rendering_templates", c.Key, b, p, list)

ret := make([]interface{}, len(list.Data))
for i, v := range list.Data {
ret[i] = v
}

return ret, list, err
}),
}
}

// Iter is an iterator for invoice rendering templates.
type Iter struct {
*stripe.Iter
}

// InvoiceRenderingTemplate returns the invoice rendering template which the iterator is currently pointing to.
func (i *Iter) InvoiceRenderingTemplate() *stripe.InvoiceRenderingTemplate {
return i.Current().(*stripe.InvoiceRenderingTemplate)
}

// InvoiceRenderingTemplateList returns the current list object which the iterator is
// currently using. List objects will change as new API calls are made to
// continue pagination.
func (i *Iter) InvoiceRenderingTemplateList() *stripe.InvoiceRenderingTemplateList {
return i.List().(*stripe.InvoiceRenderingTemplateList)
}

func getC() Client {
return Client{stripe.GetBackend(stripe.APIBackend), stripe.Key}
}
4 changes: 4 additions & 0 deletions quotepreviewinvoice.go
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,10 @@ type QuotePreviewInvoiceRendering struct {
AmountTaxDisplay string `json:"amount_tax_display"`
// Invoice pdf rendering options
PDF *QuotePreviewInvoiceRenderingPDF `json:"pdf"`
// ID of the rendering template that the invoice is formatted by.
Template string `json:"template"`
// Version of the rendering template that the invoice is using.
TemplateVersion int64 `json:"template_version"`
}

// The taxes applied to the shipping rate.
Expand Down
2 changes: 1 addition & 1 deletion terminal_location.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ type TerminalLocationParams struct {
Address *AddressParams `form:"address"`
// The ID of a configuration that will be used to customize all readers in this location.
ConfigurationOverrides *string `form:"configuration_overrides"`
// A name for the location.
// A name for the location. Maximum length is 1000 characters.
DisplayName *string `form:"display_name"`
// Specifies which fields in the response should be expanded.
Expand []*string `form:"expand"`
Expand Down

0 comments on commit 5029ad0

Please sign in to comment.