recurly 3.14.0 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb35c82f1aea79ead43c5b2158031d946b71f6b21ce9118467d0f391fd000d6
-  data.tar.gz: 204672929d178c8bd4485d0386767469f27fed7965c1f8c64313424ecadb73c7
+  metadata.gz: ecaa5f1cc2110480aac4355c469c84d7a423badce1a4860cd494ab9e4966a118
+  data.tar.gz: b5c805224d670c22eed575410d51af2e801279f7f5dae0d274d84ecc60731363
 SHA512:
-  metadata.gz: fa8dfba5a7d51261f92dfdfe1fe232ac580a00180c1c304592834b60f22afe0d8ddc9256652b5be40d2c3fd35fa72442e99260dd9e6be922e31c57069e088b59
-  data.tar.gz: 8d0a7738e9f8d97d1a9f2129e984d033e22ae72de0913ffca507de8c30fb19961e02d828c6530fa75e43274179c3ff6c15288c96c57f8cf5e0f7b60ec9daae5a
+  metadata.gz: 322cf51b9d06fb661860d02603896a370b92b0292eae793a1ec911bd5528f8452180e76a80199f0f938b9ff4f7c8458001941a18f899c3bdfdd6b49aaf6e0963
+  data.tar.gz: 2cace6d2929076220ae9f029865a9bc6ca73e66edd0bafb66bce496e5e70985bb1da9a72fa0265c659c725a187a1fdc42730b696524bc1a66bdd84495ccc6958

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.14.0
+current_version = 3.15.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

data/CHANGELOG.md

@@ -1,8 +1,20 @@
 # Changelog
 
-## [3.14.0](https://github.com/recurly/recurly-client-ruby/tree/HEAD)
+## [3.15.0](https://github.com/recurly/recurly-client-ruby/tree/HEAD)
 
-[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.13.0...HEAD)
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.14.0...HEAD)
+
+**Implemented enhancements:**
+
+- Latest Changes for 2019-10-10 \(Wallet, Item Coupons\) [\#645](https://github.com/recurly/recurly-client-ruby/pull/645) ([douglasmiller](https://github.com/douglasmiller))
+
+**Merged pull requests:**
+
+- Release 3.15.0 [\#647](https://github.com/recurly/recurly-client-ruby/pull/647) ([douglasmiller](https://github.com/douglasmiller))
+
+## [3.14.0](https://github.com/recurly/recurly-client-ruby/tree/3.14.0) (2020-10-20)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.13.0...3.14.0)
 
 **Implemented enhancements:**
 

data/GETTING_STARTED.md

@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '~> 3.14'
+gem 'recurly', '~> 3.15'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/client/operations.rb

@@ -444,6 +444,103 @@ module Recurly
       delete(path, **options)
     end
 
+    # Get the list of billing information associated with an account
+    #
+    # {https://developers.recurly.com/api/v2019-10-10#operation/list_billing_infos list_billing_infos api documenation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param ids [String] 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 sort [String] 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 begin_time [DateTime] Inclusively filter by begin_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.
+    #
+    # @param 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.
+    #
+    # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
+    #
+    # @return [Pager<Resources::BillingInfo>] A list of the the billing information for an account's
+    #
+    def list_billing_infos(account_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/billing_infos", account_id: account_id)
+      pager(path, **options)
+    end
+
+    # Set an account's billing information when the wallet feature is enabled
+    #
+    # {https://developers.recurly.com/api/v2019-10-10#operation/create_billing_info create_billing_info api documenation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
+    # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
+    #
+    # @return [Resources::BillingInfo] Updated billing information.
+    #
+    def create_billing_info(account_id:, body:, **options)
+      path = interpolate_path("/accounts/{account_id}/billing_infos", account_id: account_id)
+      post(path, body, Requests::BillingInfoCreate, **options)
+    end
+
+    # Fetch a billing info
+    #
+    # {https://developers.recurly.com/api/v2019-10-10#operation/get_a_billing_info get_a_billing_info api documenation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param billing_info_id [String] Billing Info ID.
+    # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
+    #
+    # @return [Resources::BillingInfo] A billing info.
+    #
+    def get_a_billing_info(account_id:, billing_info_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: account_id, billing_info_id: billing_info_id)
+      get(path, **options)
+    end
+
+    # Update an account's billing information
+    #
+    # {https://developers.recurly.com/api/v2019-10-10#operation/update_a_billing_info update_a_billing_info api documenation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param billing_info_id [String] Billing Info ID.
+    # @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
+    # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
+    #
+    # @return [Resources::BillingInfo] Updated billing information.
+    #
+    def update_a_billing_info(account_id:, billing_info_id:, body:, **options)
+      path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: account_id, billing_info_id: billing_info_id)
+      put(path, body, Requests::BillingInfoCreate, **options)
+    end
+
+    # Remove an account's billing information
+    #
+    # {https://developers.recurly.com/api/v2019-10-10#operation/remove_a_billing_info remove_a_billing_info api documenation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param billing_info_id [String] Billing Info ID.
+    # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
+    #
+    # @return [Resources::Empty] Billing information deleted
+    #
+    def remove_a_billing_info(account_id:, billing_info_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}", account_id: account_id, billing_info_id: billing_info_id)
+      delete(path, **options)
+    end
+
     # Show the coupon redemptions for an account
     #
     # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documenation}

data/lib/recurly/errors/api_errors.rb

@@ -26,6 +26,8 @@ module Recurly
 
     class InternalServerError < ServerError; end
 
+    class ServiceNotAvailableError < InternalServerError; end
+
     class BadGatewayError < ServerError; end
 
     class ServiceUnavailableError < ServerError; end

data/lib/recurly/requests/billing_info_create.rb

@@ -74,6 +74,10 @@ module Recurly
       #   @return [String] PayPal billing agreement ID
       define_attribute :paypal_billing_agreement_id, String
 
+      # @!attribute primary_payment_method
+      #   @return [Boolean] The `primary_payment_method` indicator is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` indicator. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
+      define_attribute :primary_payment_method, :Boolean
+
       # @!attribute routing_number
       #   @return [String] The bank's rounting number. (ACH only)
       define_attribute :routing_number, String

data/lib/recurly/requests/coupon_create.rb

@@ -6,6 +6,10 @@ module Recurly
   module Requests
     class CouponCreate < Request
 
+      # @!attribute applies_to_all_items
+      #   @return [Boolean] To apply coupon to Items in your Catalog, include a list of `item_codes` in the request that the coupon will apply to. Or set value to true to apply to all Items in your Catalog. The following values are not permitted when `applies_to_all_items` is included: `free_trial_amount` and `free_trial_unit`.
+      define_attribute :applies_to_all_items, :Boolean
+
       # @!attribute applies_to_all_plans
       #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
       define_attribute :applies_to_all_plans, :Boolean
@@ -54,6 +58,10 @@ module Recurly
       #   @return [String] Description of the coupon on the invoice.
       define_attribute :invoice_description, String
 
+      # @!attribute item_codes
+      #   @return [Array[String]] List of item codes to which this coupon applies. Sending `item_codes` is only permitted when `applies_to_all_items` is set to false. The following values are not permitted when `item_codes` is included: `free_trial_amount` and `free_trial_unit`.
+      define_attribute :item_codes, Array, { :item_type => String }
+
       # @!attribute max_redemptions
       #   @return [Integer] A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
       define_attribute :max_redemptions, Integer

data/lib/recurly/requests/invoice_collect.rb

@@ -6,6 +6,10 @@ module Recurly
   module Requests
     class InvoiceCollect < Request
 
+      # @!attribute billing_info_id
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info.
+      define_attribute :billing_info_id, String
+
       # @!attribute three_d_secure_action_result_token_id
       #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
       define_attribute :three_d_secure_action_result_token_id, String

data/lib/recurly/requests/subscription_update.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [Boolean] Whether the subscription renews at the end of its term.
       define_attribute :auto_renew, :Boolean
 
+      # @!attribute billing_info_id
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info.
+      define_attribute :billing_info_id, String
+
       # @!attribute collection_method
       #   @return [String] Change collection method
       define_attribute :collection_method, String

data/lib/recurly/resources/billing_info.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [PaymentMethod]
       define_attribute :payment_method, :PaymentMethod
 
+      # @!attribute primary_payment_method
+      #   @return [Boolean] The `primary_payment_method` indicator is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` indicator. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
+      define_attribute :primary_payment_method, :Boolean
+
       # @!attribute updated_at
       #   @return [DateTime] When the billing information was last changed.
       define_attribute :updated_at, DateTime

data/lib/recurly/resources/coupon.rb

@@ -6,6 +6,10 @@ module Recurly
   module Resources
     class Coupon < Resource
 
+      # @!attribute applies_to_all_items
+      #   @return [Boolean] The coupon is valid for all items if true. If false then `items` will list the applicable items.
+      define_attribute :applies_to_all_items, :Boolean
+
       # @!attribute applies_to_all_plans
       #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
       define_attribute :applies_to_all_plans, :Boolean
@@ -66,6 +70,10 @@ module Recurly
       #   @return [String] Description of the coupon on the invoice.
       define_attribute :invoice_description, String
 
+      # @!attribute items
+      #   @return [Array[ItemMini]] A list of items for which this coupon applies. This will be `null` if `applies_to_all_items=true`.
+      define_attribute :items, Array, { :item_type => :ItemMini }
+
       # @!attribute max_redemptions
       #   @return [Integer] A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
       define_attribute :max_redemptions, Integer

data/lib/recurly/resources/invoice.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [Float] The outstanding balance remaining on this invoice.
       define_attribute :balance, Float
 
+      # @!attribute billing_info_id
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info.
+      define_attribute :billing_info_id, String
+
       # @!attribute closed_at
       #   @return [DateTime] Date invoice was marked paid or failed.
       define_attribute :closed_at, DateTime

data/lib/recurly/resources/subscription.rb

@@ -30,6 +30,10 @@ module Recurly
       #   @return [DateTime] Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared.
       define_attribute :bank_account_authorized_at, DateTime
 
+      # @!attribute billing_info_id
+      #   @return [String] Billing Info ID.
+      define_attribute :billing_info_id, String
+
       # @!attribute canceled_at
       #   @return [DateTime] Canceled at
       define_attribute :canceled_at, DateTime

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.14.0"
+  VERSION = "3.15.0"
 end

data/openapi/api.yaml

@@ -1974,8 +1974,8 @@ paths:
       summary: Set an account's billing information
       description: |
         If you're using Recurly.js to securely submit data from webforms without sending it through your server,
-        you can associate the billing information with an account by passing in the `token_id`. Be sure to only
-        set this field.
+        you can associate the billing information with an account by passing in the `token_id`. The only other
+        field permitted with `token_id` is `primary_payment_method`.
 
         For credit card payments you'll need the following required fields:
 
@@ -2250,6 +2250,221 @@ 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(\"Removed Billing
           Info: %v\", billingInfo)"
+  "/sites/{site_id}/accounts/{account_id}/billing_infos":
+    get:
+      tags:
+      - account
+      - billing_info
+      operationId: list_billing_infos
+      summary: Get the list of billing information associated with an account
+      description: See the [Pagination Guide](/guides/pagination.html) to learn how
+        to use pagination in the API and Client Libraries.
+      parameters:
+      - "$ref": "#/components/parameters/site_id"
+      - "$ref": "#/components/parameters/account_id"
+      - "$ref": "#/components/parameters/ids"
+      - "$ref": "#/components/parameters/sort_dates"
+      - "$ref": "#/components/parameters/filter_begin_time"
+      - "$ref": "#/components/parameters/filter_end_time"
+      responses:
+        '200':
+          description: A list of the the billing information for an account's
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/BillingInfoList"
+        '400':
+          description: Invalid or unpermitted parameter
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site or account
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+    post:
+      tags:
+      - account
+      - billing_info
+      operationId: create_billing_info
+      summary: Set an account's billing information when the wallet feature is enabled
+      description: |
+        If you're using Recurly.js to securely submit data from webforms without sending it through your server,
+        you can associate the billing information with an account by passing in the `token_id`. The only other
+        field permitted with `token_id` is `primary_payment_method`.
+
+        For credit card payments you'll need the following required fields:
+
+        - first_name
+        - last_name
+        - number
+        - month
+        - year
+
+        For external (not Recurly.js) tokenized payments you'll need the following required fields:
+
+        - first_name
+        - last_name
+        - gateway_token
+        - gateway_code
+      parameters:
+      - "$ref": "#/components/parameters/site_id"
+      - "$ref": "#/components/parameters/account_id"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/BillingInfoCreate"
+        required: true
+      responses:
+        '200':
+          description: Updated billing information.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/BillingInfo"
+        '400':
+          description: Bad request, perhaps invalid JSON?
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site or account ID.
+          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}":
+    get:
+      tags:
+      - account
+      - billing_info
+      operationId: get_a_billing_info
+      summary: Fetch a billing info
+      parameters:
+      - "$ref": "#/components/parameters/site_id"
+      - "$ref": "#/components/parameters/account_id"
+      - "$ref": "#/components/parameters/billing_info_id"
+      responses:
+        '200':
+          description: A billing info.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/BillingInfo"
+        '404':
+          description: Incorrect site, account, or billing info ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+    put:
+      tags:
+      - account
+      - billing_info
+      operationId: update_a_billing_info
+      summary: Update an account's billing information
+      description: |
+        If you're using Recurly.js to securely submit data from webforms without sending it through your server,
+        you can associate the billing information with an account by passing in the `token_id`. The only other
+        field permitted with `token_id` is `primary_payment_method`.
+
+        For credit card payments you'll need the following required fields:
+
+        - first_name
+        - last_name
+        - number
+        - month
+        - year
+
+        For external (not Recurly.js) tokenized payments you'll need the following required fields:
+
+        - first_name
+        - last_name
+        - gateway_token
+        - gateway_code
+      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/BillingInfoCreate"
+        required: true
+      responses:
+        '200':
+          description: Updated billing information.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/BillingInfo"
+        '400':
+          description: Bad request, perhaps invalid JSON?
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site or account ID.
+          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: []
+    delete:
+      tags:
+      - account
+      - billing_info
+      operationId: remove_a_billing_info
+      summary: Remove an account's billing information
+      parameters:
+      - "$ref": "#/components/parameters/site_id"
+      - "$ref": "#/components/parameters/account_id"
+      - "$ref": "#/components/parameters/billing_info_id"
+      description: You may remove any stored billing information for an account. If
+        the account has a subscription, the renewal will go into dunning unless the
+        billing information is updated before the renewal occurs.
+      responses:
+        '204':
+          description: Billing information deleted
+        '404':
+          description: Account has no billing information, or incorrect site or account
+            ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Billing info cannot be deleted. Please set a new primary billing
+            info before deleting this billing info
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/sites/{site_id}/accounts/{account_id}/coupon_redemptions":
     get:
       tags:
@@ -13933,6 +14148,13 @@ components:
       required: true
       schema:
         type: string
+    billing_info_id:
+      name: billing_info_id
+      in: path
+      description: Billing Info ID.
+      required: true
+      schema:
+        type: string
     usage_id:
       name: usage_id
       in: path
@@ -14360,6 +14582,23 @@ components:
           type: array
           items:
             "$ref": "#/components/schemas/AddOn"
+    BillingInfoList:
+      type: object
+      properties:
+        object:
+          type: string
+          title: Object type
+          description: Will always be List.
+        has_more:
+          type: boolean
+          description: Indicates there are more results on subsequent pages.
+        next:
+          type: string
+          description: Path to subsequent page of results.
+        data:
+          type: array
+          items:
+            "$ref": "#/components/schemas/BillingInfo"
     CreditPaymentList:
       type: object
       properties:
@@ -15717,6 +15956,16 @@ components:
             risk_rules_triggered:
               type: object
               title: Kount rules
+        primary_payment_method:
+          type: boolean
+          description: The `primary_payment_method` indicator is used to designate
+            the primary billing info on the account. The first billing info created
+            on an account will always become primary. Adding additional billing infos
+            provides the flexibility to mark another billing info as primary, or adding
+            additional non-primary billing infos. This can be accomplished by passing
+            the `primary_payment_method` indicator. When adding billing infos via
+            the billing_info and /accounts endpoints, this value is not permitted,
+            and will return an error if provided.
         created_at:
           type: string
           format: date-time
@@ -15857,6 +16106,17 @@ components:
           - checking
           - savings
           description: The bank account type. (ACH only)
+        primary_payment_method:
+          type: boolean
+          title: Primary Payment Method
+          description: The `primary_payment_method` indicator is used to designate
+            the primary billing info on the account. The first billing info created
+            on an account will always become primary. Adding additional billing infos
+            provides the flexibility to mark another billing info as primary, or adding
+            additional non-primary billing infos. This can be accomplished by passing
+            the `primary_payment_method` indicator. When adding billing infos via
+            the billing_info and /accounts endpoints, this value is not permitted,
+            and will return an error if provided.
     Coupon:
       type: object
       properties:
@@ -15955,6 +16215,13 @@ components:
           description: The coupon is valid for all plans if true. If false then `plans`
             and `plans_names` will list the applicable plans.
           default: true
+        applies_to_all_items:
+          type: boolean
+          title: Applies to all items?
+          description: |
+            The coupon is valid for all items if true. If false then `items`
+            will list the applicable items.
+          default: false
         applies_to_non_plan_charges:
           type: boolean
           title: Applied to all non-plan charges?
@@ -15973,6 +16240,14 @@ components:
             `null` if `applies_to_all_plans=true`.
           items:
             "$ref": "#/components/schemas/PlanMini"
+        items:
+          type: array
+          title: Items
+          description: |
+            A list of items for which this coupon applies. This will be
+            `null` if `applies_to_all_items=true`.
+          items:
+            "$ref": "#/components/schemas/ItemMini"
         redemption_resource:
           type: string
           title: Redemption resource
@@ -16101,6 +16376,16 @@ components:
               The coupon is valid for all plans if true. If false then
               `plans` and `plans_names` will list the applicable plans.
             default: true
+          applies_to_all_items:
+            type: boolean
+            title: Applies to all items?
+            description: |
+              To apply coupon to Items in your Catalog, include a list
+              of `item_codes` in the request that the coupon will apply to. Or set value
+              to true to apply to all Items in your Catalog. The following values
+              are not permitted when `applies_to_all_items` is included: `free_trial_amount`
+              and `free_trial_unit`.
+            default: false
           plan_codes:
             type: array
             title: Plan codes
@@ -16110,6 +16395,16 @@ components:
               when `applies_to_all_plans` is true.
             items:
               type: string
+          item_codes:
+            type: array
+            title: Item codes
+            description: |
+              List of item codes to which this coupon applies. Sending
+              `item_codes` is only permitted when `applies_to_all_items` is set to false.
+              The following values are not permitted when `item_codes` is included:
+              `free_trial_amount` and `free_trial_unit`.
+            items:
+              type: string
           duration:
             type: string
             title: Duration
@@ -16926,6 +17221,13 @@ components:
           - voided
         account:
           "$ref": "#/components/schemas/AccountMini"
+        billing_info_id:
+          type: string
+          title: Billing info ID
+          description: The `billing_info_id` is the value that represents a specific
+            billing info for an end customer. When `billing_info_id` is used to assign
+            billing info to the subscription, all future billing events for the subscription
+            will bill to the specified billing info.
         subscription_ids:
           type: array
           title: Subscription IDs
@@ -17167,6 +17469,13 @@ components:
             mail order and telephone transactions.
           enum:
           - moto
+        billing_info_id:
+          type: string
+          title: Billing Info ID
+          description: The `billing_info_id` is the value that represents a specific
+            billing info for an end customer. When `billing_info_id` is used to assign
+            billing info to the subscription, all future billing events for the subscription
+            will bill to the specified billing info.
     InvoiceCollection:
       type: object
       title: Invoice collection
@@ -19165,6 +19474,10 @@ components:
             set. This timestamp is used for alerting customers to reauthorize in 3
             years in accordance with NACHA rules. If a subscription becomes inactive
             or the billing info is no longer a bank account, this timestamp is cleared.
+        billing_info_id:
+          type: string
+          title: Billing Info ID
+          description: Billing Info ID.
     SubscriptionAddOn:
       type: object
       title: Subscription Add-on
@@ -19957,6 +20270,13 @@ components:
           default: 0
         shipping:
           "$ref": "#/components/schemas/SubscriptionShippingUpdate"
+        billing_info_id:
+          type: string
+          title: Billing Info ID
+          description: The `billing_info_id` is the value that represents a specific
+            billing info for an end customer. When `billing_info_id` is used to assign
+            billing info to the subscription, all future billing events for the subscription
+            will bill to the specified billing info.
     SubscriptionPause:
       type: object
       properties:
@@ -20789,6 +21109,7 @@ components:
           - invalid_permissions
           - invalid_token
           - not_found
+          - service_not_available
           - simultaneous_request
           - transaction
           - unauthorized

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 3.14.0
+  version: 3.15.0
 platform: ruby
 authors:
 - Recurly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -293,7 +293,7 @@ metadata:
   changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
   documentation_uri: https://recurly.github.io/recurly-client-ruby/
   homepage_uri: https://github.com/recurly/recurly-client-ruby
-  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.14.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.15.0
 post_install_message:
 rdoc_options: []
 require_paths: