@fonderie/client 0.9.0 → 0.11.0

package/brain/signatures.md

@@ -80,7 +80,7 @@ interface IListAuditEventsInput {
 new AuditClient(http: HttpClient, tokens: TokenStore): AuditClient
   .setAccessToken(token: string | undefined): void
   .setWorkspaceId(workspaceId: string | undefined): void
-  .listEvents(input?: IListAuditEventsInput): Promise<IApiResponse<IAuditPageResult>>
+  .listEvents(input?: IListAuditEventsInput, opts?: IReadOptions | undefined): Promise<IApiResponse<IAuditPageResult>>
 
 interface IChangePasswordInput {
     currentPassword: string;
@@ -107,16 +107,21 @@ interface IResetPasswordInput {
 interface IUpdatePreferencesInput {
     locale?: string;
     timezone?: string;
-    notifications?: unknown;
-    emailDigest?: unknown;
-    dateFormat?: unknown;
-    timeFormat?: unknown;
+    notifications?: {
+        email?: boolean;
+        inApp?: boolean;
+        sms?: boolean;
+        push?: boolean;
+    };
+    emailDigest?: string;
+    dateFormat?: string;
+    timeFormat?: string;
 }
 
 interface IUpdateProfileInput {
-    firstName?: string;
-    lastName?: string;
-    avatarUrl?: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    avatarUrl?: string | null;
 }
 
 new AuthClient(http: HttpClient, tokens: TokenStore): AuthClient
@@ -130,7 +135,7 @@ new AuthClient(http: HttpClient, tokens: TokenStore): AuthClient
   .verifyEmail(token: string): Promise<IApiResponse<IVerifyEmailResult>>
   .logout(refreshToken?: string | undefined): Promise<IApiResponse<undefined>>
   .sendVerificationEmail(): Promise<IApiResponse<IResendVerificationResult>>
-  .getUser(): Promise<IApiResponse<IMeResult>>
+  .getUser(opts?: IReadOptions | undefined): Promise<IApiResponse<IMeResult>>
   .updateProfile(input: IUpdateProfileInput): Promise<IApiResponse<IMeResult>>
   .updatePreferences(input: IUpdatePreferencesInput): Promise<IApiResponse<IMeResult>>
   .updateEmail(email: string): Promise<IApiResponse<unknown>>
@@ -168,20 +173,21 @@ type IUpdatePlanInput = Partial<ICreatePlanInput>;
 new BillingClient(http: HttpClient, tokens: TokenStore): BillingClient
   .setAccessToken(token: string | undefined): void
   .setWorkspaceId(workspaceId: string | undefined): void
-  .listPlans(): Promise<IApiResponse<IPlanListResult>>
-  .getPlan(planId: string): Promise<IApiResponse<IPlanResult>>
+  .listPlans(opts?: IReadOptions | undefined): Promise<IApiResponse<IPlanListResult>>
+  .getPlan(planId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IPlanResult>>
   .createPlan(input: ICreatePlanInput): Promise<IApiResponse<IPlanResult>>
   .updatePlan(planId: string, input: Partial<ICreatePlanInput>): Promise<IApiResponse<IPlanResult>>
   .deletePlan(planId: string): Promise<IApiResponse<undefined>>
-  .getSubscription(): Promise<IApiResponse<ISubscriptionResult>>
+  .getSubscription(opts?: IReadOptions | undefined): Promise<IApiResponse<ISubscriptionResult>>
   .createCheckoutSession(input: ICheckoutInput): Promise<IApiResponse<ICheckoutUrlResult>>
   .createPortalSession(): Promise<IApiResponse<IPortalUrlResult>>
   .recordUsage(input: IRecordUsageInput): Promise<IApiResponse<undefined>>
-  .getUsage(metric: string): Promise<IApiResponse<IUsageResult>>
+  .getUsage(metric: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IUsageResult>>
 
 interface IConfigAdminClientOptions {
     baseUrl: string;
     adminToken: string;
+    actor?: string;
 }
 
 interface IRollbackInput {
@@ -191,12 +197,14 @@ interface IRollbackInput {
 interface ISetConfigInput {
     value: unknown;
     description?: string;
+    active?: boolean;
     ifVersion?: number;
 }
 
 interface ISetSecretInput {
     value: string;
     description?: string;
+    active?: boolean;
     ifVersion?: number;
 }
 
@@ -218,6 +226,7 @@ new ConfigAdminClient(opts: IConfigAdminClientOptions): ConfigAdminClient
 interface ICourierAdminClientOptions {
     baseUrl: string;
     adminToken: string;
+    actor?: string;
 }
 
 interface IRollbackTemplateInput {
@@ -266,7 +275,7 @@ interface IAddPhoneInput {
 
 interface IAddRelationshipInput {
     relatedId: string;
-    relationship?: string;
+    relationship: string;
     isPrimary?: boolean;
 }
 
@@ -298,45 +307,45 @@ interface IListCustomersInput {
     offset?: number;
 }
 
-type IUpdateCustomerInput = ICreateCustomerInput;
+type IUpdateCustomerInput = Omit<ICreateCustomerInput, 'referralCode' | 'referredByCode'>;
 
 new CustomersClient(http: HttpClient, tokens: TokenStore): CustomersClient
   .setAccessToken(token: string | undefined): void
   .setWorkspaceId(workspaceId: string | undefined): void
-  .listCustomers(input?: IListCustomersInput): Promise<IApiResponse<ICustomerListResult>>
+  .listCustomers(input?: IListCustomersInput, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerListResult>>
   .createCustomer(input?: ICreateCustomerInput): Promise<IApiResponse<ICustomerResult>>
-  .getCustomer(customerId: string, input?: IGetCustomerInput): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>
-  .updateCustomer(customerId: string, input: ICreateCustomerInput): Promise<IApiResponse<ICustomerResult>>
+  .getCustomer(customerId: string, input?: IGetCustomerInput, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>
+  .updateCustomer(customerId: string, input: IUpdateCustomerInput): Promise<IApiResponse<ICustomerResult>>
   .deleteCustomer(customerId: string): Promise<IApiResponse<undefined>>
   .blacklistCustomer(customerId: string, input?: IBlacklistCustomerInput): Promise<IApiResponse<undefined>>
   .unblacklistCustomer(customerId: string): Promise<IApiResponse<undefined>>
-  .listEmails(customerId: string): Promise<IApiResponse<ICustomerEmailListResult>>
+  .listEmails(customerId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerEmailListResult>>
   .addEmail(customerId: string, input: IAddEmailInput): Promise<IApiResponse<ICustomerEmailResult>>
   .updateEmailLabel(customerId: string, emailId: string, label: string): Promise<IApiResponse<ICustomerEmailResult>>
   .setPrimaryEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>
   .removeEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>
-  .listPhones(customerId: string): Promise<IApiResponse<ICustomerPhoneListResult>>
+  .listPhones(customerId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerPhoneListResult>>
   .addPhone(customerId: string, input: IAddPhoneInput): Promise<IApiResponse<ICustomerPhoneResult>>
   .updatePhoneLabel(customerId: string, phoneId: string, label: string): Promise<IApiResponse<ICustomerPhoneResult>>
   .setPrimaryPhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>
   .removePhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>
-  .listAddresses(customerId: string): Promise<IApiResponse<ICustomerAddressListResult>>
+  .listAddresses(customerId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerAddressListResult>>
   .addAddress(customerId: string, input: IAddAddressInput): Promise<IApiResponse<ICustomerAddressResult>>
   .updateAddressLabel(customerId: string, addrId: string, label: string): Promise<IApiResponse<ICustomerAddressResult>>
   .setPrimaryAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>
   .removeAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>
-  .listNotes(customerId: string): Promise<IApiResponse<ICustomerNoteListResult>>
+  .listNotes(customerId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerNoteListResult>>
   .createNote(customerId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>
   .updateNote(customerId: string, noteId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>
   .deleteNote(customerId: string, noteId: string): Promise<IApiResponse<undefined>>
-  .listTags(customerId: string): Promise<IApiResponse<ICustomerTagListResult>>
+  .listTags(customerId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerTagListResult>>
   .addTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>
   .removeTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>
-  .listRelationships(customerId: string): Promise<IApiResponse<ICustomerRelationshipListResult>>
+  .listRelationships(customerId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerRelationshipListResult>>
   .addRelationship(customerId: string, input: IAddRelationshipInput): Promise<IApiResponse<ICustomerRelationshipResult>>
   .setPrimaryRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>
   .removeRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>
-  .listLabels(type: CustomerLabelType): Promise<IApiResponse<ICustomerLabelListResult>>
+  .listLabels(type: CustomerLabelType, opts?: IReadOptions | undefined): Promise<IApiResponse<ICustomerLabelListResult>>
   .removeLabel(labelId: string): Promise<IApiResponse<undefined>>
 
 interface ICreateWebhookEndpointInput {
@@ -353,12 +362,12 @@ interface IUpdateWebhookEndpointInput {
 new WebhooksClient(http: HttpClient, tokens: TokenStore): WebhooksClient
   .setAccessToken(token: string | undefined): void
   .setWorkspaceId(workspaceId: string | undefined): void
-  .listEndpoints(): Promise<IApiResponse<IWebhookEndpointListResult>>
+  .listEndpoints(opts?: IReadOptions | undefined): Promise<IApiResponse<IWebhookEndpointListResult>>
   .createEndpoint(input: ICreateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointCreatedDTO>>
-  .getEndpoint(endpointId: string): Promise<IApiResponse<IWebhookEndpointDTO>>
+  .getEndpoint(endpointId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IWebhookEndpointDTO>>
   .updateEndpoint(endpointId: string, input: IUpdateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointDTO>>
   .deleteEndpoint(endpointId: string): Promise<undefined>
-  .listDeliveries(endpointId: string): Promise<IApiResponse<IWebhookDeliveryListResult>>
+  .listDeliveries(endpointId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IWebhookDeliveryListResult>>
   .testEndpoint(endpointId: string): Promise<IApiResponse<ITestWebhookResult>>
 
 interface ICreateRoleInput {
@@ -430,29 +439,29 @@ interface IUpdateWorkspaceInput {
 new WorkspacesClient(http: HttpClient, tokens: TokenStore): WorkspacesClient
   .setAccessToken(token: string | undefined): void
   .setWorkspaceId(workspaceId: string | undefined): void
-  .listWorkspaces(): Promise<IApiResponse<IWorkspaceListResult>>
+  .listWorkspaces(opts?: IReadOptions | undefined): Promise<IApiResponse<IWorkspaceListResult>>
   .createWorkspace(input: ICreateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>
-  .getWorkspace(id: string): Promise<IApiResponse<IWorkspaceResult>>
+  .getWorkspace(id: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IWorkspaceResult>>
   .updateWorkspace(input: IUpdateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>
   .archiveWorkspace(): Promise<IApiResponse<undefined>>
   .restoreWorkspace(): Promise<IApiResponse<undefined>>
-  .listRoles(): Promise<IApiResponse<IRoleListResult>>
+  .listRoles(opts?: IReadOptions | undefined): Promise<IApiResponse<IRoleListResult>>
   .createRole(input: ICreateRoleInput): Promise<IApiResponse<IRoleResult>>
-  .getRole(roleId: string): Promise<IApiResponse<IRoleResult>>
+  .getRole(roleId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IRoleResult>>
   .updateRole(roleId: string, input: IUpdateRoleInput): Promise<IApiResponse<IRoleResult>>
   .removeRole(roleId: string): Promise<IApiResponse<undefined>>
-  .getRolePermissions(roleId: string): Promise<IApiResponse<IRolePermissionsResult>>
+  .getRolePermissions(roleId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IRolePermissionsResult>>
   .setRolePermissions(roleId: string, permissions: IRolePermissionInput[]): Promise<IApiResponse<undefined>>
-  .listMembers(): Promise<IApiResponse<IMemberListResult>>
+  .listMembers(opts?: IReadOptions | undefined): Promise<IApiResponse<IMemberListResult>>
   .removeMember(userId: string): Promise<IApiResponse<undefined>>
-  .getMemberRoles(userId: string): Promise<IApiResponse<IRoleListResult>>
+  .getMemberRoles(userId: string, opts?: IReadOptions | undefined): Promise<IApiResponse<IRoleListResult>>
   .addMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>
   .removeMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>
-  .listInvitations(): Promise<IApiResponse<IInvitationListResult>>
+  .listInvitations(opts?: IReadOptions | undefined): Promise<IApiResponse<IInvitationListResult>>
   .invite(entries: IInviteEntry | IInviteEntry[]): Promise<IApiResponse<IInviteResult>>
   .cancelInvitation(inviteId: string): Promise<IApiResponse<undefined>>
   .acceptInvitation(pin: string): Promise<IApiResponse<IAcceptInvitationResult>>
-  .getSettings(): Promise<IApiResponse<IWorkspaceSettingsResult>>
+  .getSettings(opts?: IReadOptions | undefined): Promise<IApiResponse<IWorkspaceSettingsResult>>
   .updateSettings(input: IUpdateSettingsInput): Promise<IApiResponse<IWorkspaceSettingsResult>>
 
 type CustomerLabelType = 'phone' | 'email' | 'address';
@@ -528,6 +537,7 @@ interface IConfigRevision {
 interface ICustomerAddressDTO {
     id: string;
     label: string;
+    labelId: string | null;
     isPrimary: boolean;
     address: IAddressDTO;
 }
@@ -578,6 +588,7 @@ interface ICustomerEmailDTO {
     id: string;
     email: string;
     label: string;
+    labelId: string | null;
     isPrimary: boolean;
     createdAt: string;
 }
@@ -626,6 +637,7 @@ interface ICustomerPhoneDTO {
     id: string;
     phone: string;
     label: string;
+    labelId: string | null;
     isPrimary: boolean;
     createdAt: string;
 }
@@ -655,6 +667,7 @@ type ICustomerRelationshipExpandedDTO = Omit<ICustomerShallowDTO, 'id'> & {
     customerId: string;
     relationship: string;
     isPrimary: boolean;
+    relationshipCreatedAt: string;
 };
 
 interface ICustomerRelationshipListResult {
@@ -706,6 +719,7 @@ interface IInviteResult {
 interface ILoginResult {
     tokens: ITokens;
     user: IUserDTO;
+    requiresVerification?: boolean;
 }
 
 interface IMemberDTO {
@@ -715,6 +729,10 @@ interface IMemberDTO {
     roleName: string;
     confirmed: boolean;
     createdAt: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    profileImageUrl: string;
 }
 
 interface IMemberListResult {
@@ -726,8 +744,7 @@ interface IMeResult {
 }
 
 interface IMfaEnabledResult {
-    tokens: ITokens;
-    user: IUserDTO;
+    mfaEnabled: boolean;
 }
 
 interface IMfaRequiredResult {
@@ -752,6 +769,7 @@ interface IPlanDTO {
         yearly: number;
         currency: string;
     };
+    pricingStale?: boolean;
     features: IPlanFeature[];
     metadata: Record<string, unknown>;
 }
@@ -779,19 +797,19 @@ interface IRefreshResult {
     tokens: ITokens;
 }
 
+interface IReadOptions {
+    bust?: boolean | undefined;
+}
+
 interface IRegisterResult {
     tokens: ITokens;
     user: IUserDTO;
+    requiresVerification?: boolean;
 }
 
 interface IResendVerificationResult {
-    stat: string;
-    message: string;
-    data: {
-        token: string;
-        expiresAt: string;
-        email: string;
-    };
+    email?: string;
+    verified?: boolean;
 }
 
 interface IRevealSecretResult {
@@ -900,9 +918,9 @@ interface IUserDTO {
     profileImageUrl: string;
     isActive: boolean;
     lastLogin: string;
-    skills: IUserSkill[];
     preferences: IUserPreferences;
     isEmailVerified: boolean;
+    isPhoneVerified: boolean;
     mfaEnabled: boolean;
     suspended: boolean;
     whitelist: boolean;
@@ -925,11 +943,6 @@ interface IUserPreferences {
     timeFormat: string;
 }
 
-interface IUserSkill {
-    name: string;
-    level: string;
-}
-
 interface IVerifyEmailResult {
     verified: boolean;
     email: string;
@@ -941,7 +954,10 @@ interface IWebhookDeliveryDTO {
     eventType: string;
     status: string;
     attempts: number;
+    payload: Record<string, unknown>;
     responseStatus: number | null;
+    responseBody: string | null;
+    nextAttemptAt: string | null;
     deliveredAt: string | null;
     createdAt: string;
 }
@@ -990,6 +1006,7 @@ interface IWorkspaceDTO {
     isPersonal: boolean;
     isArchived: boolean;
     archivedAt: string;
+    archivedBy: string;
     createdAt: string;
     updatedAt: string;
 }