Class: Dodopayments::Resources::Meters

Inherits:
Object
  • Object
show all
Defined in:
lib/dodopayments/resources/meters.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Meters

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

Parameters:



118
119
120
 
# File 'lib/dodopayments/resources/meters.rb', line 118

def initialize(client:)
  @client = client
end

Instance Method Details

#archive(id, request_options: {}) ⇒ nil

Parameters:

Returns:

  • (nil)

See Also:



88
89
90
91
92
93
94
95
 
# File 'lib/dodopayments/resources/meters.rb', line 88

def archive(id, params = {})
  @client.request(
    method: :delete,
    path: ["meters/%1$s", id],
    model: NilClass,
    options: params[:request_options]
  )
end

#create(aggregation: , event_name: , measurement_unit: , name: , description: nil, filter: nil, request_options: {}) ⇒ Dodopayments::Models::Meter

Parameters:

Returns:

See Also:



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

def create(params)
  parsed, options = Dodopayments::MeterCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "meters",
    body: parsed,
    model: Dodopayments::Meter,
    options: options
  )
end

#list(archived: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Meter>

Parameters:

  • archived (Boolean) —

    List archived meters

  • page_number (Integer) —

    Page number default is 0

  • page_size (Integer) —

    Page size default is 10 max is 100

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

Returns:

See Also:



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/dodopayments/resources/meters.rb', line 67

def list(params = {})
  parsed, options = Dodopayments::MeterListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "meters",
    query: parsed,
    page: Dodopayments::Internal::DefaultPageNumberPagination,
    model: Dodopayments::Meter,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Dodopayments::Models::Meter

Parameters:

Returns:

See Also:



45
46
47
48
49
50
51
52
 
# File 'lib/dodopayments/resources/meters.rb', line 45

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["meters/%1$s", id],
    model: Dodopayments::Meter,
    options: params[:request_options]
  )
end

#unarchive(id, request_options: {}) ⇒ nil

Parameters:

Returns:

  • (nil)

See Also:



106
107
108
109
110
111
112
113
 
# File 'lib/dodopayments/resources/meters.rb', line 106

def unarchive(id, params = {})
  @client.request(
    method: :post,
    path: ["meters/%1$s/unarchive", id],
    model: NilClass,
    options: params[:request_options]
  )
end