Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 3.13 KB

File metadata and controls

61 lines (44 loc) · 3.13 KB

Payouts

Overview

Available Operations

  • list - List all payouts

list

Retrieve a list of payouts for your partner program.

Example Usage

require 'dub'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Dub.new(
  security: Models::Shared::Security.new(
    token: 'DUB_API_KEY'
  )
)

req = Models::Operations::ListPayoutsRequest.new(
  page: 1.0,
  page_size: 50.0
)
res = s.payouts.list(request: req)

unless res.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::ListPayoutsRequest ✔️ The request object to use for the request.

Response

T.nilable(T::Array[Models::Operations::ListPayoutsResponseBody])

Errors

Error Type Status Code Content Type
Models::Errors::BadRequest 400 application/json
Models::Errors::Unauthorized 401 application/json
Models::Errors::Forbidden 403 application/json
Models::Errors::NotFound 404 application/json
Models::Errors::Conflict 409 application/json
Models::Errors::InviteExpired 410 application/json
Models::Errors::UnprocessableEntity 422 application/json
Models::Errors::RateLimitExceeded 429 application/json
Models::Errors::InternalServerError 500 application/json
Errors::APIError 4XX, 5XX */*