operations.rb in recurly-4.25.0

- old
+ new

@@ -586,11 +586,11 @@
     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
+    # List the coupon redemptions for an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
     #
     # @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 params [Hash] Optional query string parameters:
@@ -634,11 +634,11 @@
     def list_account_coupon_redemptions(account_id:, **options)
       path = interpolate_path("/accounts/{account_id}/coupon_redemptions", account_id: account_id)
       pager(path, **options)
     end
 
-    # Show the coupon redemptions that are active on an account
+    # List the coupon redemptions that are active on an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api documentation}
     #
     # @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 params [Hash] Optional query string parameters:
@@ -948,11 +948,11 @@
     def create_line_item(account_id:, body:, **options)
       path = interpolate_path("/accounts/{account_id}/line_items", account_id: account_id)
       post(path, body, Requests::LineItemCreate, **options)
     end
 
-    # Fetch a list of an account's notes
+    # List an account's notes
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api documentation}
     #
     # @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 params [Hash] Optional query string parameters:
@@ -2044,10 +2044,72 @@
     def remove_measured_unit(measured_unit_id:, **options)
       path = interpolate_path("/measured_units/{measured_unit_id}", measured_unit_id: measured_unit_id)
       delete(path, **options)
     end
 
+    # List a site's external products
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_products list_external_products api documentation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #        :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.
+    #
+    #
+    # @return [Pager<Resources::ExternalProduct>] A list of the the external_products on a site.
+    #
+    def list_external_products(**options)
+      path = "/external_products"
+      pager(path, **options)
+    end
+
+    # Fetch an external product
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_external_product get_external_product api documentation}
+    #
+    # @param external_product_id [String] External product id
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalProduct] Settings for an external product.
+    #
+    def get_external_product(external_product_id:, **options)
+      path = interpolate_path("/external_products/{external_product_id}", external_product_id: external_product_id)
+      get(path, **options)
+    end
+
+    # List a site's external subscriptions
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscriptions list_external_subscriptions api documentation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #        :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.
+    #
+    #
+    # @return [Pager<Resources::ExternalSubscription>] A list of the the external_subscriptions on a site.
+    #
+    def list_external_subscriptions(**options)
+      path = "/external_subscriptions"
+      pager(path, **options)
+    end
+
+    # Fetch an external subscription
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_external_subscription get_external_subscription api documentation}
+    #
+    # @param external_subscription_id [String] External subscription id
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalSubscription] Settings for an external subscription.
+    #
+    def get_external_subscription(external_subscription_id:, **options)
+      path = interpolate_path("/external_subscriptions/{external_subscription_id}", external_subscription_id: external_subscription_id)
+      get(path, **options)
+    end
+
     # List a site's invoices
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documentation}
     #
     # @param params [Hash] Optional query string parameters:
@@ -2355,11 +2417,11 @@
     def list_invoice_line_items(invoice_id:, **options)
       path = interpolate_path("/invoices/{invoice_id}/line_items", invoice_id: invoice_id)
       pager(path, **options)
     end
 
-    # Show the coupon redemptions applied to an invoice
+    # List the coupon redemptions applied to an invoice
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
     #
     # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
     # @param params [Hash] Optional query string parameters:
@@ -3584,11 +3646,11 @@
     def list_subscription_line_items(subscription_id:, **options)
       path = interpolate_path("/subscriptions/{subscription_id}/line_items", subscription_id: subscription_id)
       pager(path, **options)
     end
 
-    # Show the coupon redemptions for a subscription
+    # List the coupon redemptions for a subscription
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
     #
     # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
     # @param params [Hash] Optional query string parameters:
@@ -4013,11 +4075,11 @@
     def get_export_files(export_date:, **options)
       path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date)
       get(path, **options)
     end
 
-    # Show the dunning campaigns for a site
+    # List the dunning campaigns for a site
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
     #
     # @param params [Hash] Optional query string parameters:
     #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -4030,11 +4092,11 @@
     def list_dunning_campaigns(**options)
       path = "/dunning_campaigns"
       pager(path, **options)
     end
 
-    # Show the settings for a dunning campaign
+    # Fetch a dunning campaign
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documentation}
     #
     # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
     # @param params [Hash] Optional query string parameters:
@@ -4076,11 +4138,11 @@
     def list_invoice_templates(**options)
       path = "/invoice_templates"
       pager(path, **options)
     end
 
-    # Show the settings for an invoice template
+    # Fetch an invoice template
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_template get_invoice_template api documentation}
     #
     # @param invoice_template_id [String] Invoice template ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
     # @param params [Hash] Optional query string parameters:
@@ -4090,11 +4152,11 @@
     def get_invoice_template(invoice_template_id:, **options)
       path = interpolate_path("/invoice_templates/{invoice_template_id}", invoice_template_id: invoice_template_id)
       get(path, **options)
     end
 
-    # Show all entitlements granted to an account
+    # List entitlements granted to an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_entitlements list_entitlements api documentation}
     #
     # @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 params [Hash] Optional query string parameters:
@@ -4106,9 +4168,27 @@
     #
     # @return [Pager<Resources::Entitlements>] A list of the entitlements granted to an account.
     #
     def list_entitlements(account_id:, **options)
       path = interpolate_path("/accounts/{account_id}/entitlements", account_id: account_id)
+      pager(path, **options)
+    end
+
+    # List an account's external subscriptions
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_external_subscriptions list_account_external_subscriptions api documentation}
+    #
+    # @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 params [Hash] Optional query string parameters:
+    #        :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.
+    #
+    #
+    # @return [Pager<Resources::ExternalSubscription>] A list of the the external_subscriptions on an account.
+    #
+    def list_account_external_subscriptions(account_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/external_subscriptions", account_id: account_id)
       pager(path, **options)
     end
   end
 end