lib/recurly/client/operations.rb in recurly-3.15.0 vs lib/recurly/client/operations.rb in recurly-3.16.0
- old
+ new
@@ -566,10 +566,11 @@
# *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 state [String] Filter by state.
# @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::CouponRedemption>] A list of the the coupon redemptions on an account.
# @example
# redemptions = @client.list_account_coupon_redemptions(
@@ -1468,10 +1469,21 @@
# @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
# @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::Coupon] The restored coupon.
+ # @example
+ # begin
+ # coupon = @client.restore_coupon(coupon_id: coupon_id, body: {
+ # name: "New Coupon Name"
+ # })
+ # puts "Restored coupon #{coupon}"
+ # rescue Recurly::Errors::NotFoundError
+ # # If the resource was not found, you may want to alert the user or
+ # # just return nil
+ # puts "Resource Not Found"
+ # end
#
def restore_coupon(coupon_id:, body:, **options)
path = interpolate_path("/coupons/{coupon_id}/restore", coupon_id: coupon_id)
put(path, body, Requests::CouponUpdate, **options)
end
@@ -3039,9 +3051,10 @@
#
# In the event that the most recent invoice is a $0 invoice paid entirely by credit, Recurly will apply the credit back to the customer’s account.
#
# You may also terminate a subscription with no refund and then manually refund specific invoices.
#
+ # @param charge [Boolean] Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.
# @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::Subscription] An expired subscription.
# @example
# begin