Generated Latest Changes for v2021-02-25 (External Payment Phases)

client_operations.go

@@ -450,6 +450,11 @@ type ClientInterface interface {
 	ShowExternalInvoice(externalInvoiceId string, opts ...Option) (*ExternalInvoice, error)
 	ShowExternalInvoiceWithContext(ctx context.Context, externalInvoiceId string, opts ...Option) (*ExternalInvoice, error)
 
+	ListExternalSubscriptionExternalPaymentPhases(externalSubscriptionId string, params *ListExternalSubscriptionExternalPaymentPhasesParams, opts ...Option) (ExternalPaymentPhaseLister, error)
+
+	GetExternalSubscriptionExternalPaymentPhase(externalSubscriptionId string, externalPaymentPhaseId string, opts ...Option) (*ExternalPaymentPhase, error)
+	GetExternalSubscriptionExternalPaymentPhaseWithContext(ctx context.Context, externalSubscriptionId string, externalPaymentPhaseId string, opts ...Option) (*ExternalPaymentPhase, error)
+
 	ListEntitlements(accountId string, params *ListEntitlementsParams, opts ...Option) (EntitlementsLister, error)
 
 	ListAccountExternalSubscriptions(accountId string, params *ListAccountExternalSubscriptionsParams, opts ...Option) (ExternalSubscriptionLister, error)
@@ -6999,6 +7004,82 @@ func (c *Client) showExternalInvoice(ctx context.Context, externalInvoiceId stri
 	return result, err
 }
 
+type ListExternalSubscriptionExternalPaymentPhasesParams struct {
+
+	// Sort - Sort field. You *really* only want to sort by `updated_at` in ascending
+	// order. In descending order updated records will move behind the cursor and could
+	// prevent some records from being returned.
+	Sort *string
+
+	// Limit - Limit number of records 1-200.
+	Limit *int
+
+	// Order - Sort order.
+	Order *string
+}
+
+func (list *ListExternalSubscriptionExternalPaymentPhasesParams) URLParams() []KeyValue {
+	var options []KeyValue
+
+	if list.Sort != nil {
+		options = append(options, KeyValue{Key: "sort", Value: *list.Sort})
+	}
+
+	if list.Limit != nil {
+		options = append(options, KeyValue{Key: "limit", Value: strconv.Itoa(*list.Limit)})
+	}
+
+	if list.Order != nil {
+		options = append(options, KeyValue{Key: "order", Value: *list.Order})
+	}
+
+	return options
+}
+
+// ListExternalSubscriptionExternalPaymentPhases List the external payment phases on an external subscription
+//
+// API Documentation: https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscription_external_payment_phases
+//
+// Returns: A list of the the external_payment_phases on a site.
+func (c *Client) ListExternalSubscriptionExternalPaymentPhases(externalSubscriptionId string, params *ListExternalSubscriptionExternalPaymentPhasesParams, opts ...Option) (ExternalPaymentPhaseLister, error) {
+	path, err := c.InterpolatePath("/external_subscriptions/{external_subscription_id}/external_payment_phases", externalSubscriptionId)
+	if err != nil {
+		return nil, err
+	}
+	requestOptions := NewRequestOptions(opts...)
+	path = BuildURL(path, params)
+	return NewExternalPaymentPhaseList(c, path, requestOptions), nil
+}
+
+// GetExternalSubscriptionExternalPaymentPhase wraps GetExternalSubscriptionExternalPaymentPhaseWithContext using the background context
+func (c *Client) GetExternalSubscriptionExternalPaymentPhase(externalSubscriptionId string, externalPaymentPhaseId string, opts ...Option) (*ExternalPaymentPhase, error) {
+	ctx := context.Background()
+	return c.getExternalSubscriptionExternalPaymentPhase(ctx, externalSubscriptionId, externalPaymentPhaseId, opts...)
+}
+
+// GetExternalSubscriptionExternalPaymentPhaseWithContext Fetch an external payment_phase
+//
+// API Documentation: https://developers.recurly.com/api/v2021-02-25#operation/get_external_subscription_external_payment_phase
+//
+// Returns: Details for an external payment_phase.
+func (c *Client) GetExternalSubscriptionExternalPaymentPhaseWithContext(ctx context.Context, externalSubscriptionId string, externalPaymentPhaseId string, opts ...Option) (*ExternalPaymentPhase, error) {
+	return c.getExternalSubscriptionExternalPaymentPhase(ctx, externalSubscriptionId, externalPaymentPhaseId, opts...)
+}
+
+func (c *Client) getExternalSubscriptionExternalPaymentPhase(ctx context.Context, externalSubscriptionId string, externalPaymentPhaseId string, opts ...Option) (*ExternalPaymentPhase, error) {
+	path, err := c.InterpolatePath("/external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id}", externalSubscriptionId, externalPaymentPhaseId)
+	if err != nil {
+		return nil, err
+	}
+	requestOptions := NewRequestOptions(opts...)
+	result := &ExternalPaymentPhase{}
+	err = c.Call(ctx, http.MethodGet, path, nil, nil, requestOptions, result)
+	if err != nil {
+		return nil, err
+	}
+	return result, err
+}
+
 type ListEntitlementsParams struct {
 
 	// State - Filter the entitlements based on the state of the applicable subscription.

external_payment_phase.go

@@ -0,0 +1,162 @@
+// This file is automatically created by Recurly's OpenAPI generation process
+// and thus any edits you make by hand will be lost. If you wish to make a
+// change to this file, please create a Github issue explaining the changes you
+// need and we will usher them to the appropriate places.
+package recurly
+
+import (
+	"context"
+	"net/http"
+	"time"
+)
+
+type ExternalPaymentPhase struct {
+	recurlyResponse *ResponseMetadata
+
+	// System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`.
+	Id string `json:"id,omitempty"`
+
+	// Object type
+	Object string `json:"object,omitempty"`
+
+	// Subscription from an external resource such as Apple App Store or Google Play Store.
+	ExternalSubscription ExternalSubscription `json:"external_subscription,omitempty"`
+
+	// Started At
+	StartedAt time.Time `json:"started_at,omitempty"`
+
+	// Ends At
+	EndsAt time.Time `json:"ends_at,omitempty"`
+
+	// Starting Billing Period Index
+	StartingBillingPeriodIndex int `json:"starting_billing_period_index,omitempty"`
+
+	// Ending Billing Period Index
+	EndingBillingPeriodIndex int `json:"ending_billing_period_index,omitempty"`
+
+	// Type of discount offer given, e.g. "FREE_TRIAL"
+	OfferType string `json:"offer_type,omitempty"`
+
+	// Name of the discount offer given, e.g. "introductory"
+	OfferName string `json:"offer_name,omitempty"`
+
+	// Number of billing periods
+	PeriodCount int `json:"period_count,omitempty"`
+
+	// Billing cycle length
+	PeriodLength string `json:"period_length,omitempty"`
+
+	// Allows up to 9 decimal places
+	Amount string `json:"amount,omitempty"`
+
+	// 3-letter ISO 4217 currency code.
+	Currency string `json:"currency,omitempty"`
+
+	// When the external subscription was created in Recurly.
+	CreatedAt time.Time `json:"created_at,omitempty"`
+
+	// When the external subscription was updated in Recurly.
+	UpdatedAt time.Time `json:"updated_at,omitempty"`
+}
+
+// GetResponse returns the ResponseMetadata that generated this resource
+func (resource *ExternalPaymentPhase) GetResponse() *ResponseMetadata {
+	return resource.recurlyResponse
+}
+
+// setResponse sets the ResponseMetadata that generated this resource
+func (resource *ExternalPaymentPhase) setResponse(res *ResponseMetadata) {
+	resource.recurlyResponse = res
+}
+
+// internal struct for deserializing accounts
+type externalPaymentPhaseList struct {
+	ListMetadata
+	Data            []ExternalPaymentPhase `json:"data"`
+	recurlyResponse *ResponseMetadata
+}
+
+// GetResponse returns the ResponseMetadata that generated this resource
+func (resource *externalPaymentPhaseList) GetResponse() *ResponseMetadata {
+	return resource.recurlyResponse
+}
+
+// setResponse sets the ResponseMetadata that generated this resource
+func (resource *externalPaymentPhaseList) setResponse(res *ResponseMetadata) {
+	resource.recurlyResponse = res
+}
+
+// ExternalPaymentPhaseList allows you to paginate ExternalPaymentPhase objects
+type ExternalPaymentPhaseList struct {
+	client         HTTPCaller
+	requestOptions *RequestOptions
+	nextPagePath   string
+	hasMore        bool
+	data           []ExternalPaymentPhase
+}
+
+func NewExternalPaymentPhaseList(client HTTPCaller, nextPagePath string, requestOptions *RequestOptions) *ExternalPaymentPhaseList {
+	return &ExternalPaymentPhaseList{
+		client:         client,
+		requestOptions: requestOptions,
+		nextPagePath:   nextPagePath,
+		hasMore:        true,
+	}
+}
+
+type ExternalPaymentPhaseLister interface {
+	Fetch() error
+	FetchWithContext(ctx context.Context) error
+	Count() (*int64, error)
+	CountWithContext(ctx context.Context) (*int64, error)
+	Data() []ExternalPaymentPhase
+	HasMore() bool
+	Next() string
+}
+
+func (list *ExternalPaymentPhaseList) HasMore() bool {
+	return list.hasMore
+}
+
+func (list *ExternalPaymentPhaseList) Next() string {
+	return list.nextPagePath
+}
+
+func (list *ExternalPaymentPhaseList) Data() []ExternalPaymentPhase {
+	return list.data
+}
+
+// Fetch fetches the next page of data into the `Data` property
+func (list *ExternalPaymentPhaseList) FetchWithContext(ctx context.Context) error {
+	resources := &externalPaymentPhaseList{}
+	err := list.client.Call(ctx, http.MethodGet, list.nextPagePath, nil, nil, list.requestOptions, resources)
+	if err != nil {
+		return err
+	}
+	// copy over properties from the response
+	list.nextPagePath = resources.Next
+	list.hasMore = resources.HasMore
+	list.data = resources.Data
+	return nil
+}
+
+// Fetch fetches the next page of data into the `Data` property
+func (list *ExternalPaymentPhaseList) Fetch() error {
+	return list.FetchWithContext(context.Background())
+}
+
+// Count returns the count of items on the server that match this pager
+func (list *ExternalPaymentPhaseList) CountWithContext(ctx context.Context) (*int64, error) {
+	resources := &externalPaymentPhaseList{}
+	err := list.client.Call(ctx, http.MethodHead, list.nextPagePath, nil, nil, list.requestOptions, resources)
+	if err != nil {
+		return nil, err
+	}
+	resp := resources.GetResponse()
+	return resp.TotalRecords, nil
+}
+
+// Count returns the count of items on the server that match this pager
+func (list *ExternalPaymentPhaseList) Count() (*int64, error) {
+	return list.CountWithContext(context.Background())
+}

invoice.go

@@ -99,7 +99,7 @@ type Invoice struct {
 	// The outstanding balance remaining on this invoice.
 	Balance float64 `json:"balance,omitempty"`
 
-	// Tax info
+	// Only for merchants using Recurly's In-The-Box taxes.
 	TaxInfo TaxInfo `json:"tax_info,omitempty"`
 
 	// Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.

line_item.go

@@ -140,7 +140,7 @@ type LineItem struct {
 	// Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
 	TaxCode string `json:"tax_code,omitempty"`
 
-	// Tax info
+	// Only for merchants using Recurly's In-The-Box taxes.
 	TaxInfo TaxInfo `json:"tax_info,omitempty"`
 
 	// When a line item has been prorated, this is the rate of the proration. Proration rates were made available for line items created after March 30, 2017. For line items created prior to that date, the proration rate will be `null`, even if the line item was prorated.