Class: Increase::Resources::CardPurchaseSupplements

Inherits:

Object

• Object
• Increase::Resources::CardPurchaseSupplements

Defined in:

lib/increase/resources/card_purchase_supplements.rb

Instance Method Summary

• #initialize(client:) ⇒ CardPurchaseSupplements constructor private

  A new instance of CardPurchaseSupplements.

• #list(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::CardPurchaseSupplement>

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

• #retrieve(card_purchase_supplement_id, request_options: {}) ⇒ Increase::Models::CardPurchaseSupplement

  Retrieve a Card Purchase Supplement.

Constructor Details

#initialize(client:) ⇒ CardPurchaseSupplements

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

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/card_purchase_supplements.rb', line 61

def initialize(client:)
  @client = client
end

Instance Method Details

#list(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::CardPurchaseSupplement>

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

List Card Purchase Supplements

Parameters:

• card_payment_id (String) —

  Filter Card Purchase Supplements to ones belonging to the specified Card Payment

• created_at (Increase::Models::CardPurchaseSupplementListParams::CreatedAt)
• cursor (String) —

  Return the page of entries after this one.

• limit (Integer) —

  Limit the size of the list that is returned. The default (and maximum) is 100 ob

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

Returns:

• (Increase::Internal::Page<Increase::Models::CardPurchaseSupplement>)

See Also:

• Models::CardPurchaseSupplementListParams

# File 'lib/increase/resources/card_purchase_supplements.rb', line 46

def list(params = {})
  parsed, options = Increase::CardPurchaseSupplementListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "card_purchase_supplements",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::CardPurchaseSupplement,
    options: options
  )
end

#retrieve(card_purchase_supplement_id, request_options: {}) ⇒ Increase::Models::CardPurchaseSupplement

Retrieve a Card Purchase Supplement

Parameters:

• card_purchase_supplement_id (String) —

  The identifier of the Card Purchase Supplement.

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

Returns:

• (Increase::Models::CardPurchaseSupplement)

See Also:

• Models::CardPurchaseSupplementRetrieveParams

# File 'lib/increase/resources/card_purchase_supplements.rb', line 17

def retrieve(card_purchase_supplement_id, params = {})
  @client.request(
    method: :get,
    path: ["card_purchase_supplements/%1$s", card_purchase_supplement_id],
    model: Increase::CardPurchaseSupplement,
    options: params[:request_options]
  )
end