Get | Chrt

import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        environment: ChrtEnvironment.Local,
        token: "YOUR_TOKEN_HERE",
    });
    await client.notifications.userPreferences.getV1();
}
main();

{
  "schema_version": 1,
  "user_id": "user_987654321",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "last_edited_at_timestamp": "2024-04-20T16:45:00Z",
  "_id": "507f1f77bcf86cd799439011",
  "email_events": [
    "shipping.order.staged",
    "shipping.order.completed",
    "shipping.task_group.driver_assigned"
  ],
  "push_events": [
    "shipping.order.staged",
    "shipping.task_group.message"
  ],
  "sms_events": [
    "shipping.order.cancelled"
  ]
}

Retrieves the caller’s notification preferences. | () -> (NotificationUserPreferences1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response

schema_versioninteger

user_idstring

Must be a string starting with user_

created_at_timestampstringformat: "date-time"

last_edited_at_timestampstringformat: "date-time"

_idstring

email_eventslist of enums or null

push_eventslist of enums or null

sms_eventslist of enums or null