Class: GrowsurfRuby::Resources::Campaign::Commission

Inherits:
Object
  • Object
show all
Defined in:
lib/growsurf_ruby/resources/campaign/commission.rb

Overview

Affiliate transaction, commission, and payout operations.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Commission

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

Parameters:



65
66
67
 
# File 'lib/growsurf_ruby/resources/campaign/commission.rb', line 65

def initialize(client:)
  @client = client
end

Instance Method Details

#approve(commission_id, id:, request_options: {}) ⇒ GrowsurfRuby::Models::Campaign::CommissionApproveResponse

Approves a pending participant commission so it can become eligible for payout.

Parameters:

  • commission_id (String) —

    Participant commission ID.

  • id (String) —

    GrowSurf program ID.

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

Returns:

See Also:



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/growsurf_ruby/resources/campaign/commission.rb', line 48

def approve(commission_id, params)
  parsed, options = GrowsurfRuby::Campaign::CommissionApproveParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["campaign/%1$s/commission/%2$s/approve", id, commission_id],
    model: GrowsurfRuby::Models::Campaign::CommissionApproveResponse,
    options: options
  )
end

#delete(commission_id, id:, request_options: {}) ⇒ GrowsurfRuby::Models::Campaign::CommissionDeleteResponse

Removes a pending participant commission.

Parameters:

  • commission_id (String) —

    Participant commission ID.

  • id (String) —

    GrowSurf program ID.

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

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/growsurf_ruby/resources/campaign/commission.rb', line 21

def delete(commission_id, params)
  parsed, options = GrowsurfRuby::Campaign::CommissionDeleteParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["campaign/%1$s/commission/%2$s", id, commission_id],
    model: GrowsurfRuby::Models::Campaign::CommissionDeleteResponse,
    options: options
  )
end