Class: Dodopayments::Resources::Customers

Inherits:
Object
  • Object
show all
Defined in:
lib/dodopayments/resources/customers.rb,
lib/dodopayments/resources/customers/wallets.rb,
lib/dodopayments/resources/customers/customer_portal.rb,
lib/dodopayments/resources/customers/wallets/ledger_entries.rb,
sig/dodopayments/resources/customers.rbs,
sig/dodopayments/resources/customers/wallets.rbs,
sig/dodopayments/resources/customers/customer_portal.rbs,
sig/dodopayments/resources/customers/wallets/ledger_entries.rbs

Defined Under Namespace

Classes: CustomerPortal, Wallets

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Customers

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

Parameters:



235
236
237
238
239
 
# File 'lib/dodopayments/resources/customers.rb', line 235

def initialize(client:)
  @client = client
  @customer_portal = Dodopayments::Resources::Customers::CustomerPortal.new(client: client)
  @wallets = Dodopayments::Resources::Customers::Wallets.new(client: client)
end

Instance Attribute Details

#customer_portal ⇒ Dodopayments::Resources::Customers::CustomerPortal (readonly)

Returns:



7
8
9
 
# File 'lib/dodopayments/resources/customers.rb', line 7

def customer_portal
  @customer_portal
end

#wallets ⇒ Dodopayments::Resources::Customers::Wallets (readonly)

Returns:



10
11
12
 
# File 'lib/dodopayments/resources/customers.rb', line 10

def wallets
  @wallets
end

Instance Method Details

#create(email:, name:, metadata: nil, phone_number: nil, request_options: {}) ⇒ Dodopayments::Models::Customer

Parameters:

  • email (String)
  • name (String)
  • metadata (Hash{Symbol=>String, Float, Boolean}) —

    Additional metadata for the customer

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

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/dodopayments/resources/customers.rb', line 27

def create(params)
  parsed, options = Dodopayments::CustomerCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "customers",
    body: parsed,
    model: Dodopayments::Customer,
    options: options
  )
end

#delete_payment_method(payment_method_id, customer_id:, request_options: {}) ⇒ nil

Parameters:

  • payment_method_id (String) —

    Payment Method Id

  • customer_id (String) —

    Customer Id

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

Returns:

  • (nil)

See Also:



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/dodopayments/resources/customers.rb', line 127

def delete_payment_method(payment_method_id, params)
  parsed, options = Dodopayments::CustomerDeletePaymentMethodParams.dump_request(params)
  customer_id =
    parsed.delete(:customer_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["customers/%1$s/payment-methods/%2$s", customer_id, payment_method_id],
    model: NilClass,
    options: options
  )
end

#list(created_at_gte: nil, created_at_lte: nil, email: nil, name: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Customer>

Parameters:

  • created_at_gte (Time) —

    Filter customers created on or after this timestamp

  • created_at_lte (Time) —

    Filter customers created on or before this timestamp

  • email (String) —

    Filter by customer email

  • name (String) —

    Filter by customer name (partial match, case-insensitive)

  • 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:



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/dodopayments/resources/customers.rb', line 103

def list(params = {})
  parsed, options = Dodopayments::CustomerListParams.dump_request(params)
  query = Dodopayments::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "customers",
    query: query,
    page: Dodopayments::Internal::DefaultPageNumberPagination,
    model: Dodopayments::Customer,
    options: options
  )
end

#list_credit_entitlements(customer_id, request_options: {}) ⇒ Dodopayments::Models::CustomerListCreditEntitlementsResponse

List all credit entitlements for a customer with their current balances

Parameters:

Returns:

See Also:



152
153
154
155
156
157
158
159
 
# File 'lib/dodopayments/resources/customers.rb', line 152

def list_credit_entitlements(customer_id, params = {})
  @client.request(
    method: :get,
    path: ["customers/%1$s/credit-entitlements", customer_id],
    model: Dodopayments::Models::CustomerListCreditEntitlementsResponse,
    options: params[:request_options]
  )
end

#list_entitlement_grants(customer_id, integration_type: nil, page_number: nil, page_size: nil, status: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Entitlements::EntitlementGrant>

List all of a customer's entitlement grants across every entitlement. One row per grant.

Parameters:

Returns:

See Also:



181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/dodopayments/resources/customers.rb', line 181

def list_entitlement_grants(customer_id, params = {})
  parsed, options = Dodopayments::CustomerListEntitlementGrantsParams.dump_request(params)
  query = Dodopayments::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["customers/%1$s/entitlement-grants", customer_id],
    query: query,
    page: Dodopayments::Internal::DefaultPageNumberPagination,
    model: Dodopayments::Entitlements::EntitlementGrant,
    options: options
  )
end

#list_entitlements(customer_id, request_options: {}) ⇒ Dodopayments::Models::CustomerListEntitlementsResponse

List all entitlement grants delivered (or in flight) to a customer.

Parameters:

Returns:

See Also:



205
206
207
208
209
210
211
212
 
# File 'lib/dodopayments/resources/customers.rb', line 205

def list_entitlements(customer_id, params = {})
  @client.request(
    method: :get,
    path: ["customers/%1$s/entitlements", customer_id],
    model: Dodopayments::Models::CustomerListEntitlementsResponse,
    options: params[:request_options]
  )
end

#retrieve(customer_id, request_options: {}) ⇒ Dodopayments::Models::Customer

Parameters:

Returns:

See Also:



47
48
49
50
51
52
53
54
 
# File 'lib/dodopayments/resources/customers.rb', line 47

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

#retrieve_payment_methods(customer_id, request_options: {}) ⇒ Dodopayments::Models::CustomerRetrievePaymentMethodsResponse

Parameters:

Returns:

See Also:



223
224
225
226
227
228
229
230
 
# File 'lib/dodopayments/resources/customers.rb', line 223

def retrieve_payment_methods(customer_id, params = {})
  @client.request(
    method: :get,
    path: ["customers/%1$s/payment-methods", customer_id],
    model: Dodopayments::Models::CustomerRetrievePaymentMethodsResponse,
    options: params[:request_options]
  )
end

#update(customer_id, email: nil, metadata: nil, name: nil, phone_number: nil, request_options: {}) ⇒ Dodopayments::Models::Customer

Parameters:

  • customer_id (String) —

    Customer Id

  • email (String, nil)
  • metadata (Hash{Symbol=>String, Float, Boolean}, nil) —

    Additional metadata for the customer

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

Returns:

See Also:



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/dodopayments/resources/customers.rb', line 73

def update(customer_id, params = {})
  parsed, options = Dodopayments::CustomerUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["customers/%1$s", customer_id],
    body: parsed,
    model: Dodopayments::Customer,
    options: options
  )
end