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

Generated Latest Changes for v2021-02-25 #709

Open
wants to merge 1 commit into
base: v3-v2021-02-25
Choose a base branch
from
Open
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
66 changes: 60 additions & 6 deletions openapi/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6265,8 +6265,7 @@ paths:
schema:
"$ref": "#/components/schemas/UniqueCouponCodeParams"
'400':
description: Invalid or unpermitted parameter; perhaps you tried to generate
more than 200 codes at a time?
description: Invalid or unpermitted parameter.
content:
application/json:
schema:
Expand Down Expand Up @@ -6348,6 +6347,7 @@ paths:
- "$ref": "#/components/parameters/sort_dates"
- "$ref": "#/components/parameters/filter_begin_time"
- "$ref": "#/components/parameters/filter_end_time"
- "$ref": "#/components/parameters/filter_redeemed"
responses:
'200':
description: A list of unique coupon codes that were generated
Expand Down Expand Up @@ -17184,6 +17184,13 @@ components:
- `type=legacy`, only legacy invoices will be returned.
schema:
"$ref": "#/components/schemas/FilterInvoiceTypeEnum"
filter_redeemed:
name: redeemed
in: query
description: Filter unique coupon codes by redemption status. `true` for redeemed,
`false` for not redeemed.
schema:
"$ref": "#/components/schemas/FilterRedeemedEnum"
export_date:
name: export_date
in: path
Expand Down Expand Up @@ -18733,6 +18740,12 @@ components:
description: The `backup_payment_method` field is used to indicate a billing
info as a backup on the account that will be tried if the initial billing
info used for an invoice is declined.
payment_gateway_references:
type: array
description: Array of Payment Gateway References, each a reference to a
third-party gateway object of varying types.
items:
"$ref": "#/components/schemas/PaymentGatewayReferences"
created_at:
type: string
format: date-time
Expand Down Expand Up @@ -18815,9 +18828,21 @@ components:
maxLength: 50
gateway_code:
type: string
title: An identifier for a specific payment gateway. Must be used in conjunction
with `gateway_token`.
title: An identifier for a specific payment gateway.
maxLength: 12
payment_gateway_references:
type: array
description: Array of Payment Gateway References, each a reference to a
third-party gateway object of varying types.
items:
"$ref": "#/components/schemas/PaymentGatewayReferences"
properties:
token:
type: strings
maxLength: 50
reference_type:
type: string
"$ref": "#/components/schemas/PaymentGatewayReferencesEnum"
gateway_attributes:
type: object
description: Additional attributes to send to the gateway.
Expand Down Expand Up @@ -19282,9 +19307,9 @@ components:
number_of_unique_codes:
type: integer
title: Number of unique codes
description: The quantity of unique coupon codes to generate
description: The quantity of unique coupon codes to generate. A bulk coupon
can have up to 100,000 unique codes (or your site's configured limit).
minimum: 1
maximum: 200
CouponMini:
type: object
properties:
Expand Down Expand Up @@ -21285,6 +21310,22 @@ components:
- currency
- unit_amount
- type
PaymentGatewayReferences:
type: object
title: Payment Gateway References Object
description: Array of Payment Gateway References, each a reference to a third-party
gateway object of varying types.
properties:
token:
type: string
title: Token
description: Reference value used when the external token was created. If
Stripe gateway is used, this value will need to be accompanied by its
reference_type.
reference_type:
type: string
title: Reference Type
"$ref": "#/components/schemas/PaymentGatewayReferencesEnum"
PlanMini:
type: object
title: Plan mini details
Expand Down Expand Up @@ -26430,6 +26471,11 @@ components:
- credit
- legacy
- non-legacy
FilterRedeemedEnum:
type: string
enum:
- true
- false
ChannelEnum:
type: string
enum:
Expand Down Expand Up @@ -26491,6 +26537,14 @@ components:
enum:
- email
- post
PaymentGatewayReferencesEnum:
type: string
description: The type of reference token. Required if token is passed in for
Stripe Gateway.
enum:
- stripe_confirmation_token
- stripe_customer
- stripe_payment_method
GatewayTransactionTypeEnum:
type: string
enum:
Expand Down
2 changes: 2 additions & 0 deletions recurly/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1881,6 +1881,8 @@ def list_unique_coupon_codes(self, coupon_id, **options):
params.end_time : datetime
Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
params.redeemed : str
Filter unique coupon codes by redemption status. `true` for redeemed, `false` for not redeemed.
Returns
-------
Expand Down
19 changes: 19 additions & 0 deletions recurly/resources.py
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,8 @@ class BillingInfo(Resource):
last_name : str
object : str
Object type
payment_gateway_references : :obj:`list` of :obj:`PaymentGatewayReferences`
Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.
payment_method : PaymentMethod
primary_payment_method : bool
The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
Expand All @@ -357,6 +359,7 @@ class BillingInfo(Resource):
"id": str,
"last_name": str,
"object": str,
"payment_gateway_references": ["PaymentGatewayReferences"],
"payment_method": "PaymentMethod",
"primary_payment_method": bool,
"updated_at": datetime,
Expand Down Expand Up @@ -461,6 +464,22 @@ class FraudInfo(Resource):
}


class PaymentGatewayReferences(Resource):
"""
Attributes
----------
reference_type : str
The type of reference token. Required if token is passed in for Stripe Gateway.
token : str
Reference value used when the external token was created. If Stripe gateway is used, this value will need to be accompanied by its reference_type.
"""

schema = {
"reference_type": str,
"token": str,
}


class BillingInfoUpdatedBy(Resource):
"""
Attributes
Expand Down
Loading