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

Latest Features #118

Merged
merged 1 commit into from
May 30, 2020
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
15 changes: 14 additions & 1 deletion lib/recurly.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,10 @@ export interface PaymentMethod {
* Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
*/
billingAgreementId: string | null;
/**
* The name associated with the bank account.
*/
nameOnAccount: string | null;
/**
* The bank account type. Only present for ACH payment methods.
*/
Expand Down Expand Up @@ -1290,7 +1294,7 @@ export interface LineItem {
*/
accountingCode: string | null;
/**
* For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line itmes it will be the item's `external_sku`.
* For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line items it will be the item's `external_sku`.
*/
productCode: string | null;
/**
Expand Down Expand Up @@ -1774,6 +1778,10 @@ export interface SubscriptionAddOn {
* This is priced in the subscription's currency.
*/
unitAmount: number | null;
/**
* Revenue schedule type
*/
revenueScheduleType: string | null;
/**
* The type of tiering used by the Add-on.
*/
Expand Down Expand Up @@ -2291,6 +2299,10 @@ export interface ShippingMethod {
* The name of the shipping method displayed to customers.
*/
name: string | null;
/**
* Accounting code for shipping method.
*/
accountingCode: string | null;
/**
* Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
*/
Expand Down Expand Up @@ -2356,6 +2368,7 @@ export declare class Client {
* order. In descending order updated records will move behind the cursor and could
* prevent some records from being returned.
*
* @param params.state - Filter by state.
* @return {Pager<Site>} A list of sites.
*/
listSites(params?: object): Pager<Site>;
Expand Down
1 change: 1 addition & 0 deletions lib/recurly/Client.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ class Client extends BaseClient {
* order. In descending order updated records will move behind the cursor and could
* prevent some records from being returned.
*
* @param {string} options.params.state - Filter by state.
* @return {Pager<Site>} A list of sites.
*/
listSites (options = {}) {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/resources/LineItem.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const Resource = require('../Resource')
* @prop {string} planCode - If the line item is a charge or credit for a plan or add-on, this is the plan's code.
* @prop {string} planId - If the line item is a charge or credit for a plan or add-on, this is the plan's ID.
* @prop {string} previousLineItemId - Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
* @prop {string} productCode - For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line itmes it will be the item's `external_sku`.
* @prop {string} productCode - For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line items it will be the item's `external_sku`.
* @prop {number} prorationRate - 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.
* @prop {number} quantity - This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
* @prop {boolean} refund - Refund?
Expand Down
2 changes: 2 additions & 0 deletions lib/recurly/resources/PaymentMethod.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const Resource = require('../Resource')
* @prop {string} gatewayToken - A token used in place of a credit card in order to perform transactions.
* @prop {string} lastFour - Credit card number's last four digits. Will refer to bank account if payment method is ACH.
* @prop {string} lastTwo - The IBAN bank account's last two digits.
* @prop {string} nameOnAccount - The name associated with the bank account.
* @prop {string} object
* @prop {string} routingNumber - The bank account's routing number. Only present for ACH payment methods.
* @prop {string} routingNumberBank - The bank name of this routing number.
Expand All @@ -39,6 +40,7 @@ class PaymentMethod extends Resource {
gatewayToken: String,
lastFour: String,
lastTwo: String,
nameOnAccount: String,
object: String,
routingNumber: String,
routingNumberBank: String
Expand Down
2 changes: 2 additions & 0 deletions lib/recurly/resources/ShippingMethod.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const Resource = require('../Resource')
/**
* ShippingMethod
* @typedef {Object} ShippingMethod
* @prop {string} accountingCode - Accounting code for shipping method.
* @prop {string} code - The internal name used identify the shipping method.
* @prop {Date} createdAt - Created at
* @prop {Date} deletedAt - Deleted at
Expand All @@ -24,6 +25,7 @@ const Resource = require('../Resource')
class ShippingMethod extends Resource {
static getSchema () {
return {
accountingCode: String,
code: String,
createdAt: Date,
deletedAt: Date,
Expand Down
2 changes: 2 additions & 0 deletions lib/recurly/resources/SubscriptionAddOn.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const Resource = require('../Resource')
* @prop {string} id - Subscription Add-on ID
* @prop {string} object - Object type
* @prop {number} quantity - Add-on quantity
* @prop {string} revenueScheduleType - Revenue schedule type
* @prop {string} subscriptionId - Subscription ID
* @prop {string} tierType - The type of tiering used by the Add-on.
* @prop {Array.<SubscriptionAddOnTier>} tiers - Empty unless `tier_type` is `tiered`, `volume`, or `stairstep`.
Expand All @@ -33,6 +34,7 @@ class SubscriptionAddOn extends Resource {
id: String,
object: String,
quantity: Number,
revenueScheduleType: String,
subscriptionId: String,
tierType: String,
tiers: ['SubscriptionAddOnTier'],
Expand Down
Loading