From a1a73c618d1f09095dacc9f208faf6701dc33898 Mon Sep 17 00:00:00 2001 From: Recurly Integrations Date: Wed, 8 Oct 2025 15:26:20 +0000 Subject: [PATCH] Generated Latest Changes for v2019-10-10 --- openapi/api.yaml | 334 ++++++++++++++---- src/main/java/com/recurly/v3/Client.java | 103 +++++- .../com/recurly/v3/requests/AddOnCreate.java | 30 +- .../com/recurly/v3/requests/AddOnUpdate.java | 30 +- .../v3/requests/BillingInfoCreate.java | 13 +- .../v3/requests/BillingInfoVerify.java | 24 ++ .../v3/requests/BillingInfoVerifyCVV.java | 92 +++++ .../com/recurly/v3/requests/ItemCreate.java | 21 +- .../com/recurly/v3/requests/ItemUpdate.java | 21 +- .../recurly/v3/requests/LineItemCreate.java | 24 +- .../com/recurly/v3/requests/PlanCreate.java | 24 +- .../com/recurly/v3/requests/PlanUpdate.java | 24 +- .../v3/requests/SubscriptionCreate.java | 40 ++- .../v3/requests/SubscriptionPurchase.java | 33 +- .../java/com/recurly/v3/resources/AddOn.java | 24 +- .../com/recurly/v3/resources/Invoice.java | 15 + .../java/com/recurly/v3/resources/Item.java | 21 +- .../com/recurly/v3/resources/LineItem.java | 27 +- .../java/com/recurly/v3/resources/Plan.java | 21 +- 19 files changed, 696 insertions(+), 225 deletions(-) create mode 100644 src/main/java/com/recurly/v3/requests/BillingInfoVerifyCVV.java diff --git a/openapi/api.yaml b/openapi/api.yaml index 79338fca..ad48e91c 100644 --- a/openapi/api.yaml +++ b/openapi/api.yaml @@ -2427,6 +2427,54 @@ paths: {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Fetched Transaction: %v\", transaction)" + "/sites/{site_id}/accounts/{account_id}/billing_info/verify_cvv": + post: + tags: + - billing_info + operationId: verify_billing_info_cvv + summary: Verify an account's credit card billing cvv + parameters: + - "$ref": "#/components/parameters/site_id" + - "$ref": "#/components/parameters/account_id" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/BillingInfoVerifyCVV" + responses: + '200': + description: Transaction information from verify. + content: + application/json: + schema: + "$ref": "#/components/schemas/Transaction" + '404': + description: Account has no billing information, or incorrect site or account + ID. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + default: + description: Unexpected error. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + '422': + description: Invalid billing information, or error running the verification + transaction. + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorMayHaveTransaction" + '429': + description: Too many CVV verification attempts. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] "/sites/{site_id}/accounts/{account_id}/billing_infos": get: tags: @@ -2637,6 +2685,99 @@ paths: schema: "$ref": "#/components/schemas/Error" x-code-samples: [] + "/sites/{site_id}/accounts/{account_id}/billing_infos/{billing_info_id}/verify": + post: + tags: + - billing_infos + operationId: verify_billing_infos + summary: Verify a billing information's credit card + parameters: + - "$ref": "#/components/parameters/site_id" + - "$ref": "#/components/parameters/account_id" + - "$ref": "#/components/parameters/billing_info_id" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/BillingInfoVerify" + required: false + responses: + '200': + description: Transaction information from verify. + content: + application/json: + schema: + "$ref": "#/components/schemas/Transaction" + '404': + description: Billing information not found, or incorrect site or account + ID. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + default: + description: Unexpected error. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + '422': + description: Invalid billing information, or error running the verification + transaction. + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorMayHaveTransaction" + x-code-samples: [] + "/sites/{site_id}/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv": + post: + tags: + - billing_infos + operationId: verify_billing_infos_cvv + summary: Verify a billing information's credit card cvv + parameters: + - "$ref": "#/components/parameters/site_id" + - "$ref": "#/components/parameters/account_id" + - "$ref": "#/components/parameters/billing_info_id" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/BillingInfoVerifyCVV" + responses: + '200': + description: Transaction information from verify. + content: + application/json: + schema: + "$ref": "#/components/schemas/Transaction" + '404': + description: Billing information not found, or incorrect site or account + ID. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + default: + description: Unexpected error. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + '422': + description: Invalid billing information, or error running the verification + transaction. + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorMayHaveTransaction" + '429': + description: Too many CVV verification attempts. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] "/sites/{site_id}/accounts/{account_id}/coupon_redemptions": get: tags: @@ -8982,10 +9123,11 @@ paths: summary: Refund an invoice description: | There are two ways to do a refund: - * refund a specific amount which is divided across all the line items. - * refund quantities of line items. - If you want to refund the entire refundable amount on the invoice, the - simplest way is to do `type=amount` without specifiying an `amount`. + * Apply a specific dollar/cent amount or percentage amount to an entire invoice, which will refund the resulting amount across all line items on the invoice. + * If you want to refund the entire refundable amount on the invoice, the simplest way is to do `type=amount` without specifiying an `amount`. + * Note: You must have the Credit Memos feature flag enabled on your site to utilize percentage amount refunds on invoices. + * Apply a refund to one or more individual line items on an invoice. A line item can be refunded by a quantity amount, a specific dollar/cent amount, or a percentage amount and will only apply to the specific line item you are aiming to refund. + * Note: You must have the Credit Memos feature flag enabled on your site to utilize specific dollar/cent amount and percentage amount refunds on line items. parameters: - "$ref": "#/components/parameters/site_id" - "$ref": "#/components/parameters/invoice_id" @@ -14721,7 +14863,8 @@ components: name: invoice_id in: path description: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. - For number use prefix `number-`, e.g. `number-1000`. + For number use prefix `number-`, e.g. `number-1000`. For number with prefix + or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` required: true schema: type: string @@ -16128,11 +16271,14 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: 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`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of + the request then `tax_code` must be absent. display_quantity: type: boolean title: Display quantity? @@ -16339,14 +16485,14 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: Optional field used by Avalara, Vertex, and Recurly's EU VAT - tax feature to determine taxation rules. If you have your own AvaTax or - Vertex account configured, use their tax codes to assign specific tax - rules. If you are using Recurly's EU VAT feature, you can use values of - `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part - of the request then `tax_code` must be absent. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of + the request then `tax_code` must be absent. currencies: type: array title: Add-on pricing @@ -16472,14 +16618,14 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: Optional field used by Avalara, Vertex, and Recurly's EU VAT - tax feature to determine taxation rules. If you have your own AvaTax or - Vertex account configured, use their tax codes to assign specific tax - rules. If you are using Recurly's EU VAT feature, you can use values of - `unknown`, `physical`, or `digital`. If an `Item` is associated to the - `AddOn` then `tax code` must be absent. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. If an `Item` is associated to the + `AddOn` then `tax_code` must be absent. display_quantity: type: boolean title: Display quantity? @@ -16670,8 +16816,7 @@ 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 gateway_attributes: type: object @@ -16795,6 +16940,30 @@ components: type: string description: An identifier for a specific payment gateway. maxLength: 13 + three_d_secure_action_result_token_id: + type: string + description: A token generated by Recurly.js after completing a 3-D Secure + device fingerprinting or authentication challenge. + maxLength: 50 + BillingInfoVerifyCVV: + type: object + properties: + verification_value: + type: string + description: Unique security code for a credit card. + gateway_code: + type: string + description: An identifier for a specific payment gateway. + maxLength: 13 + token_id: + type: string + description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token). + maxLength: 50 + three_d_secure_action_result_token_id: + type: string + description: A token generated by Recurly.js after completing a 3-D Secure + device fingerprinting or authentication challenge. + maxLength: 50 Coupon: type: object properties: @@ -17678,11 +17847,13 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: 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`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. tax_exempt: type: boolean title: Tax exempt? @@ -17767,11 +17938,13 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: 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`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. tax_exempt: type: boolean title: Tax exempt? @@ -17844,11 +18017,13 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: 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`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. tax_exempt: type: boolean title: Tax exempt? @@ -17998,6 +18173,11 @@ components: title: Subtotal description: The summation of charges and credits, before discounts and taxes. + subtotal_after_discount: + type: number + format: float + title: Subtotal After Discount + description: The summation of charges and credits, after discounts applied. tax: type: number format: float @@ -18645,7 +18825,7 @@ components: type: number format: float title: Total after discounts and taxes - description: "`(quantity * unit_amount) - (discount + tax)`" + description: "`(quantity * unit_amount) - discount + tax`" description: type: string title: Description @@ -18721,11 +18901,13 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: 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`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. tax_info: "$ref": "#/components/schemas/TaxInfo" proration_rate: @@ -18928,13 +19110,13 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: Optional field used by Avalara, Vertex, and Recurly's EU VAT - tax feature to determine taxation rules. If you have your own AvaTax or - Vertex account configured, use their tax codes to assign specific tax - rules. If you are using Recurly's EU VAT feature, you can use values of - `unknown`, `physical`, or `digital`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. product_code: type: string title: Product code @@ -19156,11 +19338,13 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: 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`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. tax_exempt: type: boolean title: Tax exempt? @@ -19345,13 +19529,13 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: Optional field used by Avalara, Vertex, and Recurly's EU VAT - tax feature to determine taxation rules. If you have your own AvaTax or - Vertex account configured, use their tax codes to assign specific tax - rules. If you are using Recurly's EU VAT feature, you can use values of - `unknown`, `physical`, or `digital`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. tax_exempt: type: boolean title: Tax exempt? @@ -19561,13 +19745,13 @@ components: minimum: 0 tax_code: type: string - title: Tax code - description: Optional field used by Avalara, Vertex, and Recurly's EU VAT - tax feature to determine taxation rules. If you have your own AvaTax or - Vertex account configured, use their tax codes to assign specific tax - rules. If you are using Recurly's EU VAT feature, you can use values of - `unknown`, `physical`, or `digital`. maxLength: 50 + title: Tax code + description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box + tax solution to determine taxation rules. You can pass in specific tax + codes using any of these tax integrations. For Recurly's In-the-Box tax + offering you can also choose to instead use simple values of `unknown`, + `physical`, or `digital` tax codes. tax_exempt: type: boolean title: Tax exempt? @@ -20992,9 +21176,10 @@ components: type: string format: date-time title: Start date - description: If set, the subscription will begin in the future on this date. + description: If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the - plan has no trial. + plan has no trial. Omit this field if the subscription should be started + immediately. next_bill_date: type: string format: date-time @@ -21080,6 +21265,12 @@ components: mail order and telephone transactions. enum: - moto + bulk: + type: boolean + description: Optional field to be used only when needing to bypass the 60 + second limit on creating subscriptions. Should only be used when creating + subscriptions in bulk from the API. + default: false required: - plan_code - currency @@ -21141,7 +21332,7 @@ components: type: string format: date-time title: Start date - description: If set, the subscription will begin in the future on this date. + description: If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial. next_bill_date: @@ -21187,6 +21378,12 @@ components: description: The new set of ramp intervals for the subscription. items: "$ref": "#/components/schemas/SubscriptionRampInterval" + bulk: + type: boolean + description: Optional field to be used only when needing to bypass the 60 + second limit on creating subscriptions. Should only be used when creating + subscriptions in bulk from the API. + default: false required: - plan_code SubscriptionUpdate: @@ -22220,6 +22417,7 @@ components: format: date-time description: When the current settings were updated in Recurly. DunningInterval: + type: object properties: days: type: integer @@ -22244,6 +22442,7 @@ components: items: type: string DunningCampaignsBulkUpdateResponse: + type: object properties: object: type: string @@ -22258,6 +22457,7 @@ components: items: "$ref": "#/components/schemas/Plan" PaymentMethod: + type: object properties: object: type: string diff --git a/src/main/java/com/recurly/v3/Client.java b/src/main/java/com/recurly/v3/Client.java index f009bbab..c2903904 100644 --- a/src/main/java/com/recurly/v3/Client.java +++ b/src/main/java/com/recurly/v3/Client.java @@ -296,6 +296,23 @@ public Transaction verifyBillingInfo(String accountId, BillingInfoVerify body) { return this.makeRequest("POST", path, body, returnType); } + /** + * Verify an account's credit card billing cvv + * + * @see verify_billing_info_cvv api documentation + * @param accountId Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. + * @param body The body of the request. + * @return Transaction information from verify. + */ + public Transaction verifyBillingInfoCvv(String accountId, BillingInfoVerifyCVV body) { + final String url = "/accounts/{account_id}/billing_info/verify_cvv"; + final HashMap urlParams = new HashMap(); + urlParams.put("account_id", accountId); + final String path = this.interpolatePath(url, urlParams); + Type returnType = Transaction.class; + return this.makeRequest("POST", path, body, returnType); + } + /** * Get the list of billing information associated with an account * @@ -385,6 +402,62 @@ public void removeABillingInfo(String accountId, String billingInfoId) { this.makeRequest("DELETE", path); } + /** + * Verify a billing information's credit card + * + * @see verify_billing_infos api documentation + * @param accountId Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. + * @param billingInfoId Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature. + * @return Transaction information from verify. + */ + public Transaction verifyBillingInfos(String accountId, String billingInfoId) { + final String url = "/accounts/{account_id}/billing_infos/{billing_info_id}/verify"; + final HashMap urlParams = new HashMap(); + urlParams.put("account_id", accountId); + urlParams.put("billing_info_id", billingInfoId); + final String path = this.interpolatePath(url, urlParams); + Type returnType = Transaction.class; + return this.makeRequest("POST", path, returnType); + } + + /** + * Verify a billing information's credit card + * + * @see verify_billing_infos api documentation + * @param accountId Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. + * @param billingInfoId Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature. + * @param body The body of the request. + * @return Transaction information from verify. + */ + public Transaction verifyBillingInfos(String accountId, String billingInfoId, BillingInfoVerify body) { + final String url = "/accounts/{account_id}/billing_infos/{billing_info_id}/verify"; + final HashMap urlParams = new HashMap(); + urlParams.put("account_id", accountId); + urlParams.put("billing_info_id", billingInfoId); + final String path = this.interpolatePath(url, urlParams); + Type returnType = Transaction.class; + return this.makeRequest("POST", path, body, returnType); + } + + /** + * Verify a billing information's credit card cvv + * + * @see verify_billing_infos_cvv api documentation + * @param accountId Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. + * @param billingInfoId Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature. + * @param body The body of the request. + * @return Transaction information from verify. + */ + public Transaction verifyBillingInfosCvv(String accountId, String billingInfoId, BillingInfoVerifyCVV body) { + final String url = "/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv"; + final HashMap urlParams = new HashMap(); + urlParams.put("account_id", accountId); + urlParams.put("billing_info_id", billingInfoId); + final String path = this.interpolatePath(url, urlParams); + Type returnType = Transaction.class; + return this.makeRequest("POST", path, body, returnType); + } + /** * List the coupon redemptions for an account * @@ -1143,7 +1216,7 @@ public Pager listInvoices(QueryParams queryParams) { * Fetch an invoice * * @see get_invoice api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return An invoice. */ public Invoice getInvoice(String invoiceId) { @@ -1159,7 +1232,7 @@ public Invoice getInvoice(String invoiceId) { * Update an invoice * * @see put_invoice api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @param body The body of the request. * @return An invoice. */ @@ -1176,7 +1249,7 @@ public Invoice putInvoice(String invoiceId, InvoiceUpdatable body) { * Fetch an invoice as a PDF * * @see get_invoice_pdf api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return An invoice as a PDF. */ public BinaryFile getInvoicePdf(String invoiceId) { @@ -1192,7 +1265,7 @@ public BinaryFile getInvoicePdf(String invoiceId) { * Apply available credit to a pending or past due charge invoice * * @see apply_credit_balance api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return The updated invoice. */ public Invoice applyCreditBalance(String invoiceId) { @@ -1208,7 +1281,7 @@ public Invoice applyCreditBalance(String invoiceId) { * Collect a pending or past due, automatic invoice * * @see collect_invoice api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return The updated invoice. */ public Invoice collectInvoice(String invoiceId) { @@ -1224,7 +1297,7 @@ public Invoice collectInvoice(String invoiceId) { * Collect a pending or past due, automatic invoice * * @see collect_invoice api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @param body The body of the request. * @return The updated invoice. */ @@ -1241,7 +1314,7 @@ public Invoice collectInvoice(String invoiceId, InvoiceCollect body) { * Mark an open invoice as failed * * @see fail_invoice api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return The updated invoice. */ public Invoice failInvoice(String invoiceId) { @@ -1257,7 +1330,7 @@ public Invoice failInvoice(String invoiceId) { * Mark an open invoice as successful * * @see mark_invoice_successful api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return The updated invoice. */ public Invoice markInvoiceSuccessful(String invoiceId) { @@ -1273,7 +1346,7 @@ public Invoice markInvoiceSuccessful(String invoiceId) { * Reopen a closed, manual invoice * * @see reopen_invoice api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return The updated invoice. */ public Invoice reopenInvoice(String invoiceId) { @@ -1289,7 +1362,7 @@ public Invoice reopenInvoice(String invoiceId) { * Void a credit invoice. * * @see void_invoice api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return The updated invoice. */ public Invoice voidInvoice(String invoiceId) { @@ -1305,7 +1378,7 @@ public Invoice voidInvoice(String invoiceId) { * Record an external payment for a manual invoices. * * @see record_external_transaction api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @param body The body of the request. * @return The recorded transaction. */ @@ -1322,7 +1395,7 @@ public Transaction recordExternalTransaction(String invoiceId, ExternalTransacti * List an invoice's line items * * @see list_invoice_line_items api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @param queryParams The {@link QueryParams} for this endpoint. * @return A list of the invoice's line items. */ @@ -1341,7 +1414,7 @@ public Pager listInvoiceLineItems(String invoiceId, QueryParams queryP * List the coupon redemptions applied to an invoice * * @see list_invoice_coupon_redemptions api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @param queryParams The {@link QueryParams} for this endpoint. * @return A list of the the coupon redemptions associated with the invoice. */ @@ -1360,7 +1433,7 @@ public Pager listInvoiceCouponRedemptions(String invoiceId, Qu * List an invoice's related credit or charge invoices * * @see list_related_invoices api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @return A list of the credit or charge invoices associated with the invoice. */ public Pager listRelatedInvoices(String invoiceId) { @@ -1376,7 +1449,7 @@ public Pager listRelatedInvoices(String invoiceId) { * Refund an invoice * * @see refund_invoice api documentation - * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. + * @param invoiceId Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001` * @param body The body of the request. * @return Returns the new credit invoice. */ diff --git a/src/main/java/com/recurly/v3/requests/AddOnCreate.java b/src/main/java/com/recurly/v3/requests/AddOnCreate.java index dc85ecd0..7e85bd8d 100644 --- a/src/main/java/com/recurly/v3/requests/AddOnCreate.java +++ b/src/main/java/com/recurly/v3/requests/AddOnCreate.java @@ -146,11 +146,11 @@ public class AddOnCreate extends Request { private String revenueScheduleType; /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must - * be absent. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of the request + * then `tax_code` must be absent. */ @SerializedName("tax_code") @Expose @@ -465,22 +465,22 @@ public void setRevenueScheduleType(final String revenueScheduleType) { } /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must - * be absent. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of the request + * then `tax_code` must be absent. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to - * determine taxation rules. If you have your own AvaTax or Vertex account configured, use - * their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, - * you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part - * of the request then `tax_code` must be absent. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. If `item_code`/`item_id` is + * part of the request then `tax_code` must be absent. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/requests/AddOnUpdate.java b/src/main/java/com/recurly/v3/requests/AddOnUpdate.java index bbd5669d..739e3301 100644 --- a/src/main/java/com/recurly/v3/requests/AddOnUpdate.java +++ b/src/main/java/com/recurly/v3/requests/AddOnUpdate.java @@ -120,11 +120,11 @@ public class AddOnUpdate extends Request { private String revenueScheduleType; /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. If an `Item` is associated to the `AddOn` then `tax code` must be - * absent. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. If an `Item` is associated to the `AddOn` then + * `tax_code` must be absent. */ @SerializedName("tax_code") @Expose @@ -368,22 +368,22 @@ public void setRevenueScheduleType(final String revenueScheduleType) { } /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. If an `Item` is associated to the `AddOn` then `tax code` must be - * absent. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. If an `Item` is associated to the `AddOn` then + * `tax_code` must be absent. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to - * determine taxation rules. If you have your own AvaTax or Vertex account configured, use - * their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, - * you can use values of `unknown`, `physical`, or `digital`. If an `Item` is associated to - * the `AddOn` then `tax code` must be absent. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. If an `Item` is associated + * to the `AddOn` then `tax_code` must be absent. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/requests/BillingInfoCreate.java b/src/main/java/com/recurly/v3/requests/BillingInfoCreate.java index c68ef1e2..de74499a 100644 --- a/src/main/java/com/recurly/v3/requests/BillingInfoCreate.java +++ b/src/main/java/com/recurly/v3/requests/BillingInfoCreate.java @@ -80,9 +80,7 @@ public class BillingInfoCreate extends Request { @Expose private GatewayAttributes gatewayAttributes; - /** - * An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`. - */ + /** An identifier for a specific payment gateway. */ @SerializedName("gateway_code") @Expose private String gatewayCode; @@ -357,17 +355,12 @@ public void setGatewayAttributes(final GatewayAttributes gatewayAttributes) { this.gatewayAttributes = gatewayAttributes; } - /** - * An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`. - */ + /** An identifier for a specific payment gateway. */ public String getGatewayCode() { return this.gatewayCode; } - /** - * @param gatewayCode An identifier for a specific payment gateway. Must be used in conjunction - * with `gateway_token`. - */ + /** @param gatewayCode An identifier for a specific payment gateway. */ public void setGatewayCode(final String gatewayCode) { this.gatewayCode = gatewayCode; } diff --git a/src/main/java/com/recurly/v3/requests/BillingInfoVerify.java b/src/main/java/com/recurly/v3/requests/BillingInfoVerify.java index 0bf63072..c7fba9dd 100644 --- a/src/main/java/com/recurly/v3/requests/BillingInfoVerify.java +++ b/src/main/java/com/recurly/v3/requests/BillingInfoVerify.java @@ -17,6 +17,14 @@ public class BillingInfoVerify extends Request { @Expose private String gatewayCode; + /** + * A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or + * authentication challenge. + */ + @SerializedName("three_d_secure_action_result_token_id") + @Expose + private String threeDSecureActionResultTokenId; + /** An identifier for a specific payment gateway. */ public String getGatewayCode() { return this.gatewayCode; @@ -26,4 +34,20 @@ public String getGatewayCode() { public void setGatewayCode(final String gatewayCode) { this.gatewayCode = gatewayCode; } + + /** + * A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or + * authentication challenge. + */ + public String getThreeDSecureActionResultTokenId() { + return this.threeDSecureActionResultTokenId; + } + + /** + * @param threeDSecureActionResultTokenId A token generated by Recurly.js after completing a 3-D + * Secure device fingerprinting or authentication challenge. + */ + public void setThreeDSecureActionResultTokenId(final String threeDSecureActionResultTokenId) { + this.threeDSecureActionResultTokenId = threeDSecureActionResultTokenId; + } } diff --git a/src/main/java/com/recurly/v3/requests/BillingInfoVerifyCVV.java b/src/main/java/com/recurly/v3/requests/BillingInfoVerifyCVV.java new file mode 100644 index 00000000..58930655 --- /dev/null +++ b/src/main/java/com/recurly/v3/requests/BillingInfoVerifyCVV.java @@ -0,0 +1,92 @@ +/** + * 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 com.recurly.v3.requests; + +import com.google.gson.annotations.Expose; +import com.google.gson.annotations.SerializedName; +import com.recurly.v3.Request; +import com.recurly.v3.resources.*; + +public class BillingInfoVerifyCVV extends Request { + + /** An identifier for a specific payment gateway. */ + @SerializedName("gateway_code") + @Expose + private String gatewayCode; + + /** + * A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or + * authentication challenge. + */ + @SerializedName("three_d_secure_action_result_token_id") + @Expose + private String threeDSecureActionResultTokenId; + + /** + * A token [generated by + * Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token). + */ + @SerializedName("token_id") + @Expose + private String tokenId; + + /** Unique security code for a credit card. */ + @SerializedName("verification_value") + @Expose + private String verificationValue; + + /** An identifier for a specific payment gateway. */ + public String getGatewayCode() { + return this.gatewayCode; + } + + /** @param gatewayCode An identifier for a specific payment gateway. */ + public void setGatewayCode(final String gatewayCode) { + this.gatewayCode = gatewayCode; + } + + /** + * A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or + * authentication challenge. + */ + public String getThreeDSecureActionResultTokenId() { + return this.threeDSecureActionResultTokenId; + } + + /** + * @param threeDSecureActionResultTokenId A token generated by Recurly.js after completing a 3-D + * Secure device fingerprinting or authentication challenge. + */ + public void setThreeDSecureActionResultTokenId(final String threeDSecureActionResultTokenId) { + this.threeDSecureActionResultTokenId = threeDSecureActionResultTokenId; + } + + /** + * A token [generated by + * Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token). + */ + public String getTokenId() { + return this.tokenId; + } + + /** + * @param tokenId A token [generated by + * Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token). + */ + public void setTokenId(final String tokenId) { + this.tokenId = tokenId; + } + + /** Unique security code for a credit card. */ + public String getVerificationValue() { + return this.verificationValue; + } + + /** @param verificationValue Unique security code for a credit card. */ + public void setVerificationValue(final String verificationValue) { + this.verificationValue = verificationValue; + } +} diff --git a/src/main/java/com/recurly/v3/requests/ItemCreate.java b/src/main/java/com/recurly/v3/requests/ItemCreate.java index 5b2d47b6..0525e537 100644 --- a/src/main/java/com/recurly/v3/requests/ItemCreate.java +++ b/src/main/java/com/recurly/v3/requests/ItemCreate.java @@ -81,9 +81,10 @@ public class ItemCreate extends Request { private String revenueScheduleType; /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ @SerializedName("tax_code") @Expose @@ -231,18 +232,20 @@ public void setRevenueScheduleType(final String revenueScheduleType) { } /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode 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`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/requests/ItemUpdate.java b/src/main/java/com/recurly/v3/requests/ItemUpdate.java index 9465c263..6de72115 100644 --- a/src/main/java/com/recurly/v3/requests/ItemUpdate.java +++ b/src/main/java/com/recurly/v3/requests/ItemUpdate.java @@ -81,9 +81,10 @@ public class ItemUpdate extends Request { private String revenueScheduleType; /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ @SerializedName("tax_code") @Expose @@ -231,18 +232,20 @@ public void setRevenueScheduleType(final String revenueScheduleType) { } /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode 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`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/requests/LineItemCreate.java b/src/main/java/com/recurly/v3/requests/LineItemCreate.java index 0a3cd896..7fb66df8 100644 --- a/src/main/java/com/recurly/v3/requests/LineItemCreate.java +++ b/src/main/java/com/recurly/v3/requests/LineItemCreate.java @@ -142,10 +142,10 @@ public class LineItemCreate extends Request { private DateTime startDate; /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ @SerializedName("tax_code") @Expose @@ -445,20 +445,20 @@ public void setStartDate(final DateTime startDate) { } /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to - * determine taxation rules. If you have your own AvaTax or Vertex account configured, use - * their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, - * you can use values of `unknown`, `physical`, or `digital`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/requests/PlanCreate.java b/src/main/java/com/recurly/v3/requests/PlanCreate.java index 48446a51..b10c2bbe 100644 --- a/src/main/java/com/recurly/v3/requests/PlanCreate.java +++ b/src/main/java/com/recurly/v3/requests/PlanCreate.java @@ -157,10 +157,10 @@ public class PlanCreate extends Request { private String setupFeeRevenueScheduleType; /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ @SerializedName("tax_code") @Expose @@ -481,20 +481,20 @@ public void setSetupFeeRevenueScheduleType(final String setupFeeRevenueScheduleT } /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to - * determine taxation rules. If you have your own AvaTax or Vertex account configured, use - * their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, - * you can use values of `unknown`, `physical`, or `digital`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/requests/PlanUpdate.java b/src/main/java/com/recurly/v3/requests/PlanUpdate.java index a10e8a08..499c2ae5 100644 --- a/src/main/java/com/recurly/v3/requests/PlanUpdate.java +++ b/src/main/java/com/recurly/v3/requests/PlanUpdate.java @@ -138,10 +138,10 @@ public class PlanUpdate extends Request { private String setupFeeRevenueScheduleType; /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ @SerializedName("tax_code") @Expose @@ -424,20 +424,20 @@ public void setSetupFeeRevenueScheduleType(final String setupFeeRevenueScheduleT } /** - * Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation - * rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign - * specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, - * `physical`, or `digital`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to - * determine taxation rules. If you have your own AvaTax or Vertex account configured, use - * their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, - * you can use values of `unknown`, `physical`, or `digital`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/requests/SubscriptionCreate.java b/src/main/java/com/recurly/v3/requests/SubscriptionCreate.java index a3d9eae1..2c077765 100644 --- a/src/main/java/com/recurly/v3/requests/SubscriptionCreate.java +++ b/src/main/java/com/recurly/v3/requests/SubscriptionCreate.java @@ -38,6 +38,14 @@ public class SubscriptionCreate extends Request { @Expose private String billingInfoId; + /** + * Optional field to be used only when needing to bypass the 60 second limit on creating + * subscriptions. Should only be used when creating subscriptions in bulk from the API. + */ + @SerializedName("bulk") + @Expose + private Boolean bulk; + /** Collection method */ @SerializedName("collection_method") @Expose @@ -154,8 +162,9 @@ public class SubscriptionCreate extends Request { private SubscriptionShippingCreate shipping; /** - * If set, the subscription will begin in the future on this date. The subscription will apply the - * setup fee and trial period, unless the plan has no trial. + * If set, the subscription will begin on this specified date. The subscription will apply the + * setup fee and trial period, unless the plan has no trial. Omit this field if the subscription + * should be started immediately. */ @SerializedName("starts_at") @Expose @@ -262,6 +271,23 @@ public void setBillingInfoId(final String billingInfoId) { this.billingInfoId = billingInfoId; } + /** + * Optional field to be used only when needing to bypass the 60 second limit on creating + * subscriptions. Should only be used when creating subscriptions in bulk from the API. + */ + public Boolean getBulk() { + return this.bulk; + } + + /** + * @param bulk Optional field to be used only when needing to bypass the 60 second limit on + * creating subscriptions. Should only be used when creating subscriptions in bulk from the + * API. + */ + public void setBulk(final Boolean bulk) { + this.bulk = bulk; + } + /** Collection method */ public String getCollectionMethod() { return this.collectionMethod; @@ -498,16 +524,18 @@ public void setShipping(final SubscriptionShippingCreate shipping) { } /** - * If set, the subscription will begin in the future on this date. The subscription will apply the - * setup fee and trial period, unless the plan has no trial. + * If set, the subscription will begin on this specified date. The subscription will apply the + * setup fee and trial period, unless the plan has no trial. Omit this field if the subscription + * should be started immediately. */ public DateTime getStartsAt() { return this.startsAt; } /** - * @param startsAt If set, the subscription will begin in the future on this date. The - * subscription will apply the setup fee and trial period, unless the plan has no trial. + * @param startsAt If set, the subscription will begin on this specified date. The subscription + * will apply the setup fee and trial period, unless the plan has no trial. Omit this field if + * the subscription should be started immediately. */ public void setStartsAt(final DateTime startsAt) { this.startsAt = startsAt; diff --git a/src/main/java/com/recurly/v3/requests/SubscriptionPurchase.java b/src/main/java/com/recurly/v3/requests/SubscriptionPurchase.java index f5154d9d..c0ccb251 100644 --- a/src/main/java/com/recurly/v3/requests/SubscriptionPurchase.java +++ b/src/main/java/com/recurly/v3/requests/SubscriptionPurchase.java @@ -24,6 +24,14 @@ public class SubscriptionPurchase extends Request { @Expose private Boolean autoRenew; + /** + * Optional field to be used only when needing to bypass the 60 second limit on creating + * subscriptions. Should only be used when creating subscriptions in bulk from the API. + */ + @SerializedName("bulk") + @Expose + private Boolean bulk; + /** * The custom fields will only be altered when they are included in a request. Sending an empty * array will not remove any existing values. To remove a field send the name with a null or empty @@ -84,7 +92,7 @@ public class SubscriptionPurchase extends Request { private SubscriptionShippingPurchase shipping; /** - * If set, the subscription will begin in the future on this date. The subscription will apply the + * If set, the subscription will begin on this specified date. The subscription will apply the * setup fee and trial period, unless the plan has no trial. */ @SerializedName("starts_at") @@ -146,6 +154,23 @@ public void setAutoRenew(final Boolean autoRenew) { this.autoRenew = autoRenew; } + /** + * Optional field to be used only when needing to bypass the 60 second limit on creating + * subscriptions. Should only be used when creating subscriptions in bulk from the API. + */ + public Boolean getBulk() { + return this.bulk; + } + + /** + * @param bulk Optional field to be used only when needing to bypass the 60 second limit on + * creating subscriptions. Should only be used when creating subscriptions in bulk from the + * API. + */ + public void setBulk(final Boolean bulk) { + this.bulk = bulk; + } + /** * The custom fields will only be altered when they are included in a request. Sending an empty * array will not remove any existing values. To remove a field send the name with a null or empty @@ -266,7 +291,7 @@ public void setShipping(final SubscriptionShippingPurchase shipping) { } /** - * If set, the subscription will begin in the future on this date. The subscription will apply the + * If set, the subscription will begin on this specified date. The subscription will apply the * setup fee and trial period, unless the plan has no trial. */ public DateTime getStartsAt() { @@ -274,8 +299,8 @@ public DateTime getStartsAt() { } /** - * @param startsAt If set, the subscription will begin in the future on this date. The - * subscription will apply the setup fee and trial period, unless the plan has no trial. + * @param startsAt If set, the subscription will begin on this specified date. The subscription + * will apply the setup fee and trial period, unless the plan has no trial. */ public void setStartsAt(final DateTime startsAt) { this.startsAt = startsAt; diff --git a/src/main/java/com/recurly/v3/resources/AddOn.java b/src/main/java/com/recurly/v3/resources/AddOn.java index 98108f86..ce8b1054 100644 --- a/src/main/java/com/recurly/v3/resources/AddOn.java +++ b/src/main/java/com/recurly/v3/resources/AddOn.java @@ -136,9 +136,11 @@ public class AddOn extends Resource { private String state; /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of the request + * then `tax_code` must be absent. */ @SerializedName("tax_code") @Expose @@ -425,18 +427,22 @@ public void setState(final String state) { } /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of the request + * then `tax_code` must be absent. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode 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`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. If `item_code`/`item_id` is + * part of the request then `tax_code` must be absent. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/resources/Invoice.java b/src/main/java/com/recurly/v3/resources/Invoice.java index 370e6c37..587afeaa 100644 --- a/src/main/java/com/recurly/v3/resources/Invoice.java +++ b/src/main/java/com/recurly/v3/resources/Invoice.java @@ -178,6 +178,11 @@ public class Invoice extends Resource { @Expose private Float subtotal; + /** The summation of charges and credits, after discounts applied. */ + @SerializedName("subtotal_after_discount") + @Expose + private Float subtotalAfterDiscount; + /** The total tax on this invoice. */ @SerializedName("tax") @Expose @@ -590,6 +595,16 @@ public void setSubtotal(final Float subtotal) { this.subtotal = subtotal; } + /** The summation of charges and credits, after discounts applied. */ + public Float getSubtotalAfterDiscount() { + return this.subtotalAfterDiscount; + } + + /** @param subtotalAfterDiscount The summation of charges and credits, after discounts applied. */ + public void setSubtotalAfterDiscount(final Float subtotalAfterDiscount) { + this.subtotalAfterDiscount = subtotalAfterDiscount; + } + /** The total tax on this invoice. */ public Float getTax() { return this.tax; diff --git a/src/main/java/com/recurly/v3/resources/Item.java b/src/main/java/com/recurly/v3/resources/Item.java index 2864e524..7c4aee5b 100644 --- a/src/main/java/com/recurly/v3/resources/Item.java +++ b/src/main/java/com/recurly/v3/resources/Item.java @@ -106,9 +106,10 @@ public class Item extends Resource { private String state; /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ @SerializedName("tax_code") @Expose @@ -311,18 +312,20 @@ public void setState(final String state) { } /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode 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`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/resources/LineItem.java b/src/main/java/com/recurly/v3/resources/LineItem.java index 4c286e8e..39e6b099 100644 --- a/src/main/java/com/recurly/v3/resources/LineItem.java +++ b/src/main/java/com/recurly/v3/resources/LineItem.java @@ -38,7 +38,7 @@ public class LineItem extends Resource { @Expose private String addOnId; - /** `(quantity * unit_amount) - (discount + tax)` */ + /** `(quantity * unit_amount) - discount + tax` */ @SerializedName("amount") @Expose private Float amount; @@ -302,9 +302,10 @@ public class LineItem extends Resource { private Float tax; /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ @SerializedName("tax_code") @Expose @@ -412,12 +413,12 @@ public void setAddOnId(final String addOnId) { this.addOnId = addOnId; } - /** `(quantity * unit_amount) - (discount + tax)` */ + /** `(quantity * unit_amount) - discount + tax` */ public Float getAmount() { return this.amount; } - /** @param amount `(quantity * unit_amount) - (discount + tax)` */ + /** @param amount `(quantity * unit_amount) - discount + tax` */ public void setAmount(final Float amount) { this.amount = amount; } @@ -962,18 +963,20 @@ public void setTax(final Float tax) { } /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode 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`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode; diff --git a/src/main/java/com/recurly/v3/resources/Plan.java b/src/main/java/com/recurly/v3/resources/Plan.java index 56717510..d38feb97 100644 --- a/src/main/java/com/recurly/v3/resources/Plan.java +++ b/src/main/java/com/recurly/v3/resources/Plan.java @@ -177,9 +177,10 @@ public class Plan extends Resource { private String state; /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ @SerializedName("tax_code") @Expose @@ -546,18 +547,20 @@ public void setState(final String state) { } /** - * 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`. + * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine + * taxation rules. You can pass in specific tax codes using any of these tax integrations. For + * Recurly's In-the-Box tax offering you can also choose to instead use simple values of + * `unknown`, `physical`, or `digital` tax codes. */ public String getTaxCode() { return this.taxCode; } /** - * @param taxCode 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`. + * @param taxCode Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to + * determine taxation rules. You can pass in specific tax codes using any of these tax + * integrations. For Recurly's In-the-Box tax offering you can also choose to instead use + * simple values of `unknown`, `physical`, or `digital` tax codes. */ public void setTaxCode(final String taxCode) { this.taxCode = taxCode;