Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add invoice state param for v2021-02-25 #823

Merged
merged 1 commit into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions Recurly/Constants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -833,6 +833,24 @@ public enum InvoiceState

};

public enum InvoiceStateQueryParam
{
Undefined = 0,

[EnumMember(Value = "pending")]
Pending,

[EnumMember(Value = "past_due")]
PastDue,

[EnumMember(Value = "paid")]
Paid,

[EnumMember(Value = "failed")]
Failed,

};

public enum CollectionMethod
{
Undefined = 0,
Expand Down
4 changes: 4 additions & 0 deletions Recurly/IClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,7 @@ public interface IClient
/// </summary>
/// <param name="accountId">Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.</param>
/// <param name="ids">Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself. </param>
/// <param name="state">Invoice state.</param>
/// <param name="limit">Limit number of records 1-200.</param>
/// <param name="order">Sort order.</param>
/// <param name="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. </param>
Expand Down Expand Up @@ -1643,6 +1644,7 @@ public interface IClient
/// List a site's invoices <see href="https://developers.recurly.com/api/v2021-02-25#operation/list_invoices">list_invoices api documentation</see>
/// </summary>
/// <param name="ids">Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself. </param>
/// <param name="state">Invoice state.</param>
/// <param name="limit">Limit number of records 1-200.</param>
/// <param name="order">Sort order.</param>
/// <param name="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. </param>
Expand Down Expand Up @@ -2633,6 +2635,7 @@ public interface IClient
/// </summary>
/// <param name="subscriptionId">Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.</param>
/// <param name="ids">Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself. </param>
/// <param name="state">Invoice state.</param>
/// <param name="limit">Limit number of records 1-200.</param>
/// <param name="order">Sort order.</param>
/// <param name="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. </param>
Expand Down Expand Up @@ -3273,6 +3276,7 @@ public interface IClient
/// </summary>
/// <param name="businessEntityId">Business Entity ID. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-entity1`.</param>
/// <param name="ids">Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself. </param>
/// <param name="state">Invoice state.</param>
/// <param name="limit">Limit number of records 1-200.</param>
/// <param name="order">Sort order.</param>
/// <param name="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. </param>
Expand Down
4 changes: 4 additions & 0 deletions Recurly/Resources/ListAccountInvoicesParams.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ public class ListAccountInvoicesParams : OptionalParams
[JsonProperty("ids")]
public IList<string> Ids { get; set; }

/// <value>Invoice state.</value>
[JsonProperty("state")]
public Constants.InvoiceStateQueryParam? State { get; set; }

/// <value>Limit number of records 1-200.</value>
[JsonProperty("limit")]
public int? Limit { get; set; }
Expand Down
4 changes: 4 additions & 0 deletions Recurly/Resources/ListBusinessEntityInvoicesParams.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ public class ListBusinessEntityInvoicesParams : OptionalParams
[JsonProperty("ids")]
public IList<string> Ids { get; set; }

/// <value>Invoice state.</value>
[JsonProperty("state")]
public Constants.InvoiceStateQueryParam? State { get; set; }

/// <value>Limit number of records 1-200.</value>
[JsonProperty("limit")]
public int? Limit { get; set; }
Expand Down
4 changes: 4 additions & 0 deletions Recurly/Resources/ListInvoicesParams.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ public class ListInvoicesParams : OptionalParams
[JsonProperty("ids")]
public IList<string> Ids { get; set; }

/// <value>Invoice state.</value>
[JsonProperty("state")]
public Constants.InvoiceStateQueryParam? State { get; set; }

/// <value>Limit number of records 1-200.</value>
[JsonProperty("limit")]
public int? Limit { get; set; }
Expand Down
4 changes: 4 additions & 0 deletions Recurly/Resources/ListSubscriptionInvoicesParams.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ public class ListSubscriptionInvoicesParams : OptionalParams
[JsonProperty("ids")]
public IList<string> Ids { get; set; }

/// <value>Invoice state.</value>
[JsonProperty("state")]
public Constants.InvoiceStateQueryParam? State { get; set; }

/// <value>Limit number of records 1-200.</value>
[JsonProperty("limit")]
public int? Limit { get; set; }
Expand Down
23 changes: 19 additions & 4 deletions openapi/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3521,6 +3521,7 @@ paths:
parameters:
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/invoice_state"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
- "$ref": "#/components/parameters/sort_dates"
Expand Down Expand Up @@ -8110,6 +8111,7 @@ paths:
to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/invoice_state"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
- "$ref": "#/components/parameters/sort_dates"
Expand Down Expand Up @@ -13909,6 +13911,7 @@ paths:
parameters:
- "$ref": "#/components/parameters/subscription_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/invoice_state"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
- "$ref": "#/components/parameters/sort_dates"
Expand Down Expand Up @@ -16282,6 +16285,7 @@ paths:
parameters:
- "$ref": "#/components/parameters/business_entity_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/invoice_state"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
- "$ref": "#/components/parameters/sort_dates"
Expand Down Expand Up @@ -16455,6 +16459,12 @@ components:
required: true
schema:
type: string
invoice_state:
name: state
in: query
description: Invoice state.
schema:
"$ref": "#/components/schemas/InvoiceStateQueryParamEnum"
measured_unit_id:
name: measured_unit_id
in: path
Expand Down Expand Up @@ -21069,7 +21079,6 @@ components:
title: Ending quantity
minimum: 1
maximum: 999999999
default:
description: Ending quantity for the tier. This represents a unit amount
for unit-priced add ons. Must be left empty if it is the final tier.
usage_percentage:
Expand Down Expand Up @@ -21106,7 +21115,6 @@ components:
title: Ending amount
minimum: 0.01
maximum: 9999999999999.99
default:
description: Ending amount for the tier. Allows up to 2 decimal places.
Must be left empty if it is the final tier.
usage_percentage:
Expand Down Expand Up @@ -22070,7 +22078,6 @@ components:
title: Ending quantity
minimum: 1
maximum: 999999999
default:
description: Ending quantity for the tier. This represents a unit amount
for unit-priced add ons. Must be left empty if it is the final tier.
unit_amount:
Expand Down Expand Up @@ -22103,7 +22110,6 @@ components:
title: Ending amount
minimum: 1
maximum: 9999999999999.99
default:
description: Ending amount for the tier. Allows up to 2 decimal places.
Must be left empty if it is the final tier.
usage_percentage:
Expand Down Expand Up @@ -25193,6 +25199,7 @@ components:
- write_off
InvoiceStateEnum:
type: string
default: all
enum:
- open
- pending
Expand All @@ -25202,6 +25209,14 @@ components:
- closed
- failed
- voided
InvoiceStateQueryParamEnum:
type: string
default: all
enum:
- pending
- past_due
- paid
- failed
CollectionMethodEnum:
type: string
enum:
Expand Down
Loading