@fonderie/client 0.9.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/brain/signatures.md +31 -27
- package/dist/index.cjs +85 -55
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +31 -28
- package/dist/index.d.ts +31 -28
- package/dist/index.js +85 -55
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
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;
|
|
@@ -546,7 +549,7 @@ declare class AuditClient {
|
|
|
546
549
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
547
550
|
setAccessToken(token: string | undefined): void;
|
|
548
551
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
549
|
-
listEvents(input?: IListAuditEventsInput): Promise<IApiResponse<IAuditPageResult>>;
|
|
552
|
+
listEvents(input?: IListAuditEventsInput, opts?: IReadOptions): Promise<IApiResponse<IAuditPageResult>>;
|
|
550
553
|
}
|
|
551
554
|
|
|
552
555
|
interface IRegisterInput {
|
|
@@ -606,7 +609,7 @@ declare class AuthClient {
|
|
|
606
609
|
verifyEmail(token: string): Promise<IApiResponse<IVerifyEmailResult>>;
|
|
607
610
|
logout(refreshToken?: string): Promise<IApiResponse<undefined>>;
|
|
608
611
|
sendVerificationEmail(): Promise<IApiResponse<IResendVerificationResult>>;
|
|
609
|
-
getUser(): Promise<IApiResponse<IMeResult>>;
|
|
612
|
+
getUser(opts?: IReadOptions): Promise<IApiResponse<IMeResult>>;
|
|
610
613
|
updateProfile(input: IUpdateProfileInput): Promise<IApiResponse<IMeResult>>;
|
|
611
614
|
updatePreferences(input: IUpdatePreferencesInput): Promise<IApiResponse<IMeResult>>;
|
|
612
615
|
updateEmail(email: string): Promise<IApiResponse<unknown>>;
|
|
@@ -645,16 +648,16 @@ declare class BillingClient {
|
|
|
645
648
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
646
649
|
setAccessToken(token: string | undefined): void;
|
|
647
650
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
648
|
-
listPlans(): Promise<IApiResponse<IPlanListResult>>;
|
|
649
|
-
getPlan(planId: string): Promise<IApiResponse<IPlanResult>>;
|
|
651
|
+
listPlans(opts?: IReadOptions): Promise<IApiResponse<IPlanListResult>>;
|
|
652
|
+
getPlan(planId: string, opts?: IReadOptions): Promise<IApiResponse<IPlanResult>>;
|
|
650
653
|
createPlan(input: ICreatePlanInput): Promise<IApiResponse<IPlanResult>>;
|
|
651
654
|
updatePlan(planId: string, input: IUpdatePlanInput): Promise<IApiResponse<IPlanResult>>;
|
|
652
655
|
deletePlan(planId: string): Promise<IApiResponse<undefined>>;
|
|
653
|
-
getSubscription(): Promise<IApiResponse<ISubscriptionResult>>;
|
|
656
|
+
getSubscription(opts?: IReadOptions): Promise<IApiResponse<ISubscriptionResult>>;
|
|
654
657
|
createCheckoutSession(input: ICheckoutInput): Promise<IApiResponse<ICheckoutUrlResult>>;
|
|
655
658
|
createPortalSession(): Promise<IApiResponse<IPortalUrlResult>>;
|
|
656
659
|
recordUsage(input: IRecordUsageInput): Promise<IApiResponse<undefined>>;
|
|
657
|
-
getUsage(metric: string): Promise<IApiResponse<IUsageResult>>;
|
|
660
|
+
getUsage(metric: string, opts?: IReadOptions): Promise<IApiResponse<IUsageResult>>;
|
|
658
661
|
}
|
|
659
662
|
|
|
660
663
|
interface IListCustomersInput {
|
|
@@ -715,40 +718,40 @@ declare class CustomersClient {
|
|
|
715
718
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
716
719
|
setAccessToken(token: string | undefined): void;
|
|
717
720
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
718
|
-
listCustomers(input?: IListCustomersInput): Promise<IApiResponse<ICustomerListResult>>;
|
|
721
|
+
listCustomers(input?: IListCustomersInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerListResult>>;
|
|
719
722
|
createCustomer(input?: ICreateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
|
|
720
|
-
getCustomer(customerId: string, input?: IGetCustomerInput): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
|
|
723
|
+
getCustomer(customerId: string, input?: IGetCustomerInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
|
|
721
724
|
updateCustomer(customerId: string, input: IUpdateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
|
|
722
725
|
deleteCustomer(customerId: string): Promise<IApiResponse<undefined>>;
|
|
723
726
|
blacklistCustomer(customerId: string, input?: IBlacklistCustomerInput): Promise<IApiResponse<undefined>>;
|
|
724
727
|
unblacklistCustomer(customerId: string): Promise<IApiResponse<undefined>>;
|
|
725
|
-
listEmails(customerId: string): Promise<IApiResponse<ICustomerEmailListResult>>;
|
|
728
|
+
listEmails(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerEmailListResult>>;
|
|
726
729
|
addEmail(customerId: string, input: IAddEmailInput): Promise<IApiResponse<ICustomerEmailResult>>;
|
|
727
730
|
updateEmailLabel(customerId: string, emailId: string, label: string): Promise<IApiResponse<ICustomerEmailResult>>;
|
|
728
731
|
setPrimaryEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
|
|
729
732
|
removeEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
|
|
730
|
-
listPhones(customerId: string): Promise<IApiResponse<ICustomerPhoneListResult>>;
|
|
733
|
+
listPhones(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerPhoneListResult>>;
|
|
731
734
|
addPhone(customerId: string, input: IAddPhoneInput): Promise<IApiResponse<ICustomerPhoneResult>>;
|
|
732
735
|
updatePhoneLabel(customerId: string, phoneId: string, label: string): Promise<IApiResponse<ICustomerPhoneResult>>;
|
|
733
736
|
setPrimaryPhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
|
|
734
737
|
removePhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
|
|
735
|
-
listAddresses(customerId: string): Promise<IApiResponse<ICustomerAddressListResult>>;
|
|
738
|
+
listAddresses(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerAddressListResult>>;
|
|
736
739
|
addAddress(customerId: string, input: IAddAddressInput): Promise<IApiResponse<ICustomerAddressResult>>;
|
|
737
740
|
updateAddressLabel(customerId: string, addrId: string, label: string): Promise<IApiResponse<ICustomerAddressResult>>;
|
|
738
741
|
setPrimaryAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
|
|
739
742
|
removeAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
|
|
740
|
-
listNotes(customerId: string): Promise<IApiResponse<ICustomerNoteListResult>>;
|
|
743
|
+
listNotes(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerNoteListResult>>;
|
|
741
744
|
createNote(customerId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
|
|
742
745
|
updateNote(customerId: string, noteId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
|
|
743
746
|
deleteNote(customerId: string, noteId: string): Promise<IApiResponse<undefined>>;
|
|
744
|
-
listTags(customerId: string): Promise<IApiResponse<ICustomerTagListResult>>;
|
|
747
|
+
listTags(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerTagListResult>>;
|
|
745
748
|
addTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
|
|
746
749
|
removeTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
|
|
747
|
-
listRelationships(customerId: string): Promise<IApiResponse<ICustomerRelationshipListResult>>;
|
|
750
|
+
listRelationships(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerRelationshipListResult>>;
|
|
748
751
|
addRelationship(customerId: string, input: IAddRelationshipInput): Promise<IApiResponse<ICustomerRelationshipResult>>;
|
|
749
752
|
setPrimaryRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
|
|
750
753
|
removeRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
|
|
751
|
-
listLabels(type: CustomerLabelType): Promise<IApiResponse<ICustomerLabelListResult>>;
|
|
754
|
+
listLabels(type: CustomerLabelType, opts?: IReadOptions): Promise<IApiResponse<ICustomerLabelListResult>>;
|
|
752
755
|
removeLabel(labelId: string): Promise<IApiResponse<undefined>>;
|
|
753
756
|
}
|
|
754
757
|
|
|
@@ -768,12 +771,12 @@ declare class WebhooksClient {
|
|
|
768
771
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
769
772
|
setAccessToken(token: string | undefined): void;
|
|
770
773
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
771
|
-
listEndpoints(): Promise<IApiResponse<IWebhookEndpointListResult>>;
|
|
774
|
+
listEndpoints(opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointListResult>>;
|
|
772
775
|
createEndpoint(input: ICreateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointCreatedDTO>>;
|
|
773
|
-
getEndpoint(endpointId: string): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
776
|
+
getEndpoint(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
774
777
|
updateEndpoint(endpointId: string, input: IUpdateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
775
778
|
deleteEndpoint(endpointId: string): Promise<undefined>;
|
|
776
|
-
listDeliveries(endpointId: string): Promise<IApiResponse<IWebhookDeliveryListResult>>;
|
|
779
|
+
listDeliveries(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookDeliveryListResult>>;
|
|
777
780
|
testEndpoint(endpointId: string): Promise<IApiResponse<ITestWebhookResult>>;
|
|
778
781
|
}
|
|
779
782
|
|
|
@@ -841,29 +844,29 @@ declare class WorkspacesClient {
|
|
|
841
844
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
842
845
|
setAccessToken(token: string | undefined): void;
|
|
843
846
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
844
|
-
listWorkspaces(): Promise<IApiResponse<IWorkspaceListResult>>;
|
|
847
|
+
listWorkspaces(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceListResult>>;
|
|
845
848
|
createWorkspace(input: ICreateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
|
|
846
|
-
getWorkspace(id: string): Promise<IApiResponse<IWorkspaceResult>>;
|
|
849
|
+
getWorkspace(id: string, opts?: IReadOptions): Promise<IApiResponse<IWorkspaceResult>>;
|
|
847
850
|
updateWorkspace(input: IUpdateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
|
|
848
851
|
archiveWorkspace(): Promise<IApiResponse<undefined>>;
|
|
849
852
|
restoreWorkspace(): Promise<IApiResponse<undefined>>;
|
|
850
|
-
listRoles(): Promise<IApiResponse<IRoleListResult>>;
|
|
853
|
+
listRoles(opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
|
|
851
854
|
createRole(input: ICreateRoleInput): Promise<IApiResponse<IRoleResult>>;
|
|
852
|
-
getRole(roleId: string): Promise<IApiResponse<IRoleResult>>;
|
|
855
|
+
getRole(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleResult>>;
|
|
853
856
|
updateRole(roleId: string, input: IUpdateRoleInput): Promise<IApiResponse<IRoleResult>>;
|
|
854
857
|
removeRole(roleId: string): Promise<IApiResponse<undefined>>;
|
|
855
|
-
getRolePermissions(roleId: string): Promise<IApiResponse<IRolePermissionsResult>>;
|
|
858
|
+
getRolePermissions(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRolePermissionsResult>>;
|
|
856
859
|
setRolePermissions(roleId: string, permissions: IRolePermissionInput[]): Promise<IApiResponse<undefined>>;
|
|
857
|
-
listMembers(): Promise<IApiResponse<IMemberListResult>>;
|
|
860
|
+
listMembers(opts?: IReadOptions): Promise<IApiResponse<IMemberListResult>>;
|
|
858
861
|
removeMember(userId: string): Promise<IApiResponse<undefined>>;
|
|
859
|
-
getMemberRoles(userId: string): Promise<IApiResponse<IRoleListResult>>;
|
|
862
|
+
getMemberRoles(userId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
|
|
860
863
|
addMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
|
|
861
864
|
removeMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
|
|
862
|
-
listInvitations(): Promise<IApiResponse<IInvitationListResult>>;
|
|
865
|
+
listInvitations(opts?: IReadOptions): Promise<IApiResponse<IInvitationListResult>>;
|
|
863
866
|
invite(entries: IInviteEntry | IInviteEntry[]): Promise<IApiResponse<IInviteResult>>;
|
|
864
867
|
cancelInvitation(inviteId: string): Promise<IApiResponse<undefined>>;
|
|
865
868
|
acceptInvitation(pin: string): Promise<IApiResponse<IAcceptInvitationResult>>;
|
|
866
|
-
getSettings(): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
869
|
+
getSettings(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
867
870
|
updateSettings(input: IUpdateSettingsInput): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
868
871
|
}
|
|
869
872
|
|
|
@@ -983,4 +986,4 @@ declare class CourierAdminClient {
|
|
|
983
986
|
rollback(type: string, input: IRollbackTemplateInput, locale?: string | null): Promise<IApiResponse<ITemplateEntry>>;
|
|
984
987
|
}
|
|
985
988
|
|
|
986
|
-
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;
|
|
@@ -546,7 +549,7 @@ declare class AuditClient {
|
|
|
546
549
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
547
550
|
setAccessToken(token: string | undefined): void;
|
|
548
551
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
549
|
-
listEvents(input?: IListAuditEventsInput): Promise<IApiResponse<IAuditPageResult>>;
|
|
552
|
+
listEvents(input?: IListAuditEventsInput, opts?: IReadOptions): Promise<IApiResponse<IAuditPageResult>>;
|
|
550
553
|
}
|
|
551
554
|
|
|
552
555
|
interface IRegisterInput {
|
|
@@ -606,7 +609,7 @@ declare class AuthClient {
|
|
|
606
609
|
verifyEmail(token: string): Promise<IApiResponse<IVerifyEmailResult>>;
|
|
607
610
|
logout(refreshToken?: string): Promise<IApiResponse<undefined>>;
|
|
608
611
|
sendVerificationEmail(): Promise<IApiResponse<IResendVerificationResult>>;
|
|
609
|
-
getUser(): Promise<IApiResponse<IMeResult>>;
|
|
612
|
+
getUser(opts?: IReadOptions): Promise<IApiResponse<IMeResult>>;
|
|
610
613
|
updateProfile(input: IUpdateProfileInput): Promise<IApiResponse<IMeResult>>;
|
|
611
614
|
updatePreferences(input: IUpdatePreferencesInput): Promise<IApiResponse<IMeResult>>;
|
|
612
615
|
updateEmail(email: string): Promise<IApiResponse<unknown>>;
|
|
@@ -645,16 +648,16 @@ declare class BillingClient {
|
|
|
645
648
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
646
649
|
setAccessToken(token: string | undefined): void;
|
|
647
650
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
648
|
-
listPlans(): Promise<IApiResponse<IPlanListResult>>;
|
|
649
|
-
getPlan(planId: string): Promise<IApiResponse<IPlanResult>>;
|
|
651
|
+
listPlans(opts?: IReadOptions): Promise<IApiResponse<IPlanListResult>>;
|
|
652
|
+
getPlan(planId: string, opts?: IReadOptions): Promise<IApiResponse<IPlanResult>>;
|
|
650
653
|
createPlan(input: ICreatePlanInput): Promise<IApiResponse<IPlanResult>>;
|
|
651
654
|
updatePlan(planId: string, input: IUpdatePlanInput): Promise<IApiResponse<IPlanResult>>;
|
|
652
655
|
deletePlan(planId: string): Promise<IApiResponse<undefined>>;
|
|
653
|
-
getSubscription(): Promise<IApiResponse<ISubscriptionResult>>;
|
|
656
|
+
getSubscription(opts?: IReadOptions): Promise<IApiResponse<ISubscriptionResult>>;
|
|
654
657
|
createCheckoutSession(input: ICheckoutInput): Promise<IApiResponse<ICheckoutUrlResult>>;
|
|
655
658
|
createPortalSession(): Promise<IApiResponse<IPortalUrlResult>>;
|
|
656
659
|
recordUsage(input: IRecordUsageInput): Promise<IApiResponse<undefined>>;
|
|
657
|
-
getUsage(metric: string): Promise<IApiResponse<IUsageResult>>;
|
|
660
|
+
getUsage(metric: string, opts?: IReadOptions): Promise<IApiResponse<IUsageResult>>;
|
|
658
661
|
}
|
|
659
662
|
|
|
660
663
|
interface IListCustomersInput {
|
|
@@ -715,40 +718,40 @@ declare class CustomersClient {
|
|
|
715
718
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
716
719
|
setAccessToken(token: string | undefined): void;
|
|
717
720
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
718
|
-
listCustomers(input?: IListCustomersInput): Promise<IApiResponse<ICustomerListResult>>;
|
|
721
|
+
listCustomers(input?: IListCustomersInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerListResult>>;
|
|
719
722
|
createCustomer(input?: ICreateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
|
|
720
|
-
getCustomer(customerId: string, input?: IGetCustomerInput): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
|
|
723
|
+
getCustomer(customerId: string, input?: IGetCustomerInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
|
|
721
724
|
updateCustomer(customerId: string, input: IUpdateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
|
|
722
725
|
deleteCustomer(customerId: string): Promise<IApiResponse<undefined>>;
|
|
723
726
|
blacklistCustomer(customerId: string, input?: IBlacklistCustomerInput): Promise<IApiResponse<undefined>>;
|
|
724
727
|
unblacklistCustomer(customerId: string): Promise<IApiResponse<undefined>>;
|
|
725
|
-
listEmails(customerId: string): Promise<IApiResponse<ICustomerEmailListResult>>;
|
|
728
|
+
listEmails(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerEmailListResult>>;
|
|
726
729
|
addEmail(customerId: string, input: IAddEmailInput): Promise<IApiResponse<ICustomerEmailResult>>;
|
|
727
730
|
updateEmailLabel(customerId: string, emailId: string, label: string): Promise<IApiResponse<ICustomerEmailResult>>;
|
|
728
731
|
setPrimaryEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
|
|
729
732
|
removeEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
|
|
730
|
-
listPhones(customerId: string): Promise<IApiResponse<ICustomerPhoneListResult>>;
|
|
733
|
+
listPhones(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerPhoneListResult>>;
|
|
731
734
|
addPhone(customerId: string, input: IAddPhoneInput): Promise<IApiResponse<ICustomerPhoneResult>>;
|
|
732
735
|
updatePhoneLabel(customerId: string, phoneId: string, label: string): Promise<IApiResponse<ICustomerPhoneResult>>;
|
|
733
736
|
setPrimaryPhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
|
|
734
737
|
removePhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
|
|
735
|
-
listAddresses(customerId: string): Promise<IApiResponse<ICustomerAddressListResult>>;
|
|
738
|
+
listAddresses(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerAddressListResult>>;
|
|
736
739
|
addAddress(customerId: string, input: IAddAddressInput): Promise<IApiResponse<ICustomerAddressResult>>;
|
|
737
740
|
updateAddressLabel(customerId: string, addrId: string, label: string): Promise<IApiResponse<ICustomerAddressResult>>;
|
|
738
741
|
setPrimaryAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
|
|
739
742
|
removeAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
|
|
740
|
-
listNotes(customerId: string): Promise<IApiResponse<ICustomerNoteListResult>>;
|
|
743
|
+
listNotes(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerNoteListResult>>;
|
|
741
744
|
createNote(customerId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
|
|
742
745
|
updateNote(customerId: string, noteId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
|
|
743
746
|
deleteNote(customerId: string, noteId: string): Promise<IApiResponse<undefined>>;
|
|
744
|
-
listTags(customerId: string): Promise<IApiResponse<ICustomerTagListResult>>;
|
|
747
|
+
listTags(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerTagListResult>>;
|
|
745
748
|
addTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
|
|
746
749
|
removeTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
|
|
747
|
-
listRelationships(customerId: string): Promise<IApiResponse<ICustomerRelationshipListResult>>;
|
|
750
|
+
listRelationships(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerRelationshipListResult>>;
|
|
748
751
|
addRelationship(customerId: string, input: IAddRelationshipInput): Promise<IApiResponse<ICustomerRelationshipResult>>;
|
|
749
752
|
setPrimaryRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
|
|
750
753
|
removeRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
|
|
751
|
-
listLabels(type: CustomerLabelType): Promise<IApiResponse<ICustomerLabelListResult>>;
|
|
754
|
+
listLabels(type: CustomerLabelType, opts?: IReadOptions): Promise<IApiResponse<ICustomerLabelListResult>>;
|
|
752
755
|
removeLabel(labelId: string): Promise<IApiResponse<undefined>>;
|
|
753
756
|
}
|
|
754
757
|
|
|
@@ -768,12 +771,12 @@ declare class WebhooksClient {
|
|
|
768
771
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
769
772
|
setAccessToken(token: string | undefined): void;
|
|
770
773
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
771
|
-
listEndpoints(): Promise<IApiResponse<IWebhookEndpointListResult>>;
|
|
774
|
+
listEndpoints(opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointListResult>>;
|
|
772
775
|
createEndpoint(input: ICreateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointCreatedDTO>>;
|
|
773
|
-
getEndpoint(endpointId: string): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
776
|
+
getEndpoint(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
774
777
|
updateEndpoint(endpointId: string, input: IUpdateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
775
778
|
deleteEndpoint(endpointId: string): Promise<undefined>;
|
|
776
|
-
listDeliveries(endpointId: string): Promise<IApiResponse<IWebhookDeliveryListResult>>;
|
|
779
|
+
listDeliveries(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookDeliveryListResult>>;
|
|
777
780
|
testEndpoint(endpointId: string): Promise<IApiResponse<ITestWebhookResult>>;
|
|
778
781
|
}
|
|
779
782
|
|
|
@@ -841,29 +844,29 @@ declare class WorkspacesClient {
|
|
|
841
844
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
842
845
|
setAccessToken(token: string | undefined): void;
|
|
843
846
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
844
|
-
listWorkspaces(): Promise<IApiResponse<IWorkspaceListResult>>;
|
|
847
|
+
listWorkspaces(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceListResult>>;
|
|
845
848
|
createWorkspace(input: ICreateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
|
|
846
|
-
getWorkspace(id: string): Promise<IApiResponse<IWorkspaceResult>>;
|
|
849
|
+
getWorkspace(id: string, opts?: IReadOptions): Promise<IApiResponse<IWorkspaceResult>>;
|
|
847
850
|
updateWorkspace(input: IUpdateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
|
|
848
851
|
archiveWorkspace(): Promise<IApiResponse<undefined>>;
|
|
849
852
|
restoreWorkspace(): Promise<IApiResponse<undefined>>;
|
|
850
|
-
listRoles(): Promise<IApiResponse<IRoleListResult>>;
|
|
853
|
+
listRoles(opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
|
|
851
854
|
createRole(input: ICreateRoleInput): Promise<IApiResponse<IRoleResult>>;
|
|
852
|
-
getRole(roleId: string): Promise<IApiResponse<IRoleResult>>;
|
|
855
|
+
getRole(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleResult>>;
|
|
853
856
|
updateRole(roleId: string, input: IUpdateRoleInput): Promise<IApiResponse<IRoleResult>>;
|
|
854
857
|
removeRole(roleId: string): Promise<IApiResponse<undefined>>;
|
|
855
|
-
getRolePermissions(roleId: string): Promise<IApiResponse<IRolePermissionsResult>>;
|
|
858
|
+
getRolePermissions(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRolePermissionsResult>>;
|
|
856
859
|
setRolePermissions(roleId: string, permissions: IRolePermissionInput[]): Promise<IApiResponse<undefined>>;
|
|
857
|
-
listMembers(): Promise<IApiResponse<IMemberListResult>>;
|
|
860
|
+
listMembers(opts?: IReadOptions): Promise<IApiResponse<IMemberListResult>>;
|
|
858
861
|
removeMember(userId: string): Promise<IApiResponse<undefined>>;
|
|
859
|
-
getMemberRoles(userId: string): Promise<IApiResponse<IRoleListResult>>;
|
|
862
|
+
getMemberRoles(userId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
|
|
860
863
|
addMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
|
|
861
864
|
removeMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
|
|
862
|
-
listInvitations(): Promise<IApiResponse<IInvitationListResult>>;
|
|
865
|
+
listInvitations(opts?: IReadOptions): Promise<IApiResponse<IInvitationListResult>>;
|
|
863
866
|
invite(entries: IInviteEntry | IInviteEntry[]): Promise<IApiResponse<IInviteResult>>;
|
|
864
867
|
cancelInvitation(inviteId: string): Promise<IApiResponse<undefined>>;
|
|
865
868
|
acceptInvitation(pin: string): Promise<IApiResponse<IAcceptInvitationResult>>;
|
|
866
|
-
getSettings(): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
869
|
+
getSettings(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
867
870
|
updateSettings(input: IUpdateSettingsInput): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
868
871
|
}
|
|
869
872
|
|
|
@@ -983,4 +986,4 @@ declare class CourierAdminClient {
|
|
|
983
986
|
rollback(type: string, input: IRollbackTemplateInput, locale?: string | null): Promise<IApiResponse<ITemplateEntry>>;
|
|
984
987
|
}
|
|
985
988
|
|
|
986
|
-
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 };
|