Managing Customers

Managing Customers#

Every Customer who wants to use MOIA’s Mobility Service needs to be registered in the Trip API. The Ridepooling Service uses the Customer data to address the Customer during different parts of the Trip or to contact them if something goes wrong.

Create the Client#

Go

customerClient := customerv1.NewCustomerServiceClient(conn)

Typescript

  const client = clientFactory.create(CustomerServiceDefinition, channel);

Scala

trait CustomerService:
  def createCustomer(): Task[String]
  def getCustomer(customerId: String): Task[Customer]
  def listCustomers(pageSize: Int): Task[Seq[Customer]]
  def updateCustomer(customer: Customer): Task[Customer]
  def addCustomerFlag(customerId: String, flag: String): Task[Unit]
  def removeCustomerFlag(customerId: String, flag: String): Task[Unit]
  def listCustomerFlags(customerId: String): Task[Seq[String]]
  def deleteCustomer(customerId: String): Task[Unit]

Creating a Customer#

When creating a Customer the Customer object is returned including the generated Customer id. This Customer id is essential for all further interactions related to a Customer. This includes but is not limited to updating a Customer or ordering an Offer for a Trip.

Important

There is no restriction on the uniqueness of any Customer properties except the id. And since the id is generated by the Customer Service multiple requests with the same Customer data will result in the creation of multiple Customers with different ids.

The following example details a CreateCustomerRequest to create a new Customer.

Shell

grpcurl \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -import-path ./protos/ \
  -proto "moia/trip/customer/v1/customer.proto" \
  -proto "google/rpc/error_details.proto" \
  -d "{\"email_address\":\"test-customer@moia.io\",\"family_name\":\"Customer\",\"given_name\":\"Test\",\"language_code\":\"en\",\"phone_number\":\"+4997259173740\"}" \
  "$API_URL" moia.trip.customer.v1.CustomerService/CreateCustomer

Go

customer, err := customerClient.CreateCustomer(ctx, &customerv1.CreateCustomerRequest{
	EmailAddress: "test-customer@moia.io",
	FamilyName:   "Customer",
	GivenName:    "Test",
	LanguageCode: "en",
	PhoneNumber:  "+4997259173740",
})
if err != nil {
	log.Fatalf("Could not create customer: %v", err)
}
log.Printf("Successfully created customer: %v", jsonMarshalOptions.Format(customer))

Typescript

  const customer = await client.createCustomer({
    emailAddress: "test-customer@moia.io",
    familyName: "Customer",
    givenName: "Test",
    languageCode: "en",
    phoneNumber: "+4997259173740",
  });
  console.log(
    "Successfully created customer:",
    JSON.stringify(customer, null, 2),
  );

Scala

def createCustomer(): Task[String] = ZIO.scoped:
  for
    accessToken    <- tokenManager.getAccessToken()
    authMetadata    = GrpcClientService.createAuthMetadata(accessToken)
    customerClient <- ZioCustomer.CustomerServiceClient.scoped(managedChannel, metadata = authMetadata)
    createRequest   = CreateCustomerRequest(
                        emailAddress = "test@example.com",
                        phoneNumber = "+4930726219941",
                        givenName = "Test",
                        familyName = "Customer",
                        languageCode = "en"
                      )
    response       <- customerClient.createCustomer(createRequest)
    customerId     <- ZIO
                        .fromOption(response.customer.map(_.id))
                        .mapError(_ => new Throwable("Customer creation failed - no customer returned"))
    _              <- ZIO.logInfo(s"Successfully created customer: $customerId")
  yield customerId

Listing all Customers#

To get all Customers, we can request them using the ListCustomers RPC.

This method returns a paginated list of Customers. When the next_page_token is set in the response, passing this token as page_token in the next request will return the next page of Customers.

Is the next_page_token not set in the response, we have reached the last page of Customers. The next_page_token should be considered as an opaque token and should not be interpreted in any way.

The following example details a ListCustomersRequest to get existing Customers through paginated requests.

Shell

grpcurl \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -import-path ./protos/ \
  -proto "moia/trip/customer/v1/customer.proto" \
  -proto "google/rpc/error_details.proto" \
  -d "{\"page_size\":5}" \
  "$API_URL" moia.trip.customer.v1.CustomerService/ListCustomers

Go

pageSize := int32(5)

listCustomersResponse, err := customerClient.ListCustomers(ctx, &customerv1.ListCustomersRequest{
	PageSize: &pageSize,
})
if err != nil {
	log.Fatalf("Could not list customers: %v", err)
}
log.Printf("Successfully listed %d customers", len(listCustomersResponse.Customers))

Typescript

  const listCustomersResponse = await client.listCustomers({
    pageSize: 5,
  });
  console.log(
    `Successfully listed ${listCustomersResponse.customers.length} customers`,
  );

Scala

def listCustomers(pageSize: Int): Task[Seq[Customer]] = ZIO.scoped:
  for
    accessToken    <- tokenManager.getAccessToken()
    authMetadata    = GrpcClientService.createAuthMetadata(accessToken)
    customerClient <- ZioCustomer.CustomerServiceClient.scoped(managedChannel, metadata = authMetadata)
    listRequest     = ListCustomersRequest(pageSize = Some(pageSize))
    response       <- customerClient.listCustomers(listRequest)
    _              <- ZIO.logInfo(s"Successfully listed ${response.customers.length} customers")
  yield response.customers

Deleting a Customer#

For deleting a Customer the DeleteCustomer RPC is used.

When a Customer is deleted while having an active Trip, the Customer will be able to finish the Trip. But the Customer will not be able to order any new Trips.

The following example details a DeleteCustomerRequest to delete an existing Customer.

Shell

# export CUSTOMER_ID="<replace with customer id>"

grpcurl \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -import-path ./protos/ \
  -proto "moia/trip/customer/v1/customer.proto" \
  -proto "google/rpc/error_details.proto" \
  -d "{\"id\":\"${CUSTOMER_ID}\"}" \
  "$API_URL" moia.trip.customer.v1.CustomerService/DeleteCustomer

Go

_, err = customerClient.DeleteCustomer(ctx, &customerv1.DeleteCustomerRequest{
	Id: customer.Customer.Id,
})
if err != nil {
	log.Fatalf("Could not delete customer: %v", err)
}
log.Printf("Successfully removed customer with id %s", customer.Customer.Id)

Typescript

  await client.deleteCustomer({ id: customer.customer?.id });
  console.log(
    `Successfully removed customer with id ${customer.customer?.id}`,
  );

Scala

def deleteCustomer(customerId: String): Task[Unit] = ZIO.scoped:
  for
    accessToken    <- tokenManager.getAccessToken()
    authMetadata    = GrpcClientService.createAuthMetadata(accessToken)
    customerClient <- ZioCustomer.CustomerServiceClient.scoped(managedChannel, metadata = authMetadata)
    deleteRequest   = DeleteCustomerRequest(id = customerId)
    _              <- customerClient.deleteCustomer(deleteRequest)
    _              <- ZIO.logInfo(s"Successfully deleted customer: $customerId")
  yield ()

Managing Customers

Contents

Managing Customers#

Create the Client#

Creating a Customer#

Listing all Customers#

Deleting a Customer#

Managing Customer Flags#