Class: WhopSDK::Resources::Affiliates::Overrides

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

Overview

Affiliates

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Overrides

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 Overrides.

Parameters:



182
183
184
 
# File 'lib/whop_sdk/resources/affiliates/overrides.rb', line 182

def initialize(client:)
  @client = client
end

Instance Method Details

#create(id, body:, request_options: {}) ⇒ WhopSDK::Models::Affiliates::OverrideCreateResponse

Creates a commission override for an affiliate.

Required permissions:

  • ‘affiliate:create`

Parameters:

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/whop_sdk/resources/affiliates/overrides.rb', line 25

def create(id, params)
  parsed, options = WhopSDK::Affiliates::OverrideCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["affiliates/%1$s/overrides", id],
    body: parsed[:body],
    model: WhopSDK::Models::Affiliates::OverrideCreateResponse,
    options: options
  )
end

#delete(override_id, id:, request_options: {}) ⇒ Boolean

Deletes an affiliate override.

Required permissions:

  • ‘affiliate:update`

Parameters:

  • override_id (String) —

    The override ID.

  • id (String) —

    The affiliate ID.

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

Returns:

  • (Boolean)

See Also:



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/whop_sdk/resources/affiliates/overrides.rb', line 165

def delete(override_id, params)
  parsed, options = WhopSDK::Affiliates::OverrideDeleteParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["affiliates/%1$s/overrides/%2$s", id, override_id],
    model: WhopSDK::Internal::Type::Boolean,
    options: options
  )
end

#list(id, after: nil, before: nil, first: nil, last: nil, override_type: nil, request_options: {}) ⇒ WhopSDK::Internal::CursorPage<WhopSDK::Models::Affiliates::OverrideListResponse>

Returns a paginated list of overrides for an affiliate.

Required permissions:

  • ‘affiliate:basic:read`

Parameters:

  • id (String) —

    The affiliate ID.

  • 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.

  • first (Integer, nil) —

    Returns the first n elements from the list.

  • last (Integer, nil) —

    Returns the last n elements from the list.

  • override_type (Symbol, WhopSDK::Models::Affiliates::AffiliateOverrideRoles, nil) —

    The role of an affiliate override (standard or rev_share)

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

Returns:

See Also:



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/whop_sdk/resources/affiliates/overrides.rb', line 135

def list(id, params = {})
  parsed, options = WhopSDK::Affiliates::OverrideListParams.dump_request(params)
  query = WhopSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["affiliates/%1$s/overrides", id],
    query: query,
    page: WhopSDK::Internal::CursorPage,
    model: WhopSDK::Models::Affiliates::OverrideListResponse,
    options: options
  )
end

#retrieve(override_id, id:, request_options: {}) ⇒ WhopSDK::Models::Affiliates::OverrideRetrieveResponse

Retrieves the details of a specific affiliate override.

Required permissions:

  • ‘affiliate:basic:read`

Parameters:

  • override_id (String) —

    The override ID.

  • id (String) —

    The affiliate ID.

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

Returns:

See Also:



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/whop_sdk/resources/affiliates/overrides.rb', line 53

def retrieve(override_id, params)
  parsed, options = WhopSDK::Affiliates::OverrideRetrieveParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["affiliates/%1$s/overrides/%2$s", id, override_id],
    model: WhopSDK::Models::Affiliates::OverrideRetrieveResponse,
    options: options
  )
end

#update(override_id, id:, applies_to_payments: nil, commission_type: nil, commission_value: nil, revenue_basis: nil, request_options: {}) ⇒ WhopSDK::Models::Affiliates::OverrideUpdateResponse

Some parameter documentations has been truncated, see Models::Affiliates::OverrideUpdateParams for more details.

Updates an existing affiliate override.

Required permissions:

  • ‘affiliate:update`

Parameters:

Returns:

See Also:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/whop_sdk/resources/affiliates/overrides.rb', line 95

def update(override_id, params)
  parsed, options = WhopSDK::Affiliates::OverrideUpdateParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :patch,
    path: ["affiliates/%1$s/overrides/%2$s", id, override_id],
    body: parsed,
    model: WhopSDK::Models::Affiliates::OverrideUpdateResponse,
    options: options
  )
end