@fonderie/client 0.8.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -53,6 +53,9 @@ declare class TokenStore {
53
53
  set(token: string | undefined): void;
54
54
  }
55
55
 
56
+ interface IReadOptions {
57
+ bust?: boolean | undefined;
58
+ }
56
59
  interface IApiResponse<T = undefined> {
57
60
  reason: string;
58
61
  explanation: string;
@@ -135,8 +138,8 @@ interface IMeResult {
135
138
  user: IUserDTO;
136
139
  }
137
140
  interface IMfaSetupResult {
138
- secret: string;
139
- uri: string;
141
+ qr: string;
142
+ backupCodes: string[];
140
143
  }
141
144
  interface IMfaEnabledResult {
142
145
  tokens: ITokens;
@@ -489,6 +492,7 @@ interface ICustomerLabelDTO {
489
492
  }
490
493
  interface ICustomerListResult {
491
494
  customers: ICustomerDTO[];
495
+ total: number;
492
496
  }
493
497
  interface ICustomerResult {
494
498
  customer: ICustomerDTO;
@@ -545,7 +549,7 @@ declare class AuditClient {
545
549
  constructor(http: HttpClient, tokens: TokenStore);
546
550
  setAccessToken(token: string | undefined): void;
547
551
  setWorkspaceId(workspaceId: string | undefined): void;
548
- listEvents(input?: IListAuditEventsInput): Promise<IApiResponse<IAuditPageResult>>;
552
+ listEvents(input?: IListAuditEventsInput, opts?: IReadOptions): Promise<IApiResponse<IAuditPageResult>>;
549
553
  }
550
554
 
551
555
  interface IRegisterInput {
@@ -605,7 +609,7 @@ declare class AuthClient {
605
609
  verifyEmail(token: string): Promise<IApiResponse<IVerifyEmailResult>>;
606
610
  logout(refreshToken?: string): Promise<IApiResponse<undefined>>;
607
611
  sendVerificationEmail(): Promise<IApiResponse<IResendVerificationResult>>;
608
- getUser(): Promise<IApiResponse<IMeResult>>;
612
+ getUser(opts?: IReadOptions): Promise<IApiResponse<IMeResult>>;
609
613
  updateProfile(input: IUpdateProfileInput): Promise<IApiResponse<IMeResult>>;
610
614
  updatePreferences(input: IUpdatePreferencesInput): Promise<IApiResponse<IMeResult>>;
611
615
  updateEmail(email: string): Promise<IApiResponse<unknown>>;
@@ -644,16 +648,16 @@ declare class BillingClient {
644
648
  constructor(http: HttpClient, tokens: TokenStore);
645
649
  setAccessToken(token: string | undefined): void;
646
650
  setWorkspaceId(workspaceId: string | undefined): void;
647
- listPlans(): Promise<IApiResponse<IPlanListResult>>;
648
- getPlan(planId: string): Promise<IApiResponse<IPlanResult>>;
651
+ listPlans(opts?: IReadOptions): Promise<IApiResponse<IPlanListResult>>;
652
+ getPlan(planId: string, opts?: IReadOptions): Promise<IApiResponse<IPlanResult>>;
649
653
  createPlan(input: ICreatePlanInput): Promise<IApiResponse<IPlanResult>>;
650
654
  updatePlan(planId: string, input: IUpdatePlanInput): Promise<IApiResponse<IPlanResult>>;
651
655
  deletePlan(planId: string): Promise<IApiResponse<undefined>>;
652
- getSubscription(): Promise<IApiResponse<ISubscriptionResult>>;
656
+ getSubscription(opts?: IReadOptions): Promise<IApiResponse<ISubscriptionResult>>;
653
657
  createCheckoutSession(input: ICheckoutInput): Promise<IApiResponse<ICheckoutUrlResult>>;
654
658
  createPortalSession(): Promise<IApiResponse<IPortalUrlResult>>;
655
659
  recordUsage(input: IRecordUsageInput): Promise<IApiResponse<undefined>>;
656
- getUsage(metric: string): Promise<IApiResponse<IUsageResult>>;
660
+ getUsage(metric: string, opts?: IReadOptions): Promise<IApiResponse<IUsageResult>>;
657
661
  }
658
662
 
659
663
  interface IListCustomersInput {
@@ -714,40 +718,40 @@ declare class CustomersClient {
714
718
  constructor(http: HttpClient, tokens: TokenStore);
715
719
  setAccessToken(token: string | undefined): void;
716
720
  setWorkspaceId(workspaceId: string | undefined): void;
717
- listCustomers(input?: IListCustomersInput): Promise<IApiResponse<ICustomerListResult>>;
721
+ listCustomers(input?: IListCustomersInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerListResult>>;
718
722
  createCustomer(input?: ICreateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
719
- getCustomer(customerId: string, input?: IGetCustomerInput): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
723
+ getCustomer(customerId: string, input?: IGetCustomerInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
720
724
  updateCustomer(customerId: string, input: IUpdateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
721
725
  deleteCustomer(customerId: string): Promise<IApiResponse<undefined>>;
722
726
  blacklistCustomer(customerId: string, input?: IBlacklistCustomerInput): Promise<IApiResponse<undefined>>;
723
727
  unblacklistCustomer(customerId: string): Promise<IApiResponse<undefined>>;
724
- listEmails(customerId: string): Promise<IApiResponse<ICustomerEmailListResult>>;
728
+ listEmails(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerEmailListResult>>;
725
729
  addEmail(customerId: string, input: IAddEmailInput): Promise<IApiResponse<ICustomerEmailResult>>;
726
730
  updateEmailLabel(customerId: string, emailId: string, label: string): Promise<IApiResponse<ICustomerEmailResult>>;
727
731
  setPrimaryEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
728
732
  removeEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
729
- listPhones(customerId: string): Promise<IApiResponse<ICustomerPhoneListResult>>;
733
+ listPhones(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerPhoneListResult>>;
730
734
  addPhone(customerId: string, input: IAddPhoneInput): Promise<IApiResponse<ICustomerPhoneResult>>;
731
735
  updatePhoneLabel(customerId: string, phoneId: string, label: string): Promise<IApiResponse<ICustomerPhoneResult>>;
732
736
  setPrimaryPhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
733
737
  removePhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
734
- listAddresses(customerId: string): Promise<IApiResponse<ICustomerAddressListResult>>;
738
+ listAddresses(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerAddressListResult>>;
735
739
  addAddress(customerId: string, input: IAddAddressInput): Promise<IApiResponse<ICustomerAddressResult>>;
736
740
  updateAddressLabel(customerId: string, addrId: string, label: string): Promise<IApiResponse<ICustomerAddressResult>>;
737
741
  setPrimaryAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
738
742
  removeAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
739
- listNotes(customerId: string): Promise<IApiResponse<ICustomerNoteListResult>>;
743
+ listNotes(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerNoteListResult>>;
740
744
  createNote(customerId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
741
745
  updateNote(customerId: string, noteId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
742
746
  deleteNote(customerId: string, noteId: string): Promise<IApiResponse<undefined>>;
743
- listTags(customerId: string): Promise<IApiResponse<ICustomerTagListResult>>;
747
+ listTags(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerTagListResult>>;
744
748
  addTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
745
749
  removeTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
746
- listRelationships(customerId: string): Promise<IApiResponse<ICustomerRelationshipListResult>>;
750
+ listRelationships(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerRelationshipListResult>>;
747
751
  addRelationship(customerId: string, input: IAddRelationshipInput): Promise<IApiResponse<ICustomerRelationshipResult>>;
748
752
  setPrimaryRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
749
753
  removeRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
750
- listLabels(type: CustomerLabelType): Promise<IApiResponse<ICustomerLabelListResult>>;
754
+ listLabels(type: CustomerLabelType, opts?: IReadOptions): Promise<IApiResponse<ICustomerLabelListResult>>;
751
755
  removeLabel(labelId: string): Promise<IApiResponse<undefined>>;
752
756
  }
753
757
 
@@ -767,12 +771,12 @@ declare class WebhooksClient {
767
771
  constructor(http: HttpClient, tokens: TokenStore);
768
772
  setAccessToken(token: string | undefined): void;
769
773
  setWorkspaceId(workspaceId: string | undefined): void;
770
- listEndpoints(): Promise<IApiResponse<IWebhookEndpointListResult>>;
774
+ listEndpoints(opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointListResult>>;
771
775
  createEndpoint(input: ICreateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointCreatedDTO>>;
772
- getEndpoint(endpointId: string): Promise<IApiResponse<IWebhookEndpointDTO>>;
776
+ getEndpoint(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointDTO>>;
773
777
  updateEndpoint(endpointId: string, input: IUpdateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointDTO>>;
774
778
  deleteEndpoint(endpointId: string): Promise<undefined>;
775
- listDeliveries(endpointId: string): Promise<IApiResponse<IWebhookDeliveryListResult>>;
779
+ listDeliveries(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookDeliveryListResult>>;
776
780
  testEndpoint(endpointId: string): Promise<IApiResponse<ITestWebhookResult>>;
777
781
  }
778
782
 
@@ -840,29 +844,29 @@ declare class WorkspacesClient {
840
844
  constructor(http: HttpClient, tokens: TokenStore);
841
845
  setAccessToken(token: string | undefined): void;
842
846
  setWorkspaceId(workspaceId: string | undefined): void;
843
- listWorkspaces(): Promise<IApiResponse<IWorkspaceListResult>>;
847
+ listWorkspaces(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceListResult>>;
844
848
  createWorkspace(input: ICreateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
845
- getWorkspace(id: string): Promise<IApiResponse<IWorkspaceResult>>;
849
+ getWorkspace(id: string, opts?: IReadOptions): Promise<IApiResponse<IWorkspaceResult>>;
846
850
  updateWorkspace(input: IUpdateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
847
851
  archiveWorkspace(): Promise<IApiResponse<undefined>>;
848
852
  restoreWorkspace(): Promise<IApiResponse<undefined>>;
849
- listRoles(): Promise<IApiResponse<IRoleListResult>>;
853
+ listRoles(opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
850
854
  createRole(input: ICreateRoleInput): Promise<IApiResponse<IRoleResult>>;
851
- getRole(roleId: string): Promise<IApiResponse<IRoleResult>>;
855
+ getRole(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleResult>>;
852
856
  updateRole(roleId: string, input: IUpdateRoleInput): Promise<IApiResponse<IRoleResult>>;
853
857
  removeRole(roleId: string): Promise<IApiResponse<undefined>>;
854
- getRolePermissions(roleId: string): Promise<IApiResponse<IRolePermissionsResult>>;
858
+ getRolePermissions(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRolePermissionsResult>>;
855
859
  setRolePermissions(roleId: string, permissions: IRolePermissionInput[]): Promise<IApiResponse<undefined>>;
856
- listMembers(): Promise<IApiResponse<IMemberListResult>>;
860
+ listMembers(opts?: IReadOptions): Promise<IApiResponse<IMemberListResult>>;
857
861
  removeMember(userId: string): Promise<IApiResponse<undefined>>;
858
- getMemberRoles(userId: string): Promise<IApiResponse<IRoleListResult>>;
862
+ getMemberRoles(userId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
859
863
  addMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
860
864
  removeMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
861
- listInvitations(): Promise<IApiResponse<IInvitationListResult>>;
865
+ listInvitations(opts?: IReadOptions): Promise<IApiResponse<IInvitationListResult>>;
862
866
  invite(entries: IInviteEntry | IInviteEntry[]): Promise<IApiResponse<IInviteResult>>;
863
867
  cancelInvitation(inviteId: string): Promise<IApiResponse<undefined>>;
864
868
  acceptInvitation(pin: string): Promise<IApiResponse<IAcceptInvitationResult>>;
865
- getSettings(): Promise<IApiResponse<IWorkspaceSettingsResult>>;
869
+ getSettings(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceSettingsResult>>;
866
870
  updateSettings(input: IUpdateSettingsInput): Promise<IApiResponse<IWorkspaceSettingsResult>>;
867
871
  }
868
872
 
@@ -982,4 +986,4 @@ declare class CourierAdminClient {
982
986
  rollback(type: string, input: IRollbackTemplateInput, locale?: string | null): Promise<IApiResponse<ITemplateEntry>>;
983
987
  }
984
988
 
985
- export { AuditClient, AuthClient, BillingClient, ConfigAdminClient, CourierAdminClient, type CustomerLabelType, type CustomerSex, type CustomerType, CustomersClient, FonderieApiError, FonderieClient, type IAcceptInvitationResult, type IAddAddressInput, type IAddEmailInput, type IAddPhoneInput, type IAddRelationshipInput, type IAddressDTO, type IApiError, type IApiResponse, type IAuditEventDTO, type IAuditPageResult, type IBlacklistCustomerInput, type ICache, type IChangePasswordInput, type ICheckoutInput, type ICheckoutUrlResult, type IClientAuthConfig, type IConfigAdminClientOptions, type IConfigEntry, type IConfigRevision, type ICourierAdminClientOptions, type ICreateCustomerInput, type ICreatePlanInput, type ICreateRoleInput, type ICreateWebhookEndpointInput, type ICreateWorkspaceInput, type ICustomerAddressDTO, type ICustomerAddressListResult, type ICustomerAddressResult, type ICustomerDTO, type ICustomerDetailD2DTO, type ICustomerDetailDTO, type ICustomerEmailDTO, type ICustomerEmailListResult, type ICustomerEmailResult, type ICustomerLabelDTO, type ICustomerLabelListResult, type ICustomerListResult, type ICustomerNoteDTO, type ICustomerNoteListResult, type ICustomerNoteResult, type ICustomerPhoneDTO, type ICustomerPhoneListResult, type ICustomerPhoneResult, type ICustomerRelationshipDTO, type ICustomerRelationshipExpandedD2DTO, type ICustomerRelationshipExpandedDTO, type ICustomerRelationshipListResult, type ICustomerRelationshipResult, type ICustomerResult, type ICustomerShallowDTO, type ICustomerTagListResult, type IFonderieClientOptions, type IGetCustomerInput, type IInvitationDTO, type IInvitationListResult, type IInviteEntry, type IInviteResult, type IListAuditEventsInput, type IListCustomersInput, type ILoginInput, type ILoginResult, type IMeResult, type IMemberDTO, type IMemberListResult, type IMemoryCacheOptions, type IMfaEnabledResult, type IMfaRequiredResult, type IMfaSetupResult, type IPlanDTO, type IPlanFeature, type IPlanListResult, type IPlanResult, type IPortalUrlResult, type IRecordUsageInput, type IRefreshResult, type IRegisterInput, type IRegisterResult, type IRequestConfig, type IResendVerificationResult, type IResetPasswordInput, type IRevealSecretResult, type IRoleDTO, type IRoleListResult, type IRolePermission, type IRolePermissionInput, type IRolePermissionsResult, type IRoleResult, type IRollbackInput, type IRollbackTemplateInput, type ISecretEntry, type ISecretRevision, type ISetConfigInput, type ISetSecretInput, type ISetTemplateInput, type ISubscriptionDTO, type ISubscriptionResult, type ITemplateEntry, type ITemplateRevision, type ITestWebhookResult, type ITokens, type IUpdateCustomerInput, type IUpdatePlanInput, type IUpdatePreferencesInput, type IUpdateProfileInput, type IUpdateRoleInput, type IUpdateSettingsInput, type IUpdateWebhookEndpointInput, type IUpdateWorkspaceInput, type IUsageResult, type IUserDTO, type IUserPreferences, type IUserSkill, type IVerifyEmailResult, type IWebhookDeliveryDTO, type IWebhookDeliveryListResult, type IWebhookEndpointCreatedDTO, type IWebhookEndpointDTO, type IWebhookEndpointListResult, type IWorkspaceAddressDTO, type IWorkspaceDTO, type IWorkspaceListResult, type IWorkspaceResult, type IWorkspaceSettingsDTO, type IWorkspaceSettingsResult, type SubscriberType, WebhooksClient, WorkspacesClient, createMemoryCache, isMfaRequired };
989
+ export { AuditClient, AuthClient, BillingClient, ConfigAdminClient, CourierAdminClient, type CustomerLabelType, type CustomerSex, type CustomerType, CustomersClient, FonderieApiError, FonderieClient, type IAcceptInvitationResult, type IAddAddressInput, type IAddEmailInput, type IAddPhoneInput, type IAddRelationshipInput, type IAddressDTO, type IApiError, type IApiResponse, type IAuditEventDTO, type IAuditPageResult, type IBlacklistCustomerInput, type ICache, type IChangePasswordInput, type ICheckoutInput, type ICheckoutUrlResult, type IClientAuthConfig, type IConfigAdminClientOptions, type IConfigEntry, type IConfigRevision, type ICourierAdminClientOptions, type ICreateCustomerInput, type ICreatePlanInput, type ICreateRoleInput, type ICreateWebhookEndpointInput, type ICreateWorkspaceInput, type ICustomerAddressDTO, type ICustomerAddressListResult, type ICustomerAddressResult, type ICustomerDTO, type ICustomerDetailD2DTO, type ICustomerDetailDTO, type ICustomerEmailDTO, type ICustomerEmailListResult, type ICustomerEmailResult, type ICustomerLabelDTO, type ICustomerLabelListResult, type ICustomerListResult, type ICustomerNoteDTO, type ICustomerNoteListResult, type ICustomerNoteResult, type ICustomerPhoneDTO, type ICustomerPhoneListResult, type ICustomerPhoneResult, type ICustomerRelationshipDTO, type ICustomerRelationshipExpandedD2DTO, type ICustomerRelationshipExpandedDTO, type ICustomerRelationshipListResult, type ICustomerRelationshipResult, type ICustomerResult, type ICustomerShallowDTO, type ICustomerTagListResult, type IFonderieClientOptions, type IGetCustomerInput, type IInvitationDTO, type IInvitationListResult, type IInviteEntry, type IInviteResult, type IListAuditEventsInput, type IListCustomersInput, type ILoginInput, type ILoginResult, type IMeResult, type IMemberDTO, type IMemberListResult, type IMemoryCacheOptions, type IMfaEnabledResult, type IMfaRequiredResult, type IMfaSetupResult, type IPlanDTO, type IPlanFeature, type IPlanListResult, type IPlanResult, type IPortalUrlResult, type IReadOptions, type IRecordUsageInput, type IRefreshResult, type IRegisterInput, type IRegisterResult, type IRequestConfig, type IResendVerificationResult, type IResetPasswordInput, type IRevealSecretResult, type IRoleDTO, type IRoleListResult, type IRolePermission, type IRolePermissionInput, type IRolePermissionsResult, type IRoleResult, type IRollbackInput, type IRollbackTemplateInput, type ISecretEntry, type ISecretRevision, type ISetConfigInput, type ISetSecretInput, type ISetTemplateInput, type ISubscriptionDTO, type ISubscriptionResult, type ITemplateEntry, type ITemplateRevision, type ITestWebhookResult, type ITokens, type IUpdateCustomerInput, type IUpdatePlanInput, type IUpdatePreferencesInput, type IUpdateProfileInput, type IUpdateRoleInput, type IUpdateSettingsInput, type IUpdateWebhookEndpointInput, type IUpdateWorkspaceInput, type IUsageResult, type IUserDTO, type IUserPreferences, type IUserSkill, type IVerifyEmailResult, type IWebhookDeliveryDTO, type IWebhookDeliveryListResult, type IWebhookEndpointCreatedDTO, type IWebhookEndpointDTO, type IWebhookEndpointListResult, type IWorkspaceAddressDTO, type IWorkspaceDTO, type IWorkspaceListResult, type IWorkspaceResult, type IWorkspaceSettingsDTO, type IWorkspaceSettingsResult, type SubscriberType, WebhooksClient, WorkspacesClient, createMemoryCache, isMfaRequired };
package/dist/index.d.ts CHANGED
@@ -53,6 +53,9 @@ declare class TokenStore {
53
53
  set(token: string | undefined): void;
54
54
  }
55
55
 
56
+ interface IReadOptions {
57
+ bust?: boolean | undefined;
58
+ }
56
59
  interface IApiResponse<T = undefined> {
57
60
  reason: string;
58
61
  explanation: string;
@@ -135,8 +138,8 @@ interface IMeResult {
135
138
  user: IUserDTO;
136
139
  }
137
140
  interface IMfaSetupResult {
138
- secret: string;
139
- uri: string;
141
+ qr: string;
142
+ backupCodes: string[];
140
143
  }
141
144
  interface IMfaEnabledResult {
142
145
  tokens: ITokens;
@@ -489,6 +492,7 @@ interface ICustomerLabelDTO {
489
492
  }
490
493
  interface ICustomerListResult {
491
494
  customers: ICustomerDTO[];
495
+ total: number;
492
496
  }
493
497
  interface ICustomerResult {
494
498
  customer: ICustomerDTO;
@@ -545,7 +549,7 @@ declare class AuditClient {
545
549
  constructor(http: HttpClient, tokens: TokenStore);
546
550
  setAccessToken(token: string | undefined): void;
547
551
  setWorkspaceId(workspaceId: string | undefined): void;
548
- listEvents(input?: IListAuditEventsInput): Promise<IApiResponse<IAuditPageResult>>;
552
+ listEvents(input?: IListAuditEventsInput, opts?: IReadOptions): Promise<IApiResponse<IAuditPageResult>>;
549
553
  }
550
554
 
551
555
  interface IRegisterInput {
@@ -605,7 +609,7 @@ declare class AuthClient {
605
609
  verifyEmail(token: string): Promise<IApiResponse<IVerifyEmailResult>>;
606
610
  logout(refreshToken?: string): Promise<IApiResponse<undefined>>;
607
611
  sendVerificationEmail(): Promise<IApiResponse<IResendVerificationResult>>;
608
- getUser(): Promise<IApiResponse<IMeResult>>;
612
+ getUser(opts?: IReadOptions): Promise<IApiResponse<IMeResult>>;
609
613
  updateProfile(input: IUpdateProfileInput): Promise<IApiResponse<IMeResult>>;
610
614
  updatePreferences(input: IUpdatePreferencesInput): Promise<IApiResponse<IMeResult>>;
611
615
  updateEmail(email: string): Promise<IApiResponse<unknown>>;
@@ -644,16 +648,16 @@ declare class BillingClient {
644
648
  constructor(http: HttpClient, tokens: TokenStore);
645
649
  setAccessToken(token: string | undefined): void;
646
650
  setWorkspaceId(workspaceId: string | undefined): void;
647
- listPlans(): Promise<IApiResponse<IPlanListResult>>;
648
- getPlan(planId: string): Promise<IApiResponse<IPlanResult>>;
651
+ listPlans(opts?: IReadOptions): Promise<IApiResponse<IPlanListResult>>;
652
+ getPlan(planId: string, opts?: IReadOptions): Promise<IApiResponse<IPlanResult>>;
649
653
  createPlan(input: ICreatePlanInput): Promise<IApiResponse<IPlanResult>>;
650
654
  updatePlan(planId: string, input: IUpdatePlanInput): Promise<IApiResponse<IPlanResult>>;
651
655
  deletePlan(planId: string): Promise<IApiResponse<undefined>>;
652
- getSubscription(): Promise<IApiResponse<ISubscriptionResult>>;
656
+ getSubscription(opts?: IReadOptions): Promise<IApiResponse<ISubscriptionResult>>;
653
657
  createCheckoutSession(input: ICheckoutInput): Promise<IApiResponse<ICheckoutUrlResult>>;
654
658
  createPortalSession(): Promise<IApiResponse<IPortalUrlResult>>;
655
659
  recordUsage(input: IRecordUsageInput): Promise<IApiResponse<undefined>>;
656
- getUsage(metric: string): Promise<IApiResponse<IUsageResult>>;
660
+ getUsage(metric: string, opts?: IReadOptions): Promise<IApiResponse<IUsageResult>>;
657
661
  }
658
662
 
659
663
  interface IListCustomersInput {
@@ -714,40 +718,40 @@ declare class CustomersClient {
714
718
  constructor(http: HttpClient, tokens: TokenStore);
715
719
  setAccessToken(token: string | undefined): void;
716
720
  setWorkspaceId(workspaceId: string | undefined): void;
717
- listCustomers(input?: IListCustomersInput): Promise<IApiResponse<ICustomerListResult>>;
721
+ listCustomers(input?: IListCustomersInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerListResult>>;
718
722
  createCustomer(input?: ICreateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
719
- getCustomer(customerId: string, input?: IGetCustomerInput): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
723
+ getCustomer(customerId: string, input?: IGetCustomerInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
720
724
  updateCustomer(customerId: string, input: IUpdateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
721
725
  deleteCustomer(customerId: string): Promise<IApiResponse<undefined>>;
722
726
  blacklistCustomer(customerId: string, input?: IBlacklistCustomerInput): Promise<IApiResponse<undefined>>;
723
727
  unblacklistCustomer(customerId: string): Promise<IApiResponse<undefined>>;
724
- listEmails(customerId: string): Promise<IApiResponse<ICustomerEmailListResult>>;
728
+ listEmails(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerEmailListResult>>;
725
729
  addEmail(customerId: string, input: IAddEmailInput): Promise<IApiResponse<ICustomerEmailResult>>;
726
730
  updateEmailLabel(customerId: string, emailId: string, label: string): Promise<IApiResponse<ICustomerEmailResult>>;
727
731
  setPrimaryEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
728
732
  removeEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
729
- listPhones(customerId: string): Promise<IApiResponse<ICustomerPhoneListResult>>;
733
+ listPhones(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerPhoneListResult>>;
730
734
  addPhone(customerId: string, input: IAddPhoneInput): Promise<IApiResponse<ICustomerPhoneResult>>;
731
735
  updatePhoneLabel(customerId: string, phoneId: string, label: string): Promise<IApiResponse<ICustomerPhoneResult>>;
732
736
  setPrimaryPhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
733
737
  removePhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
734
- listAddresses(customerId: string): Promise<IApiResponse<ICustomerAddressListResult>>;
738
+ listAddresses(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerAddressListResult>>;
735
739
  addAddress(customerId: string, input: IAddAddressInput): Promise<IApiResponse<ICustomerAddressResult>>;
736
740
  updateAddressLabel(customerId: string, addrId: string, label: string): Promise<IApiResponse<ICustomerAddressResult>>;
737
741
  setPrimaryAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
738
742
  removeAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
739
- listNotes(customerId: string): Promise<IApiResponse<ICustomerNoteListResult>>;
743
+ listNotes(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerNoteListResult>>;
740
744
  createNote(customerId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
741
745
  updateNote(customerId: string, noteId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
742
746
  deleteNote(customerId: string, noteId: string): Promise<IApiResponse<undefined>>;
743
- listTags(customerId: string): Promise<IApiResponse<ICustomerTagListResult>>;
747
+ listTags(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerTagListResult>>;
744
748
  addTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
745
749
  removeTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
746
- listRelationships(customerId: string): Promise<IApiResponse<ICustomerRelationshipListResult>>;
750
+ listRelationships(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerRelationshipListResult>>;
747
751
  addRelationship(customerId: string, input: IAddRelationshipInput): Promise<IApiResponse<ICustomerRelationshipResult>>;
748
752
  setPrimaryRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
749
753
  removeRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
750
- listLabels(type: CustomerLabelType): Promise<IApiResponse<ICustomerLabelListResult>>;
754
+ listLabels(type: CustomerLabelType, opts?: IReadOptions): Promise<IApiResponse<ICustomerLabelListResult>>;
751
755
  removeLabel(labelId: string): Promise<IApiResponse<undefined>>;
752
756
  }
753
757
 
@@ -767,12 +771,12 @@ declare class WebhooksClient {
767
771
  constructor(http: HttpClient, tokens: TokenStore);
768
772
  setAccessToken(token: string | undefined): void;
769
773
  setWorkspaceId(workspaceId: string | undefined): void;
770
- listEndpoints(): Promise<IApiResponse<IWebhookEndpointListResult>>;
774
+ listEndpoints(opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointListResult>>;
771
775
  createEndpoint(input: ICreateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointCreatedDTO>>;
772
- getEndpoint(endpointId: string): Promise<IApiResponse<IWebhookEndpointDTO>>;
776
+ getEndpoint(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointDTO>>;
773
777
  updateEndpoint(endpointId: string, input: IUpdateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointDTO>>;
774
778
  deleteEndpoint(endpointId: string): Promise<undefined>;
775
- listDeliveries(endpointId: string): Promise<IApiResponse<IWebhookDeliveryListResult>>;
779
+ listDeliveries(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookDeliveryListResult>>;
776
780
  testEndpoint(endpointId: string): Promise<IApiResponse<ITestWebhookResult>>;
777
781
  }
778
782
 
@@ -840,29 +844,29 @@ declare class WorkspacesClient {
840
844
  constructor(http: HttpClient, tokens: TokenStore);
841
845
  setAccessToken(token: string | undefined): void;
842
846
  setWorkspaceId(workspaceId: string | undefined): void;
843
- listWorkspaces(): Promise<IApiResponse<IWorkspaceListResult>>;
847
+ listWorkspaces(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceListResult>>;
844
848
  createWorkspace(input: ICreateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
845
- getWorkspace(id: string): Promise<IApiResponse<IWorkspaceResult>>;
849
+ getWorkspace(id: string, opts?: IReadOptions): Promise<IApiResponse<IWorkspaceResult>>;
846
850
  updateWorkspace(input: IUpdateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
847
851
  archiveWorkspace(): Promise<IApiResponse<undefined>>;
848
852
  restoreWorkspace(): Promise<IApiResponse<undefined>>;
849
- listRoles(): Promise<IApiResponse<IRoleListResult>>;
853
+ listRoles(opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
850
854
  createRole(input: ICreateRoleInput): Promise<IApiResponse<IRoleResult>>;
851
- getRole(roleId: string): Promise<IApiResponse<IRoleResult>>;
855
+ getRole(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleResult>>;
852
856
  updateRole(roleId: string, input: IUpdateRoleInput): Promise<IApiResponse<IRoleResult>>;
853
857
  removeRole(roleId: string): Promise<IApiResponse<undefined>>;
854
- getRolePermissions(roleId: string): Promise<IApiResponse<IRolePermissionsResult>>;
858
+ getRolePermissions(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRolePermissionsResult>>;
855
859
  setRolePermissions(roleId: string, permissions: IRolePermissionInput[]): Promise<IApiResponse<undefined>>;
856
- listMembers(): Promise<IApiResponse<IMemberListResult>>;
860
+ listMembers(opts?: IReadOptions): Promise<IApiResponse<IMemberListResult>>;
857
861
  removeMember(userId: string): Promise<IApiResponse<undefined>>;
858
- getMemberRoles(userId: string): Promise<IApiResponse<IRoleListResult>>;
862
+ getMemberRoles(userId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
859
863
  addMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
860
864
  removeMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
861
- listInvitations(): Promise<IApiResponse<IInvitationListResult>>;
865
+ listInvitations(opts?: IReadOptions): Promise<IApiResponse<IInvitationListResult>>;
862
866
  invite(entries: IInviteEntry | IInviteEntry[]): Promise<IApiResponse<IInviteResult>>;
863
867
  cancelInvitation(inviteId: string): Promise<IApiResponse<undefined>>;
864
868
  acceptInvitation(pin: string): Promise<IApiResponse<IAcceptInvitationResult>>;
865
- getSettings(): Promise<IApiResponse<IWorkspaceSettingsResult>>;
869
+ getSettings(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceSettingsResult>>;
866
870
  updateSettings(input: IUpdateSettingsInput): Promise<IApiResponse<IWorkspaceSettingsResult>>;
867
871
  }
868
872
 
@@ -982,4 +986,4 @@ declare class CourierAdminClient {
982
986
  rollback(type: string, input: IRollbackTemplateInput, locale?: string | null): Promise<IApiResponse<ITemplateEntry>>;
983
987
  }
984
988
 
985
- export { AuditClient, AuthClient, BillingClient, ConfigAdminClient, CourierAdminClient, type CustomerLabelType, type CustomerSex, type CustomerType, CustomersClient, FonderieApiError, FonderieClient, type IAcceptInvitationResult, type IAddAddressInput, type IAddEmailInput, type IAddPhoneInput, type IAddRelationshipInput, type IAddressDTO, type IApiError, type IApiResponse, type IAuditEventDTO, type IAuditPageResult, type IBlacklistCustomerInput, type ICache, type IChangePasswordInput, type ICheckoutInput, type ICheckoutUrlResult, type IClientAuthConfig, type IConfigAdminClientOptions, type IConfigEntry, type IConfigRevision, type ICourierAdminClientOptions, type ICreateCustomerInput, type ICreatePlanInput, type ICreateRoleInput, type ICreateWebhookEndpointInput, type ICreateWorkspaceInput, type ICustomerAddressDTO, type ICustomerAddressListResult, type ICustomerAddressResult, type ICustomerDTO, type ICustomerDetailD2DTO, type ICustomerDetailDTO, type ICustomerEmailDTO, type ICustomerEmailListResult, type ICustomerEmailResult, type ICustomerLabelDTO, type ICustomerLabelListResult, type ICustomerListResult, type ICustomerNoteDTO, type ICustomerNoteListResult, type ICustomerNoteResult, type ICustomerPhoneDTO, type ICustomerPhoneListResult, type ICustomerPhoneResult, type ICustomerRelationshipDTO, type ICustomerRelationshipExpandedD2DTO, type ICustomerRelationshipExpandedDTO, type ICustomerRelationshipListResult, type ICustomerRelationshipResult, type ICustomerResult, type ICustomerShallowDTO, type ICustomerTagListResult, type IFonderieClientOptions, type IGetCustomerInput, type IInvitationDTO, type IInvitationListResult, type IInviteEntry, type IInviteResult, type IListAuditEventsInput, type IListCustomersInput, type ILoginInput, type ILoginResult, type IMeResult, type IMemberDTO, type IMemberListResult, type IMemoryCacheOptions, type IMfaEnabledResult, type IMfaRequiredResult, type IMfaSetupResult, type IPlanDTO, type IPlanFeature, type IPlanListResult, type IPlanResult, type IPortalUrlResult, type IRecordUsageInput, type IRefreshResult, type IRegisterInput, type IRegisterResult, type IRequestConfig, type IResendVerificationResult, type IResetPasswordInput, type IRevealSecretResult, type IRoleDTO, type IRoleListResult, type IRolePermission, type IRolePermissionInput, type IRolePermissionsResult, type IRoleResult, type IRollbackInput, type IRollbackTemplateInput, type ISecretEntry, type ISecretRevision, type ISetConfigInput, type ISetSecretInput, type ISetTemplateInput, type ISubscriptionDTO, type ISubscriptionResult, type ITemplateEntry, type ITemplateRevision, type ITestWebhookResult, type ITokens, type IUpdateCustomerInput, type IUpdatePlanInput, type IUpdatePreferencesInput, type IUpdateProfileInput, type IUpdateRoleInput, type IUpdateSettingsInput, type IUpdateWebhookEndpointInput, type IUpdateWorkspaceInput, type IUsageResult, type IUserDTO, type IUserPreferences, type IUserSkill, type IVerifyEmailResult, type IWebhookDeliveryDTO, type IWebhookDeliveryListResult, type IWebhookEndpointCreatedDTO, type IWebhookEndpointDTO, type IWebhookEndpointListResult, type IWorkspaceAddressDTO, type IWorkspaceDTO, type IWorkspaceListResult, type IWorkspaceResult, type IWorkspaceSettingsDTO, type IWorkspaceSettingsResult, type SubscriberType, WebhooksClient, WorkspacesClient, createMemoryCache, isMfaRequired };
989
+ export { AuditClient, AuthClient, BillingClient, ConfigAdminClient, CourierAdminClient, type CustomerLabelType, type CustomerSex, type CustomerType, CustomersClient, FonderieApiError, FonderieClient, type IAcceptInvitationResult, type IAddAddressInput, type IAddEmailInput, type IAddPhoneInput, type IAddRelationshipInput, type IAddressDTO, type IApiError, type IApiResponse, type IAuditEventDTO, type IAuditPageResult, type IBlacklistCustomerInput, type ICache, type IChangePasswordInput, type ICheckoutInput, type ICheckoutUrlResult, type IClientAuthConfig, type IConfigAdminClientOptions, type IConfigEntry, type IConfigRevision, type ICourierAdminClientOptions, type ICreateCustomerInput, type ICreatePlanInput, type ICreateRoleInput, type ICreateWebhookEndpointInput, type ICreateWorkspaceInput, type ICustomerAddressDTO, type ICustomerAddressListResult, type ICustomerAddressResult, type ICustomerDTO, type ICustomerDetailD2DTO, type ICustomerDetailDTO, type ICustomerEmailDTO, type ICustomerEmailListResult, type ICustomerEmailResult, type ICustomerLabelDTO, type ICustomerLabelListResult, type ICustomerListResult, type ICustomerNoteDTO, type ICustomerNoteListResult, type ICustomerNoteResult, type ICustomerPhoneDTO, type ICustomerPhoneListResult, type ICustomerPhoneResult, type ICustomerRelationshipDTO, type ICustomerRelationshipExpandedD2DTO, type ICustomerRelationshipExpandedDTO, type ICustomerRelationshipListResult, type ICustomerRelationshipResult, type ICustomerResult, type ICustomerShallowDTO, type ICustomerTagListResult, type IFonderieClientOptions, type IGetCustomerInput, type IInvitationDTO, type IInvitationListResult, type IInviteEntry, type IInviteResult, type IListAuditEventsInput, type IListCustomersInput, type ILoginInput, type ILoginResult, type IMeResult, type IMemberDTO, type IMemberListResult, type IMemoryCacheOptions, type IMfaEnabledResult, type IMfaRequiredResult, type IMfaSetupResult, type IPlanDTO, type IPlanFeature, type IPlanListResult, type IPlanResult, type IPortalUrlResult, type IReadOptions, type IRecordUsageInput, type IRefreshResult, type IRegisterInput, type IRegisterResult, type IRequestConfig, type IResendVerificationResult, type IResetPasswordInput, type IRevealSecretResult, type IRoleDTO, type IRoleListResult, type IRolePermission, type IRolePermissionInput, type IRolePermissionsResult, type IRoleResult, type IRollbackInput, type IRollbackTemplateInput, type ISecretEntry, type ISecretRevision, type ISetConfigInput, type ISetSecretInput, type ISetTemplateInput, type ISubscriptionDTO, type ISubscriptionResult, type ITemplateEntry, type ITemplateRevision, type ITestWebhookResult, type ITokens, type IUpdateCustomerInput, type IUpdatePlanInput, type IUpdatePreferencesInput, type IUpdateProfileInput, type IUpdateRoleInput, type IUpdateSettingsInput, type IUpdateWebhookEndpointInput, type IUpdateWorkspaceInput, type IUsageResult, type IUserDTO, type IUserPreferences, type IUserSkill, type IVerifyEmailResult, type IWebhookDeliveryDTO, type IWebhookDeliveryListResult, type IWebhookEndpointCreatedDTO, type IWebhookEndpointDTO, type IWebhookEndpointListResult, type IWorkspaceAddressDTO, type IWorkspaceDTO, type IWorkspaceListResult, type IWorkspaceResult, type IWorkspaceSettingsDTO, type IWorkspaceSettingsResult, type SubscriberType, WebhooksClient, WorkspacesClient, createMemoryCache, isMfaRequired };