From c3945ae55c905cbd2db20aeb71c81bf7b1860485 Mon Sep 17 00:00:00 2001 From: Recurly Integrations Date: Wed, 6 Dec 2023 16:42:38 +0000 Subject: [PATCH] Generated Latest Changes for v2021-02-25 --- client_operations.go | 81 ++++++++++++++++++ external_payment_phase.go | 162 ++++++++++++++++++++++++++++++++++++ invoice.go | 2 +- line_item.go | 2 +- openapi/api.yaml | 168 ++++++++++++++++++++++++++++++++++++++ scripts/clean | 1 + subscription.go | 4 +- subscription_create.go | 3 + 8 files changed, 419 insertions(+), 4 deletions(-) create mode 100644 external_payment_phase.go diff --git a/client_operations.go b/client_operations.go index a311616..b54bf0f 100644 --- a/client_operations.go +++ b/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. diff --git a/external_payment_phase.go b/external_payment_phase.go new file mode 100644 index 0000000..c976eb7 --- /dev/null +++ b/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()) +} diff --git a/invoice.go b/invoice.go index 60223d6..0ce83da 100644 --- a/invoice.go +++ b/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. diff --git a/line_item.go b/line_item.go index 55a89a9..21d423b 100644 --- a/line_item.go +++ b/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. diff --git a/openapi/api.yaml b/openapi/api.yaml index fe2608a..c9e015a 100644 --- a/openapi/api.yaml +++ b/openapi/api.yaml @@ -207,6 +207,7 @@ x-tagGroups: - external_products - external_accounts - external_product_references + - external_payment_phases - name: Products and Promotions tags: - item @@ -366,6 +367,11 @@ tags: x-displayName: External Product Reference description: Associates an external product to a corresponding resource on an external platform like the Apple App Store or Google Play Store. +- name: external_payment_phases + x-displayName: External Payment Phase + description: Details of payments in the lifecycle of a subscription from an external + resource that is not managed by the Recurly platform, e.g. App Store or Google + Play Store. - name: gift_cards x-displayName: Gift Cards description: Add gift card purchases to your checkout and allow gift card recipients @@ -15918,6 +15924,69 @@ paths: schema: "$ref": "#/components/schemas/Error" x-code-samples: [] + "/external_subscriptions/{external_subscription_id}/external_payment_phases": + parameters: + - "$ref": "#/components/parameters/external_subscription_id" + get: + tags: + - external_subscriptions + operationId: list_external_subscription_external_payment_phases + summary: List the external payment phases on an external subscription + description: See the [Pagination Guide](/developers/guides/pagination.html) + to learn how to use pagination in the API and Client Libraries. + parameters: + - "$ref": "#/components/parameters/sort_dates" + - "$ref": "#/components/parameters/limit" + - "$ref": "#/components/parameters/order" + responses: + '200': + description: A list of the the external_payment_phases on a site. + content: + application/json: + schema: + "$ref": "#/components/schemas/ExternalPaymentPhaseList" + '404': + description: Incorrect site. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + default: + description: Unexpected error. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] + "/external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id}": + parameters: + - "$ref": "#/components/parameters/external_subscription_id" + - "$ref": "#/components/parameters/external_payment_phase_id" + get: + tags: + - external_payment_phases + operationId: get_external_subscription_external_payment_phase + summary: Fetch an external payment_phase + responses: + '200': + description: Details for an external payment_phase. + content: + application/json: + schema: + "$ref": "#/components/schemas/ExternalPaymentPhase" + '404': + description: Incorrect site or external subscription ID. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + default: + description: Unexpected error. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] "/accounts/{account_id}/entitlements": parameters: - "$ref": "#/components/parameters/account_id" @@ -16355,6 +16424,13 @@ components: required: true schema: type: string + external_payment_phase_id: + name: external_payment_phase_id + in: path + description: External payment phase ID, e.g. `a34ypb2ef9w1`. + required: true + schema: + type: string invoice_template_id: name: invoice_template_id in: path @@ -21633,6 +21709,7 @@ components: type: number format: float title: Estimated tax + description: Only for merchants using Recurly's In-The-Box taxes. tax_info: "$ref": "#/components/schemas/TaxInfo" total: @@ -22464,6 +22541,12 @@ components: default: 0 net_terms_type: "$ref": "#/components/schemas/NetTermsTypeEnum" + gateway_code: + type: string + title: Gateway Code + description: If present, this subscription's transactions will use the payment + gateway with this code. + maxLength: 13 transaction_type: description: An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for @@ -22805,6 +22888,7 @@ components: TaxInfo: type: object title: Tax info + description: Only for merchants using Recurly's In-The-Box taxes. properties: type: type: string @@ -23646,6 +23730,90 @@ components: type: string format: date-time description: Time the object was last updated + ExternalPaymentPhase: + type: object + description: Details of payments in the lifecycle of a subscription from an + external resource that is not managed by the Recurly platform, e.g. App Store + or Google Play Store. + properties: + id: + type: string + title: External payment phase ID + description: System-generated unique identifier for an external payment + phase ID, e.g. `e28zov4fw0v2`. + object: + type: string + title: Object type + external_subscription: + "$ref": "#/components/schemas/ExternalSubscription" + started_at: + type: string + format: date-time + title: Started At + ends_at: + type: string + format: date-time + title: Ends At + starting_billing_period_index: + type: integer + title: Starting Billing Period Index + ending_billing_period_index: + type: integer + title: Ending Billing Period Index + offer_type: + type: string + title: Offer Type + description: Type of discount offer given, e.g. "FREE_TRIAL" + offer_name: + type: string + title: Offer Name + description: Name of the discount offer given, e.g. "introductory" + period_count: + type: integer + title: Period Count + description: Number of billing periods + period_length: + type: string + title: Period Length + description: Billing cycle length + amount: + type: string + format: decimal + title: Amount + minimum: 0 + description: Allows up to 9 decimal places + currency: + type: string + title: Currency + description: 3-letter ISO 4217 currency code. + maxLength: 3 + created_at: + type: string + format: date-time + title: Created at + description: When the external subscription was created in Recurly. + updated_at: + type: string + format: date-time + title: Updated at + description: When the external subscription was updated in Recurly. + ExternalPaymentPhaseList: + type: object + properties: + object: + type: string + title: Object type + description: Will always be List. + has_more: + type: boolean + description: Indicates there are more results on subsequent pages. + next: + type: string + description: Path to subsequent page of results. + data: + type: array + items: + "$ref": "#/components/schemas/ExternalPaymentPhase" ExternalProduct: type: object description: Product from an external resource such as Apple App Store or Google diff --git a/scripts/clean b/scripts/clean index 7f36adf..113a79d 100755 --- a/scripts/clean +++ b/scripts/clean @@ -85,6 +85,7 @@ rm -f dunning_cycle.go rm -f dunning_interval.go rm -f dunning_campaigns_bulk_update_response.go rm -f invoice_template.go +rm -f external_payment_phase.go rm -f entitlements.go rm -f entitlement.go rm -f customer_permission.go diff --git a/subscription.go b/subscription.go index 72d8bcf..a0194e8 100644 --- a/subscription.go +++ b/subscription.go @@ -103,10 +103,10 @@ type Subscription struct { // Estimated total, before tax. Subtotal float64 `json:"subtotal,omitempty"` - // Estimated tax + // Only for merchants using Recurly's In-The-Box taxes. Tax float64 `json:"tax,omitempty"` - // Tax info + // Only for merchants using Recurly's In-The-Box taxes. TaxInfo TaxInfo `json:"tax_info,omitempty"` // Estimated total diff --git a/subscription_create.go b/subscription_create.go index b020184..e16e078 100644 --- a/subscription_create.go +++ b/subscription_create.go @@ -103,6 +103,9 @@ type SubscriptionCreate struct { // This field is only available when the EOM Net Terms feature is enabled. NetTermsType *string `json:"net_terms_type,omitempty"` + // If present, this subscription's transactions will use the payment gateway with this code. + GatewayCode *string `json:"gateway_code,omitempty"` + // An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions. TransactionType *string `json:"transaction_type,omitempty"`