Class: Dodopayments::Resources::LicenseKeyInstances

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ LicenseKeyInstances

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

Parameters:



74
75
76
 
# File 'lib/dodopayments/resources/license_key_instances.rb', line 74

def initialize(client:)
  @client = client
end

Instance Method Details

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

Parameters:

  • license_key_id (String, nil) —

    Filter by license key ID

  • page_number (Integer, nil) —

    Page number default is 0

  • page_size (Integer, nil) —

    Page size default is 10 max is 100

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

Returns:

See Also:



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/dodopayments/resources/license_key_instances.rb', line 59

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

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

Parameters:

Returns:

See Also:



15
16
17
18
19
20
21
22
 
# File 'lib/dodopayments/resources/license_key_instances.rb', line 15

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

#update(id, name: , request_options: {}) ⇒ Dodopayments::Models::LicenseKeyInstance

Parameters:

Returns:

See Also:



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/dodopayments/resources/license_key_instances.rb', line 35

def update(id, params)
  parsed, options = Dodopayments::LicenseKeyInstanceUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["license_key_instances/%1$s", id],
    body: parsed,
    model: Dodopayments::LicenseKeyInstance,
    options: options
  )
end