Class: Dodopayments::Resources::ProductCollections::Groups::Items

Inherits:
Object
  • Object
show all
Defined in:
lib/dodopayments/resources/product_collections/groups/items.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Items

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

Parameters:



104
105
106
 
# File 'lib/dodopayments/resources/product_collections/groups/items.rb', line 104

def initialize(client:)
  @client = client
end

Instance Method Details

#create(group_id, id:, products:, request_options: {}) ⇒ Array<Dodopayments::Models::ProductCollections::Groups::ProductCollectionProduct>

Parameters:

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/dodopayments/resources/product_collections/groups/items.rb', line 21

def create(group_id, params)
  parsed, options = Dodopayments::ProductCollections::Groups::ItemCreateParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["product-collections/%1$s/groups/%2$s/items", id, group_id],
    body: parsed,
    model: Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductCollections::Groups::ProductCollectionProduct],
    options: options
  )
end

#delete(item_id, id:, group_id:, request_options: {}) ⇒ nil

Parameters:

  • item_id (String) —

    Collection item Id (product membership in group)

  • id (String) —

    Product Collection Id

  • group_id (String) —

    Product Collection Group Id

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

Returns:

  • (nil)

See Also:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/dodopayments/resources/product_collections/groups/items.rb', line 83

def delete(item_id, params)
  parsed, options = Dodopayments::ProductCollections::Groups::ItemDeleteParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  group_id =
    parsed.delete(:group_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["product-collections/%1$s/groups/%2$s/items/%3$s", id, group_id, item_id],
    model: NilClass,
    options: options
  )
end

#update(item_id, id:, group_id:, status:, request_options: {}) ⇒ nil

Parameters:

  • item_id (String) —

    Path param: Collection item Id (product membership in group)

  • id (String) —

    Path param: Product Collection Id

  • group_id (String) —

    Path param: Product Collection Group Id

  • status (Boolean) —

    Body param: Status of the product in the group

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

Returns:

  • (nil)

See Also:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/dodopayments/resources/product_collections/groups/items.rb', line 51

def update(item_id, params)
  parsed, options = Dodopayments::ProductCollections::Groups::ItemUpdateParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  group_id =
    parsed.delete(:group_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :patch,
    path: ["product-collections/%1$s/groups/%2$s/items/%3$s", id, group_id, item_id],
    body: parsed,
    model: NilClass,
    options: options
  )
end