Class: WhopSDK::Resources::Refunds

Inherits:
Object
  • Object
show all
Defined in:
lib/whop_sdk/resources/refunds.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Refunds

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Refunds.

Parameters:



73
74
75
 
# File 'lib/whop_sdk/resources/refunds.rb', line 73

def initialize(client:)
  @client = client
end

Instance Method Details

#list(payment_id: , after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {}) ⇒ WhopSDK::Internal::CursorPage<WhopSDK::Models::RefundListResponse>

Lists Refunds for a payment.

Required permissions:

  • ‘payment:basic:read`

Parameters:

  • payment_id (String) —

    The ID of the payment to list refunds for

  • after (String, nil) —

    Returns the elements in the list that come after the specified cursor.

  • before (String, nil) —

    Returns the elements in the list that come before the specified cursor.

  • direction (Symbol, WhopSDK::Models::Direction, nil) —

    The direction of the sort.

  • first (Integer, nil) —

    Returns the first n elements from the list.

  • last (Integer, nil) —

    Returns the last n elements from the list.

  • request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/whop_sdk/resources/refunds.rb', line 58

def list(params)
  parsed, options = WhopSDK::RefundListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "refunds",
    query: parsed,
    page: WhopSDK::Internal::CursorPage,
    model: WhopSDK::Models::RefundListResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ WhopSDK::Models::RefundRetrieveResponse

Retrieves a Refund by ID

Required permissions:

  • ‘payment:basic:read`

  • ‘member:email:read`

  • ‘member:basic:read`

  • ‘member:phone:read`

Parameters:

Returns:

See Also:



24
25
26
27
28
29
30
31
 
# File 'lib/whop_sdk/resources/refunds.rb', line 24

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["refunds/%1$s", id],
    model: WhopSDK::Models::RefundRetrieveResponse,
    options: params[:request_options]
  )
end