Skip to content

Latest commit

 

History

History
217 lines (130 loc) · 10.2 KB

README.md

File metadata and controls

217 lines (130 loc) · 10.2 KB

Customers

(customers)

Overview

Available Operations

  • list - Retrieve a list of customers
  • create - Create a customer ⚠️ Deprecated
  • get - Retrieve a customer
  • update - Update a customer
  • delete - Delete a customer

list

Retrieve a list of customers for the authenticated workspace.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::GetCustomersRequest.new()
    
res = s.customers.list(req)

if ! res.response_bodies.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::OpenApiSDK::Operations::GetCustomersRequest ✔️ The request object to use for the request.

Response

T.nilable(::OpenApiSDK::Operations::GetCustomersResponse)

create

[Deprecated]: Customer creation can only be done via tracking a lead event. Use the /track/lead endpoint instead.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::CreateCustomerRequestBody.new(
  external_id: "<id>",
)
    
res = s.customers.create(req)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::OpenApiSDK::Operations::CreateCustomerRequestBody ✔️ The request object to use for the request.

Response

T.nilable(::OpenApiSDK::Operations::CreateCustomerResponse)

get

Retrieve a customer by ID for the authenticated workspace.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::GetCustomerRequest.new(
  id: "<id>",
)
    
res = s.customers.get(req)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::OpenApiSDK::Operations::GetCustomerRequest ✔️ The request object to use for the request.

Response

T.nilable(::OpenApiSDK::Operations::GetCustomerResponse)

update

Update a customer for the authenticated workspace.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::UpdateCustomerRequest.new(
  id: "<id>",
)
    
res = s.customers.update(req)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::OpenApiSDK::Operations::UpdateCustomerRequest ✔️ The request object to use for the request.

Response

T.nilable(::OpenApiSDK::Operations::UpdateCustomerResponse)

delete

Delete a customer from a workspace.

Example Usage

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)

    
res = s.customers.delete(id="<id>")

if ! res.object.nil?
  # handle response
end

Parameters

Parameter Type Required Description
id ::String ✔️ The unique ID of the customer. You may use either the customer's id on Dub (obtained via /customers endpoint) or their externalId (unique ID within your system, prefixed with ext_, e.g. ext_123).

Response

T.nilable(::OpenApiSDK::Operations::DeleteCustomerResponse)