recurly 4.28.0 → 4.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16800abba256fceed49ee4141796878faa9b1d10c97752fd18e05ae6f7be3761
-  data.tar.gz: 8fcb048d891ab4ae3c6a401cdaf343d1889bd53337b976ca0d86616d53ae8706
+  metadata.gz: 390709441aca5c09d9488d70631d5ff3a14d9df4e6d56d8604f615f421331e85
+  data.tar.gz: c9a9c5d0b0c8b697f0a2261c431f7018e87eed5246c06ade654f7987a8bfde81
 SHA512:
-  metadata.gz: c108d83003c365f301e93d255078a067ff6ecf440ba1efc3d5e0de61d40be977b5de1f1668d4661c927aeb8d8650d4d49765f6be2c9206d4545fc0315a29becf
-  data.tar.gz: d1fc3157a45ac11d9e790d2510e7de1496a5549f1dd827b973ea69a056329b8a3b01b725c7b956a3ecbba896c03415316f29b94710408676a404e9ded6e5641a
+  metadata.gz: e9d31be321f4acaf50a1fcabddd241b37228a11685e547ebbd9549474a2488ccb6e83e552e78cfad1b2fd9a543c697b0bd9d73507f7ec536a65ed2022ab1c758
+  data.tar.gz: e767216dc486c50859f051d5788fd1b28a86950d1f178bad2ee4c9baf18ff4d20d7cf58be6bd25f2f7433257997c352c09587951109d0de4a615203d4f27638a

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.30.0](https://github.com/recurly/recurly-client-ruby/tree/4.30.0) (2023-02-22)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.29.0...4.30.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#829](https://github.com/recurly/recurly-client-ruby/pull/829) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.29.0](https://github.com/recurly/recurly-client-ruby/tree/4.29.0) (2023-02-07)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.28.0...4.29.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (GiftCard endpoints and new transaction error support) [#827](https://github.com/recurly/recurly-client-ruby/pull/827) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.28.0](https://github.com/recurly/recurly-client-ruby/tree/4.28.0) (2023-01-19)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.27.0...4.28.0)

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', '~> 4.28'
+gem 'recurly', '~> 4.30'
 ```
 
 > *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

@@ -4215,5 +4215,75 @@ module Recurly
       path = interpolate_path("/accounts/{account_id}/external_subscriptions", account_id: account_id)
       pager(path, **options)
     end
+
+    # List gift cards
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_gift_cards list_gift_cards api documentation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Pager<Resources::GiftCard>] List of all created gift cards on your site.
+    #
+    def list_gift_cards(**options)
+      path = "/gift_cards"
+      pager(path, **options)
+    end
+
+    # Create gift card
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_gift_card create_gift_card api documentation}
+    #
+    # @param body [Requests::GiftCardCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::GiftCardCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::GiftCard] Returns the gift card
+    #
+    def create_gift_card(body:, **options)
+      path = "/gift_cards"
+      post(path, body, Requests::GiftCardCreate, **options)
+    end
+
+    # Fetch a gift card
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_gift_card get_gift_card api documentation}
+    #
+    # @param gift_card_id [String] Gift Card ID, e.g. +e28zov4fw0v2+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::GiftCard] Gift card details
+    #
+    def get_gift_card(gift_card_id:, **options)
+      path = interpolate_path("/gift_cards/{gift_card_id}", gift_card_id: gift_card_id)
+      get(path, **options)
+    end
+
+    # Preview gift card
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/preview_gift_card preview_gift_card api documentation}
+    #
+    # @param body [Requests::GiftCardCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::GiftCardCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::GiftCard] Returns the gift card
+    #
+    def preview_gift_card(body:, **options)
+      path = "/gift_cards/preview"
+      post(path, body, Requests::GiftCardCreate, **options)
+    end
+
+    # Redeem gift card
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/redeem_gift_card redeem_gift_card api documentation}
+    #
+    # @param redemption_code [String] Gift Card redemption code, e.g., +N1A2T8IRXSCMO40V+.
+    # @param body [Requests::GiftCardRedeem] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::GiftCardRedeem}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::GiftCard] Redeems and returns the gift card
+    #
+    def redeem_gift_card(redemption_code:, body:, **options)
+      path = interpolate_path("/gift_cards/{redemption_code}/redeem", redemption_code: redemption_code)
+      post(path, body, Requests::GiftCardRedeem, **options)
+    end
   end
 end

data/lib/recurly/requests/account_reference.rb

@@ -0,0 +1,18 @@
+# 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.
+module Recurly
+  module Requests
+    class AccountReference < Request
+
+      # @!attribute code
+      #   @return [String]
+      define_attribute :code, String
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+    end
+  end
+end

data/lib/recurly/requests/gift_card_create.rb

@@ -0,0 +1,30 @@
+# 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.
+module Recurly
+  module Requests
+    class GiftCardCreate < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute delivery
+      #   @return [GiftCardDeliveryCreate] The delivery details for the gift card.
+      define_attribute :delivery, :GiftCardDeliveryCreate
+
+      # @!attribute gifter_account
+      #   @return [AccountPurchase] Block of account details for the gifter. This references an existing account_code.
+      define_attribute :gifter_account, :AccountPurchase
+
+      # @!attribute product_code
+      #   @return [String] The product code or SKU of the gift card product.
+      define_attribute :product_code, String
+
+      # @!attribute unit_amount
+      #   @return [Float] The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/gift_card_delivery_create.rb

@@ -0,0 +1,42 @@
+# 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.
+module Recurly
+  module Requests
+    class GiftCardDeliveryCreate < Request
+
+      # @!attribute deliver_at
+      #   @return [DateTime] When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.
+      define_attribute :deliver_at, DateTime
+
+      # @!attribute email_address
+      #   @return [String] The email address of the recipient. Required if `method` is `email`.
+      define_attribute :email_address, String
+
+      # @!attribute first_name
+      #   @return [String] The first name of the recipient.
+      define_attribute :first_name, String
+
+      # @!attribute gifter_name
+      #   @return [String] The name of the gifter for the purpose of a message displayed to the recipient.
+      define_attribute :gifter_name, String
+
+      # @!attribute last_name
+      #   @return [String] The last name of the recipient.
+      define_attribute :last_name, String
+
+      # @!attribute method
+      #   @return [String] Whether the delivery method is email or postal service.
+      define_attribute :method, String
+
+      # @!attribute personal_message
+      #   @return [String] The personal message from the gifter to the recipient.
+      define_attribute :personal_message, String
+
+      # @!attribute recipient_address
+      #   @return [Address] Address information for the recipient. Required if `method` is `post`.
+      define_attribute :recipient_address, :Address
+    end
+  end
+end

data/lib/recurly/requests/gift_card_redeem.rb

@@ -0,0 +1,14 @@
+# 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.
+module Recurly
+  module Requests
+    class GiftCardRedeem < Request
+
+      # @!attribute recipient_account
+      #   @return [AccountReference] The account for the recipient of the gift card.
+      define_attribute :recipient_account, :AccountReference
+    end
+  end
+end

data/lib/recurly/requests/subscription_create.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
       define_attribute :customer_notes, String
 
+      # @!attribute gift_card_redemption_code
+      #   @return [String] A gift card redemption code to be redeemed on the purchase invoice.
+      define_attribute :gift_card_redemption_code, String
+
       # @!attribute net_terms
       #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
       define_attribute :net_terms, Integer

data/lib/recurly/resources/custom_field_definition.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :updated_at, DateTime
 
       # @!attribute user_access
-      #   @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
+      #   @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
       define_attribute :user_access, String
     end
   end

data/lib/recurly/resources/external_subscription.rb

@@ -30,14 +30,14 @@ module Recurly
       #   @return [DateTime] When the external subscription expires in the external platform.
       define_attribute :expires_at, DateTime
 
+      # @!attribute external_id
+      #   @return [String] The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.
+      define_attribute :external_id, String
+
       # @!attribute external_product_reference
       #   @return [ExternalProductReferenceMini] External Product Reference details
       define_attribute :external_product_reference, :ExternalProductReferenceMini
 
-      # @!attribute external_resource
-      #   @return [ExternalResourceMini] External Resource mini details
-      define_attribute :external_resource, :ExternalResourceMini
-
       # @!attribute id
       #   @return [String] System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
       define_attribute :id, String
@@ -54,6 +54,10 @@ module Recurly
       #   @return [Integer] An indication of the quantity of a subscribed item's quantity.
       define_attribute :quantity, Integer
 
+      # @!attribute state
+      #   @return [String] External subscriptions can be active, canceled, expired, or future.
+      define_attribute :state, String
+
       # @!attribute updated_at
       #   @return [DateTime] When the external subscription was updated in Recurly.
       define_attribute :updated_at, DateTime

data/lib/recurly/resources/gift_card.rb

@@ -0,0 +1,78 @@
+# 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.
+module Recurly
+  module Resources
+    class GiftCard < Resource
+
+      # @!attribute balance
+      #   @return [Float] The remaining credit on the recipient account associated with this gift card. Only has a value once the gift card has been redeemed. Can be used to create gift card balance displays for your customers.
+      define_attribute :balance, Float
+
+      # @!attribute canceled_at
+      #   @return [DateTime] When the gift card was canceled.
+      define_attribute :canceled_at, DateTime
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute delivered_at
+      #   @return [DateTime] When the gift card was sent to the recipient by Recurly via email, if method was email and the "Gift Card Delivery" email template was enabled. This will be empty for post delivery or email delivery where the email template was disabled.
+      define_attribute :delivered_at, DateTime
+
+      # @!attribute delivery
+      #   @return [GiftCardDelivery] The delivery details for the gift card.
+      define_attribute :delivery, :GiftCardDelivery
+
+      # @!attribute gifter_account_id
+      #   @return [String] The ID of the account that purchased the gift card.
+      define_attribute :gifter_account_id, String
+
+      # @!attribute id
+      #   @return [String] Gift card ID
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute product_code
+      #   @return [String] The product code or SKU of the gift card product.
+      define_attribute :product_code, String
+
+      # @!attribute purchase_invoice_id
+      #   @return [String] The ID of the invoice for the gift card purchase made by the gifter.
+      define_attribute :purchase_invoice_id, String
+
+      # @!attribute recipient_account_id
+      #   @return [String] The ID of the account that redeemed the gift card redemption code.  Does not have a value until gift card is redeemed.
+      define_attribute :recipient_account_id, String
+
+      # @!attribute redeemed_at
+      #   @return [DateTime] When the gift card was redeemed by the recipient.
+      define_attribute :redeemed_at, DateTime
+
+      # @!attribute redemption_code
+      #   @return [String] The unique redemption code for the gift card, generated by Recurly. Will be 16 characters, alphanumeric, displayed uppercase, but accepted in any case at redemption. Used by the recipient account to create a credit in the amount of the `unit_amount` on their account.
+      define_attribute :redemption_code, String
+
+      # @!attribute redemption_invoice_id
+      #   @return [String] The ID of the invoice for the gift card redemption made by the recipient.  Does not have a value until gift card is redeemed.
+      define_attribute :redemption_invoice_id, String
+
+      # @!attribute unit_amount
+      #   @return [Float] The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
+      define_attribute :unit_amount, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/gift_card_delivery.rb

@@ -0,0 +1,42 @@
+# 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.
+module Recurly
+  module Resources
+    class GiftCardDelivery < Resource
+
+      # @!attribute deliver_at
+      #   @return [DateTime] When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.
+      define_attribute :deliver_at, DateTime
+
+      # @!attribute email_address
+      #   @return [String] The email address of the recipient.
+      define_attribute :email_address, String
+
+      # @!attribute first_name
+      #   @return [String] The first name of the recipient.
+      define_attribute :first_name, String
+
+      # @!attribute gifter_name
+      #   @return [String] The name of the gifter for the purpose of a message displayed to the recipient.
+      define_attribute :gifter_name, String
+
+      # @!attribute last_name
+      #   @return [String] The last name of the recipient.
+      define_attribute :last_name, String
+
+      # @!attribute method
+      #   @return [String] Whether the delivery method is email or postal service.
+      define_attribute :method, String
+
+      # @!attribute personal_message
+      #   @return [String] The personal message from the gifter to the recipient.
+      define_attribute :personal_message, String
+
+      # @!attribute recipient_address
+      #   @return [Address] Address information for the recipient.
+      define_attribute :recipient_address, :Address
+    end
+  end
+end

data/lib/recurly/resources/subscription.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] Collection method
       define_attribute :collection_method, String
 
+      # @!attribute converted_at
+      #   @return [DateTime] When the subscription was converted from a gift card.
+      define_attribute :converted_at, DateTime
+
       # @!attribute coupon_redemptions
       #   @return [Array[CouponRedemptionMini]] Returns subscription level coupon redemptions that are tied to this subscription.
       define_attribute :coupon_redemptions, Array, { :item_type => :CouponRedemptionMini }
@@ -150,6 +154,10 @@ module Recurly
       #   @return [SubscriptionShipping] Subscription shipping details
       define_attribute :shipping, :SubscriptionShipping
 
+      # @!attribute started_with_gift
+      #   @return [Boolean] Whether the subscription was started with a gift certificate.
+      define_attribute :started_with_gift, :Boolean
+
       # @!attribute state
       #   @return [String] State
       define_attribute :state, String

data/lib/recurly/resources/transaction_error.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [String] Code
       define_attribute :code, String
 
+      # @!attribute decline_code
+      #   @return [String] Decline code
+      define_attribute :decline_code, String
+
       # @!attribute merchant_advice
       #   @return [String] Merchant message
       define_attribute :merchant_advice, String

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.28.0"
+  VERSION = "4.30.0"
 end

data/openapi/api.yaml

@@ -201,6 +201,7 @@ x-tagGroups:
   - automated_exports
   - external_subscriptions
   - external_products
+  - gift_cards
 - name: Products and Promotions
   tags:
   - item
@@ -227,8 +228,8 @@ tags:
   x-displayName: Site
 - name: custom_field_definition
   x-displayName: Custom Field Definition
-  description: Describes the fields that can use used as custom fields on accounts
-    or subscriptions.
+  description: Describes the fields that can be used as custom fields on accounts,
+    items, line-items (one time charges), plans, or subscriptions.
 - name: item
   x-displayName: Item
   description: |-
@@ -350,6 +351,10 @@ tags:
   description: A product from an external resource that is not managed by the Recurly
     platform and instead is managed by third-party platforms like Apple App Store
     and Google Play Store.
+- name: gift_cards
+  x-displayName: Gift Cards
+  description: Add gift card purchases to your checkout and allow gift card recipients
+    to redeem the gift card for credit towards any of your products.
 paths:
   "/sites":
     get:
@@ -15402,6 +15407,175 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/gift_cards":
+    get:
+      tags:
+      - gift_cards
+      operationId: list_gift_cards
+      summary: List gift cards
+      responses:
+        '200':
+          description: List of all created gift cards on your site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/GiftCardList"
+        '404':
+          description: Incorrect site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+    post:
+      tags:
+      - gift_cards
+      operationId: create_gift_card
+      summary: Create gift card
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/GiftCardCreate"
+        required: true
+      responses:
+        '201':
+          description: Returns the gift card
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/GiftCard"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Gift card cannot be completed for the specified reason.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/gift_cards/{gift_card_id}":
+    parameters:
+    - "$ref": "#/components/parameters/gift_card_id"
+    get:
+      tags:
+      - gift_cards
+      operationId: get_gift_card
+      summary: Fetch a gift card
+      responses:
+        '200':
+          description: Gift card details
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/GiftCard"
+        '404':
+          description: Incorrect site or gift card ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/gift_cards/preview":
+    post:
+      tags:
+      - gift_cards
+      operationId: preview_gift_card
+      summary: Preview gift card
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/GiftCardCreate"
+        required: true
+      responses:
+        '201':
+          description: Returns the gift card
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/GiftCard"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Gift card cannot be completed for the specified reason.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/gift_cards/{redemption_code}/redeem":
+    parameters:
+    - "$ref": "#/components/parameters/redemption_code"
+    post:
+      tags:
+      - gift_cards
+      operationId: redeem_gift_card
+      summary: Redeem gift card
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/GiftCardRedeem"
+        required: true
+      responses:
+        '201':
+          description: Redeems and returns the gift card
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/GiftCard"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Gift card cannot be redeemed for the specified reason.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
 servers:
 - url: https://v3.recurly.com
 - url: https://v3.eu.recurly.com
@@ -15576,6 +15750,20 @@ components:
       required: true
       schema:
         type: string
+    gift_card_id:
+      name: gift_card_id
+      in: path
+      description: Gift Card ID, e.g. `e28zov4fw0v2`.
+      required: true
+      schema:
+        type: string
+    redemption_code:
+      name: redemption_code
+      in: path
+      description: Gift Card redemption code, e.g., `N1A2T8IRXSCMO40V`.
+      required: true
+      schema:
+        type: string
     ids:
       name: ids
       in: query
@@ -16257,6 +16445,15 @@ components:
         required:
         - code
       - "$ref": "#/components/schemas/AccountUpdate"
+    AccountReference:
+      type: object
+      properties:
+        id:
+          type: string
+          maxLength: 13
+        code:
+          type: string
+          maxLength: 50
     AccountUpdate:
       type: object
       properties:
@@ -18014,6 +18211,7 @@ components:
             - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but
               editing will only be available via the API.
             - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
+            - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
           "$ref": "#/components/schemas/UserAccessEnum"
         display_name:
           type: string
@@ -20721,6 +20919,16 @@ components:
             subscription.
           maxLength: 13
           readOnly: true
+        started_with_gift:
+          type: boolean
+          default: false
+          description: Whether the subscription was started with a gift certificate.
+          title: Started with Gift
+        converted_at:
+          type: string
+          format: date-time
+          description: When the subscription was converted from a gift card.
+          title: Converted at
     SubscriptionAddOn:
       type: object
       title: Subscription Add-on
@@ -21433,6 +21641,11 @@ components:
             created by this request. Supports 'moto' value, which is the acronym for
             mail order and telephone transactions.
           "$ref": "#/components/schemas/GatewayTransactionTypeEnum"
+        gift_card_redemption_code:
+          type: string
+          title: Gift card Redemption Code
+          description: A gift card redemption code to be redeemed on the purchase
+            invoice.
       required:
       - plan_code
       - currency
@@ -22634,10 +22847,13 @@ components:
           title: Object type
         account:
           "$ref": "#/components/schemas/AccountMini"
-        external_resource:
-          "$ref": "#/components/schemas/ExternalResourceMini"
         external_product_reference:
           "$ref": "#/components/schemas/ExternalProductReferenceMini"
+        external_id:
+          type: string
+          title: External Id
+          description: The id of the subscription in the external systems., I.e. Apple
+            App Store or Google Play Store.
         last_purchased:
           type: string
           format: date-time
@@ -22660,6 +22876,10 @@ components:
           description: An indication of the quantity of a subscribed item's quantity.
           default: 1
           minimum: 0
+        state:
+          type: string
+          description: External subscriptions can be active, canceled, expired, or
+            future.
         activated_at:
           type: string
           format: date-time
@@ -22698,25 +22918,6 @@ components:
           type: array
           items:
             "$ref": "#/components/schemas/ExternalSubscription"
-    ExternalResourceMini:
-      type: object
-      title: External Resource mini details
-      properties:
-        id:
-          type: string
-          title: External resource ID
-          description: System-generated unique identifier for an external resource
-            ID, e.g. `e28zov4fw0v2`.
-        object:
-          type: string
-          title: Object type
-        external_object_reference:
-          type: string
-          title: External Object Reference
-          description: Identifier or URL reference where the resource is canonically
-            available in the external platform.
-          maxLength: 255
-          readOnly: true
     CustomerPermission:
       type: object
       properties:
@@ -22850,6 +23051,262 @@ components:
           type: string
           description: Username of the associated payment method. Currently only associated
             with Venmo.
+    GiftCardList:
+      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/GiftCard"
+    GiftCard:
+      type: object
+      description: Gift card details
+      properties:
+        id:
+          title: Gift card ID
+          type: string
+          maxLength: 13
+          readOnly: true
+        object:
+          title: Object type
+          type: string
+          readOnly: true
+        gifter_account_id:
+          title: Gifter account ID
+          type: string
+          maxLength: 13
+          description: The ID of the account that purchased the gift card.
+        recipient_account_id:
+          title: Recipient account ID
+          type: string
+          maxLength: 13
+          description: The ID of the account that redeemed the gift card redemption
+            code.  Does not have a value until gift card is redeemed.
+        purchase_invoice_id:
+          title: Purchase invoice ID
+          type: string
+          maxLength: 13
+          description: The ID of the invoice for the gift card purchase made by the
+            gifter.
+        redemption_invoice_id:
+          title: Redemption invoice ID
+          type: string
+          maxLength: 13
+          description: The ID of the invoice for the gift card redemption made by
+            the recipient.  Does not have a value until gift card is redeemed.
+        redemption_code:
+          title: Redemption code
+          type: string
+          description: The unique redemption code for the gift card, generated by
+            Recurly. Will be 16 characters, alphanumeric, displayed uppercase, but
+            accepted in any case at redemption. Used by the recipient account to create
+            a credit in the amount of the `unit_amount` on their account.
+        balance:
+          title: Remaining balance
+          type: number
+          format: float
+          description: The remaining credit on the recipient account associated with
+            this gift card. Only has a value once the gift card has been redeemed.
+            Can be used to create gift card balance displays for your customers.
+        product_code:
+          title: Product code
+          type: string
+          description: The product code or SKU of the gift card product.
+        unit_amount:
+          title: Purchase unit amount
+          type: number
+          format: float
+          description: The amount of the gift card, which is the amount of the charge
+            to the gifter account and the amount of credit that is applied to the
+            recipient account upon successful redemption.
+        currency:
+          title: Currency
+          type: string
+          description: 3-letter ISO 4217 currency code.
+          maxLength: 3
+        delivery:
+          title: Delivery details
+          description: The delivery details for the gift card.
+          readOnly: true
+          "$ref": "#/components/schemas/GiftCardDelivery"
+        created_at:
+          type: string
+          format: date-time
+          title: Created at
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          title: Last updated at
+          readOnly: true
+        delivered_at:
+          type: string
+          format: date-time
+          title: Delivered at
+          readOnly: true
+          description: When the gift card was sent to the recipient by Recurly via
+            email, if method was email and the "Gift Card Delivery" email template
+            was enabled. This will be empty for post delivery or email delivery where
+            the email template was disabled.
+        redeemed_at:
+          type: string
+          format: date-time
+          title: Redeemed at
+          readOnly: true
+          description: When the gift card was redeemed by the recipient.
+        canceled_at:
+          type: string
+          format: date-time
+          title: Canceled at
+          readOnly: true
+          description: When the gift card was canceled.
+    GiftCardCreate:
+      type: object
+      description: Gift card details
+      properties:
+        product_code:
+          title: Product code
+          type: string
+          description: The product code or SKU of the gift card product.
+        unit_amount:
+          title: Purchase unit amount
+          type: number
+          format: float
+          description: The amount of the gift card, which is the amount of the charge
+            to the gifter account and the amount of credit that is applied to the
+            recipient account upon successful redemption.
+        currency:
+          title: Currency
+          type: string
+          description: 3-letter ISO 4217 currency code.
+          maxLength: 3
+        delivery:
+          title: Delivery details
+          description: The delivery details for the gift card.
+          readOnly: true
+          "$ref": "#/components/schemas/GiftCardDeliveryCreate"
+        gifter_account:
+          title: Gifter account details
+          description: Block of account details for the gifter. This references an
+            existing account_code.
+          readOnly: true
+          "$ref": "#/components/schemas/AccountPurchase"
+      required:
+      - product_code
+      - unit_amount
+      - currency
+      - delivery
+      - gifter_account
+    GiftCardDeliveryCreate:
+      type: object
+      description: Gift card delivery details
+      properties:
+        method:
+          title: Delivery method
+          description: Whether the delivery method is email or postal service.
+          "$ref": "#/components/schemas/DeliveryMethodEnum"
+        email_address:
+          title: Recipient email address
+          type: string
+          description: The email address of the recipient. Required if `method` is
+            `email`.
+        deliver_at:
+          type: string
+          format: date-time
+          title: Deliver at
+          readOnly: true
+          description: When the gift card should be delivered to the recipient. If
+            null, the gift card will be delivered immediately. If a datetime is provided,
+            the delivery will be in an hourly window, rounding down. For example,
+            6:23 pm will be in the 6:00 pm hourly batch.
+        first_name:
+          title: Recipient first name
+          type: string
+          description: The first name of the recipient.
+        last_name:
+          title: Recipient last name
+          type: string
+          description: The last name of the recipient.
+        recipient_address:
+          title: Recipient address
+          description: Address information for the recipient. Required if `method`
+            is `post`.
+          "$ref": "#/components/schemas/Address"
+        gifter_name:
+          title: Gifter name
+          type: string
+          description: The name of the gifter for the purpose of a message displayed
+            to the recipient.
+        personal_message:
+          title: Personal message
+          type: string
+          maxLength: 255
+          description: The personal message from the gifter to the recipient.
+      required:
+      - method
+    GiftCardDelivery:
+      type: object
+      description: Gift card delivery details
+      properties:
+        method:
+          title: Delivery method
+          description: Whether the delivery method is email or postal service.
+          "$ref": "#/components/schemas/DeliveryMethodEnum"
+        email_address:
+          title: Recipient email address
+          type: string
+          description: The email address of the recipient.
+        deliver_at:
+          type: string
+          format: date-time
+          title: Deliver at
+          readOnly: true
+          description: When the gift card should be delivered to the recipient. If
+            null, the gift card will be delivered immediately. If a datetime is provided,
+            the delivery will be in an hourly window, rounding down. For example,
+            6:23 pm will be in the 6:00 pm hourly batch.
+        first_name:
+          title: Recipient first name
+          type: string
+          description: The first name of the recipient.
+        last_name:
+          title: Recipient last name
+          type: string
+          description: The last name of the recipient.
+        recipient_address:
+          title: Recipient address
+          description: Address information for the recipient.
+          "$ref": "#/components/schemas/Address"
+        gifter_name:
+          title: Gifter name
+          type: string
+          description: The name of the gifter for the purpose of a message displayed
+            to the recipient.
+        personal_message:
+          title: Personal message
+          type: string
+          maxLength: 255
+          description: The personal message from the gifter to the recipient.
+    GiftCardRedeem:
+      type: object
+      description: The information necessary to redeem a gift card.
+      properties:
+        recipient_account:
+          title: Recipient account
+          description: The account for the recipient of the gift card.
+          "$ref": "#/components/schemas/AccountReference"
+      required:
+      - recipient_account
     Error:
       type: object
       properties:
@@ -22891,6 +23348,9 @@ components:
               code:
                 title: Code
                 "$ref": "#/components/schemas/ErrorCodeEnum"
+              decline_code:
+                title: Decline code
+                "$ref": "#/components/schemas/DeclineCodeEnum"
               message:
                 type: string
                 title: Customer message
@@ -23062,6 +23522,11 @@ components:
       enum:
       - parent
       - self
+    DeliveryMethodEnum:
+      type: string
+      enum:
+      - email
+      - post
     GatewayTransactionTypeEnum:
       type: string
       enum:
@@ -23197,6 +23662,7 @@ components:
       - api_only
       - read_only
       - write
+      - set_only
     PricingModelTypeEnum:
       type: string
       enum:
@@ -23699,6 +24165,38 @@ components:
       - unmapped_partner_error
       - vaultly_service_unavailable
       - zero_dollar_auth_not_supported
+    DeclineCodeEnum:
+      type: string
+      enum:
+      - account_closed
+      - call_issuer
+      - card_not_activated
+      - card_not_supported
+      - cardholder_requested_stop
+      - do_not_honor
+      - do_not_try_again
+      - exceeds_daily_limit
+      - generic_decline
+      - expired_card
+      - fraudulent
+      - insufficient_funds
+      - incorrect_address
+      - incorrect_security_code
+      - invalid_amount
+      - invalid_number
+      - invalid_transaction
+      - issuer_unavailable
+      - lifecycle_decline
+      - lost_card
+      - pickup_card
+      - policy_decline
+      - restricted_card
+      - restricted_card_chargeback
+      - security_decline
+      - stolen_card
+      - try_again
+      - update_cardholder_data
+      - requires_3d_secure
     ExportDates:
       type: object
       properties:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.28.0
+  version: 4.30.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,7 @@ files:
 - lib/recurly/requests/account_acquisition_update.rb
 - lib/recurly/requests/account_create.rb
 - lib/recurly/requests/account_purchase.rb
+- lib/recurly/requests/account_reference.rb
 - lib/recurly/requests/account_update.rb
 - lib/recurly/requests/add_on_create.rb
 - lib/recurly/requests/add_on_pricing.rb
@@ -167,6 +168,9 @@ files:
 - lib/recurly/requests/dunning_campaigns_bulk_update.rb
 - lib/recurly/requests/external_refund.rb
 - lib/recurly/requests/external_transaction.rb
+- lib/recurly/requests/gift_card_create.rb
+- lib/recurly/requests/gift_card_delivery_create.rb
+- lib/recurly/requests/gift_card_redeem.rb
 - lib/recurly/requests/invoice_address.rb
 - lib/recurly/requests/invoice_collect.rb
 - lib/recurly/requests/invoice_create.rb
@@ -254,9 +258,10 @@ files:
 - lib/recurly/resources/export_files.rb
 - lib/recurly/resources/external_product.rb
 - lib/recurly/resources/external_product_reference_mini.rb
-- lib/recurly/resources/external_resource_mini.rb
 - lib/recurly/resources/external_subscription.rb
 - lib/recurly/resources/fraud_info.rb
+- lib/recurly/resources/gift_card.rb
+- lib/recurly/resources/gift_card_delivery.rb
 - lib/recurly/resources/granted_by.rb
 - lib/recurly/resources/invoice.rb
 - lib/recurly/resources/invoice_address.rb
@@ -326,7 +331,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/4.28.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.30.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/recurly/resources/external_resource_mini.rb

@@ -1,22 +0,0 @@
-# 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.
-module Recurly
-  module Resources
-    class ExternalResourceMini < Resource
-
-      # @!attribute external_object_reference
-      #   @return [String] Identifier or URL reference where the resource is canonically available in the external platform.
-      define_attribute :external_object_reference, String
-
-      # @!attribute id
-      #   @return [String] System-generated unique identifier for an external resource ID, e.g. `e28zov4fw0v2`.
-      define_attribute :id, String
-
-      # @!attribute object
-      #   @return [String] Object type
-      define_attribute :object, String
-    end
-  end
-end