@fonderie/client 0.9.0 → 0.11.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 +69 -52
- package/dist/index.cjs +110 -65
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +74 -51
- package/dist/index.d.ts +74 -51
- package/dist/index.js +110 -65
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -26,6 +26,7 @@ interface IRequestOptions {
|
|
|
26
26
|
token?: string | undefined;
|
|
27
27
|
cookie?: string | undefined;
|
|
28
28
|
workspaceId?: string | undefined;
|
|
29
|
+
headers?: Record<string, string> | undefined;
|
|
29
30
|
cache?: number | false | undefined;
|
|
30
31
|
bust?: boolean | undefined;
|
|
31
32
|
invalidate?: string[] | undefined;
|
|
@@ -53,6 +54,9 @@ declare class TokenStore {
|
|
|
53
54
|
set(token: string | undefined): void;
|
|
54
55
|
}
|
|
55
56
|
|
|
57
|
+
interface IReadOptions {
|
|
58
|
+
bust?: boolean | undefined;
|
|
59
|
+
}
|
|
56
60
|
interface IApiResponse<T = undefined> {
|
|
57
61
|
reason: string;
|
|
58
62
|
explanation: string;
|
|
@@ -76,10 +80,6 @@ interface IUserPreferences {
|
|
|
76
80
|
dateFormat: string;
|
|
77
81
|
timeFormat: string;
|
|
78
82
|
}
|
|
79
|
-
interface IUserSkill {
|
|
80
|
-
name: string;
|
|
81
|
-
level: string;
|
|
82
|
-
}
|
|
83
83
|
interface IUserDTO {
|
|
84
84
|
id: string;
|
|
85
85
|
email: string;
|
|
@@ -89,9 +89,9 @@ interface IUserDTO {
|
|
|
89
89
|
profileImageUrl: string;
|
|
90
90
|
isActive: boolean;
|
|
91
91
|
lastLogin: string;
|
|
92
|
-
skills: IUserSkill[];
|
|
93
92
|
preferences: IUserPreferences;
|
|
94
93
|
isEmailVerified: boolean;
|
|
94
|
+
isPhoneVerified: boolean;
|
|
95
95
|
mfaEnabled: boolean;
|
|
96
96
|
suspended: boolean;
|
|
97
97
|
whitelist: boolean;
|
|
@@ -106,10 +106,12 @@ interface ITokens {
|
|
|
106
106
|
interface IRegisterResult {
|
|
107
107
|
tokens: ITokens;
|
|
108
108
|
user: IUserDTO;
|
|
109
|
+
requiresVerification?: boolean;
|
|
109
110
|
}
|
|
110
111
|
interface ILoginResult {
|
|
111
112
|
tokens: ITokens;
|
|
112
113
|
user: IUserDTO;
|
|
114
|
+
requiresVerification?: boolean;
|
|
113
115
|
}
|
|
114
116
|
interface IMfaRequiredResult {
|
|
115
117
|
mfaToken: string;
|
|
@@ -123,13 +125,8 @@ interface IVerifyEmailResult {
|
|
|
123
125
|
email: string;
|
|
124
126
|
}
|
|
125
127
|
interface IResendVerificationResult {
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
data: {
|
|
129
|
-
token: string;
|
|
130
|
-
expiresAt: string;
|
|
131
|
-
email: string;
|
|
132
|
-
};
|
|
128
|
+
email?: string;
|
|
129
|
+
verified?: boolean;
|
|
133
130
|
}
|
|
134
131
|
interface IMeResult {
|
|
135
132
|
user: IUserDTO;
|
|
@@ -139,8 +136,7 @@ interface IMfaSetupResult {
|
|
|
139
136
|
backupCodes: string[];
|
|
140
137
|
}
|
|
141
138
|
interface IMfaEnabledResult {
|
|
142
|
-
|
|
143
|
-
user: IUserDTO;
|
|
139
|
+
mfaEnabled: boolean;
|
|
144
140
|
}
|
|
145
141
|
interface IPlanFeature {
|
|
146
142
|
name: string;
|
|
@@ -161,6 +157,9 @@ interface IPlanDTO {
|
|
|
161
157
|
yearly: number;
|
|
162
158
|
currency: string;
|
|
163
159
|
};
|
|
160
|
+
/** True when pricing came from a stale cache — a provider outage or a
|
|
161
|
+
* transfer window. Show prices as indicative when set. */
|
|
162
|
+
pricingStale?: boolean;
|
|
164
163
|
features: IPlanFeature[];
|
|
165
164
|
metadata: Record<string, unknown>;
|
|
166
165
|
}
|
|
@@ -221,6 +220,7 @@ interface IWorkspaceDTO {
|
|
|
221
220
|
isPersonal: boolean;
|
|
222
221
|
isArchived: boolean;
|
|
223
222
|
archivedAt: string;
|
|
223
|
+
archivedBy: string;
|
|
224
224
|
createdAt: string;
|
|
225
225
|
updatedAt: string;
|
|
226
226
|
}
|
|
@@ -239,6 +239,11 @@ interface IMemberDTO {
|
|
|
239
239
|
roleName: string;
|
|
240
240
|
confirmed: boolean;
|
|
241
241
|
createdAt: string;
|
|
242
|
+
/** Identity, so a member list can be rendered without a second request. */
|
|
243
|
+
email: string;
|
|
244
|
+
firstName: string;
|
|
245
|
+
lastName: string;
|
|
246
|
+
profileImageUrl: string;
|
|
242
247
|
}
|
|
243
248
|
interface IInvitationDTO {
|
|
244
249
|
id: string;
|
|
@@ -373,7 +378,10 @@ interface IWebhookDeliveryDTO {
|
|
|
373
378
|
eventType: string;
|
|
374
379
|
status: string;
|
|
375
380
|
attempts: number;
|
|
381
|
+
payload: Record<string, unknown>;
|
|
376
382
|
responseStatus: number | null;
|
|
383
|
+
responseBody: string | null;
|
|
384
|
+
nextAttemptAt: string | null;
|
|
377
385
|
deliveredAt: string | null;
|
|
378
386
|
createdAt: string;
|
|
379
387
|
}
|
|
@@ -415,6 +423,7 @@ interface ICustomerEmailDTO {
|
|
|
415
423
|
id: string;
|
|
416
424
|
email: string;
|
|
417
425
|
label: string;
|
|
426
|
+
labelId: string | null;
|
|
418
427
|
isPrimary: boolean;
|
|
419
428
|
createdAt: string;
|
|
420
429
|
}
|
|
@@ -422,6 +431,7 @@ interface ICustomerPhoneDTO {
|
|
|
422
431
|
id: string;
|
|
423
432
|
phone: string;
|
|
424
433
|
label: string;
|
|
434
|
+
labelId: string | null;
|
|
425
435
|
isPrimary: boolean;
|
|
426
436
|
createdAt: string;
|
|
427
437
|
}
|
|
@@ -437,6 +447,7 @@ interface IAddressDTO {
|
|
|
437
447
|
interface ICustomerAddressDTO {
|
|
438
448
|
id: string;
|
|
439
449
|
label: string;
|
|
450
|
+
labelId: string | null;
|
|
440
451
|
isPrimary: boolean;
|
|
441
452
|
address: IAddressDTO;
|
|
442
453
|
}
|
|
@@ -459,6 +470,7 @@ type ICustomerRelationshipExpandedDTO = Omit<ICustomerShallowDTO, 'id'> & {
|
|
|
459
470
|
customerId: string;
|
|
460
471
|
relationship: string;
|
|
461
472
|
isPrimary: boolean;
|
|
473
|
+
relationshipCreatedAt: string;
|
|
462
474
|
};
|
|
463
475
|
type ICustomerRelationshipExpandedD2DTO = ICustomerRelationshipExpandedDTO & {
|
|
464
476
|
relationships: ICustomerRelationshipExpandedDTO[];
|
|
@@ -546,7 +558,7 @@ declare class AuditClient {
|
|
|
546
558
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
547
559
|
setAccessToken(token: string | undefined): void;
|
|
548
560
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
549
|
-
listEvents(input?: IListAuditEventsInput): Promise<IApiResponse<IAuditPageResult>>;
|
|
561
|
+
listEvents(input?: IListAuditEventsInput, opts?: IReadOptions): Promise<IApiResponse<IAuditPageResult>>;
|
|
550
562
|
}
|
|
551
563
|
|
|
552
564
|
interface IRegisterInput {
|
|
@@ -564,17 +576,22 @@ interface IResetPasswordInput {
|
|
|
564
576
|
password: string;
|
|
565
577
|
}
|
|
566
578
|
interface IUpdateProfileInput {
|
|
567
|
-
firstName?: string;
|
|
568
|
-
lastName?: string;
|
|
569
|
-
avatarUrl?: string;
|
|
579
|
+
firstName?: string | null;
|
|
580
|
+
lastName?: string | null;
|
|
581
|
+
avatarUrl?: string | null;
|
|
570
582
|
}
|
|
571
583
|
interface IUpdatePreferencesInput {
|
|
572
584
|
locale?: string;
|
|
573
585
|
timezone?: string;
|
|
574
|
-
notifications?:
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
586
|
+
notifications?: {
|
|
587
|
+
email?: boolean;
|
|
588
|
+
inApp?: boolean;
|
|
589
|
+
sms?: boolean;
|
|
590
|
+
push?: boolean;
|
|
591
|
+
};
|
|
592
|
+
emailDigest?: string;
|
|
593
|
+
dateFormat?: string;
|
|
594
|
+
timeFormat?: string;
|
|
578
595
|
}
|
|
579
596
|
interface IChangePasswordInput {
|
|
580
597
|
currentPassword: string;
|
|
@@ -606,7 +623,7 @@ declare class AuthClient {
|
|
|
606
623
|
verifyEmail(token: string): Promise<IApiResponse<IVerifyEmailResult>>;
|
|
607
624
|
logout(refreshToken?: string): Promise<IApiResponse<undefined>>;
|
|
608
625
|
sendVerificationEmail(): Promise<IApiResponse<IResendVerificationResult>>;
|
|
609
|
-
getUser(): Promise<IApiResponse<IMeResult>>;
|
|
626
|
+
getUser(opts?: IReadOptions): Promise<IApiResponse<IMeResult>>;
|
|
610
627
|
updateProfile(input: IUpdateProfileInput): Promise<IApiResponse<IMeResult>>;
|
|
611
628
|
updatePreferences(input: IUpdatePreferencesInput): Promise<IApiResponse<IMeResult>>;
|
|
612
629
|
updateEmail(email: string): Promise<IApiResponse<unknown>>;
|
|
@@ -645,16 +662,16 @@ declare class BillingClient {
|
|
|
645
662
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
646
663
|
setAccessToken(token: string | undefined): void;
|
|
647
664
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
648
|
-
listPlans(): Promise<IApiResponse<IPlanListResult>>;
|
|
649
|
-
getPlan(planId: string): Promise<IApiResponse<IPlanResult>>;
|
|
665
|
+
listPlans(opts?: IReadOptions): Promise<IApiResponse<IPlanListResult>>;
|
|
666
|
+
getPlan(planId: string, opts?: IReadOptions): Promise<IApiResponse<IPlanResult>>;
|
|
650
667
|
createPlan(input: ICreatePlanInput): Promise<IApiResponse<IPlanResult>>;
|
|
651
668
|
updatePlan(planId: string, input: IUpdatePlanInput): Promise<IApiResponse<IPlanResult>>;
|
|
652
669
|
deletePlan(planId: string): Promise<IApiResponse<undefined>>;
|
|
653
|
-
getSubscription(): Promise<IApiResponse<ISubscriptionResult>>;
|
|
670
|
+
getSubscription(opts?: IReadOptions): Promise<IApiResponse<ISubscriptionResult>>;
|
|
654
671
|
createCheckoutSession(input: ICheckoutInput): Promise<IApiResponse<ICheckoutUrlResult>>;
|
|
655
672
|
createPortalSession(): Promise<IApiResponse<IPortalUrlResult>>;
|
|
656
673
|
recordUsage(input: IRecordUsageInput): Promise<IApiResponse<undefined>>;
|
|
657
|
-
getUsage(metric: string): Promise<IApiResponse<IUsageResult>>;
|
|
674
|
+
getUsage(metric: string, opts?: IReadOptions): Promise<IApiResponse<IUsageResult>>;
|
|
658
675
|
}
|
|
659
676
|
|
|
660
677
|
interface IListCustomersInput {
|
|
@@ -678,7 +695,7 @@ interface ICreateCustomerInput {
|
|
|
678
695
|
referralCode?: string | null;
|
|
679
696
|
referredByCode?: string | null;
|
|
680
697
|
}
|
|
681
|
-
type IUpdateCustomerInput = ICreateCustomerInput
|
|
698
|
+
type IUpdateCustomerInput = Omit<ICreateCustomerInput, 'referralCode' | 'referredByCode'>;
|
|
682
699
|
interface IBlacklistCustomerInput {
|
|
683
700
|
reason?: string;
|
|
684
701
|
}
|
|
@@ -705,7 +722,7 @@ interface IAddAddressInput {
|
|
|
705
722
|
}
|
|
706
723
|
interface IAddRelationshipInput {
|
|
707
724
|
relatedId: string;
|
|
708
|
-
relationship
|
|
725
|
+
relationship: string;
|
|
709
726
|
isPrimary?: boolean;
|
|
710
727
|
}
|
|
711
728
|
declare class CustomersClient {
|
|
@@ -715,40 +732,40 @@ declare class CustomersClient {
|
|
|
715
732
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
716
733
|
setAccessToken(token: string | undefined): void;
|
|
717
734
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
718
|
-
listCustomers(input?: IListCustomersInput): Promise<IApiResponse<ICustomerListResult>>;
|
|
735
|
+
listCustomers(input?: IListCustomersInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerListResult>>;
|
|
719
736
|
createCustomer(input?: ICreateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
|
|
720
|
-
getCustomer(customerId: string, input?: IGetCustomerInput): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
|
|
737
|
+
getCustomer(customerId: string, input?: IGetCustomerInput, opts?: IReadOptions): Promise<IApiResponse<ICustomerDetailDTO | ICustomerDetailD2DTO>>;
|
|
721
738
|
updateCustomer(customerId: string, input: IUpdateCustomerInput): Promise<IApiResponse<ICustomerResult>>;
|
|
722
739
|
deleteCustomer(customerId: string): Promise<IApiResponse<undefined>>;
|
|
723
740
|
blacklistCustomer(customerId: string, input?: IBlacklistCustomerInput): Promise<IApiResponse<undefined>>;
|
|
724
741
|
unblacklistCustomer(customerId: string): Promise<IApiResponse<undefined>>;
|
|
725
|
-
listEmails(customerId: string): Promise<IApiResponse<ICustomerEmailListResult>>;
|
|
742
|
+
listEmails(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerEmailListResult>>;
|
|
726
743
|
addEmail(customerId: string, input: IAddEmailInput): Promise<IApiResponse<ICustomerEmailResult>>;
|
|
727
744
|
updateEmailLabel(customerId: string, emailId: string, label: string): Promise<IApiResponse<ICustomerEmailResult>>;
|
|
728
745
|
setPrimaryEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
|
|
729
746
|
removeEmail(customerId: string, emailId: string): Promise<IApiResponse<undefined>>;
|
|
730
|
-
listPhones(customerId: string): Promise<IApiResponse<ICustomerPhoneListResult>>;
|
|
747
|
+
listPhones(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerPhoneListResult>>;
|
|
731
748
|
addPhone(customerId: string, input: IAddPhoneInput): Promise<IApiResponse<ICustomerPhoneResult>>;
|
|
732
749
|
updatePhoneLabel(customerId: string, phoneId: string, label: string): Promise<IApiResponse<ICustomerPhoneResult>>;
|
|
733
750
|
setPrimaryPhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
|
|
734
751
|
removePhone(customerId: string, phoneId: string): Promise<IApiResponse<undefined>>;
|
|
735
|
-
listAddresses(customerId: string): Promise<IApiResponse<ICustomerAddressListResult>>;
|
|
752
|
+
listAddresses(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerAddressListResult>>;
|
|
736
753
|
addAddress(customerId: string, input: IAddAddressInput): Promise<IApiResponse<ICustomerAddressResult>>;
|
|
737
754
|
updateAddressLabel(customerId: string, addrId: string, label: string): Promise<IApiResponse<ICustomerAddressResult>>;
|
|
738
755
|
setPrimaryAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
|
|
739
756
|
removeAddress(customerId: string, addrId: string): Promise<IApiResponse<undefined>>;
|
|
740
|
-
listNotes(customerId: string): Promise<IApiResponse<ICustomerNoteListResult>>;
|
|
757
|
+
listNotes(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerNoteListResult>>;
|
|
741
758
|
createNote(customerId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
|
|
742
759
|
updateNote(customerId: string, noteId: string, body: string): Promise<IApiResponse<ICustomerNoteResult>>;
|
|
743
760
|
deleteNote(customerId: string, noteId: string): Promise<IApiResponse<undefined>>;
|
|
744
|
-
listTags(customerId: string): Promise<IApiResponse<ICustomerTagListResult>>;
|
|
761
|
+
listTags(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerTagListResult>>;
|
|
745
762
|
addTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
|
|
746
763
|
removeTag(customerId: string, tag: string): Promise<IApiResponse<undefined>>;
|
|
747
|
-
listRelationships(customerId: string): Promise<IApiResponse<ICustomerRelationshipListResult>>;
|
|
764
|
+
listRelationships(customerId: string, opts?: IReadOptions): Promise<IApiResponse<ICustomerRelationshipListResult>>;
|
|
748
765
|
addRelationship(customerId: string, input: IAddRelationshipInput): Promise<IApiResponse<ICustomerRelationshipResult>>;
|
|
749
766
|
setPrimaryRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
|
|
750
767
|
removeRelationship(customerId: string, relatedId: string): Promise<IApiResponse<undefined>>;
|
|
751
|
-
listLabels(type: CustomerLabelType): Promise<IApiResponse<ICustomerLabelListResult>>;
|
|
768
|
+
listLabels(type: CustomerLabelType, opts?: IReadOptions): Promise<IApiResponse<ICustomerLabelListResult>>;
|
|
752
769
|
removeLabel(labelId: string): Promise<IApiResponse<undefined>>;
|
|
753
770
|
}
|
|
754
771
|
|
|
@@ -768,12 +785,12 @@ declare class WebhooksClient {
|
|
|
768
785
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
769
786
|
setAccessToken(token: string | undefined): void;
|
|
770
787
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
771
|
-
listEndpoints(): Promise<IApiResponse<IWebhookEndpointListResult>>;
|
|
788
|
+
listEndpoints(opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointListResult>>;
|
|
772
789
|
createEndpoint(input: ICreateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointCreatedDTO>>;
|
|
773
|
-
getEndpoint(endpointId: string): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
790
|
+
getEndpoint(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
774
791
|
updateEndpoint(endpointId: string, input: IUpdateWebhookEndpointInput): Promise<IApiResponse<IWebhookEndpointDTO>>;
|
|
775
792
|
deleteEndpoint(endpointId: string): Promise<undefined>;
|
|
776
|
-
listDeliveries(endpointId: string): Promise<IApiResponse<IWebhookDeliveryListResult>>;
|
|
793
|
+
listDeliveries(endpointId: string, opts?: IReadOptions): Promise<IApiResponse<IWebhookDeliveryListResult>>;
|
|
777
794
|
testEndpoint(endpointId: string): Promise<IApiResponse<ITestWebhookResult>>;
|
|
778
795
|
}
|
|
779
796
|
|
|
@@ -841,29 +858,29 @@ declare class WorkspacesClient {
|
|
|
841
858
|
constructor(http: HttpClient, tokens: TokenStore);
|
|
842
859
|
setAccessToken(token: string | undefined): void;
|
|
843
860
|
setWorkspaceId(workspaceId: string | undefined): void;
|
|
844
|
-
listWorkspaces(): Promise<IApiResponse<IWorkspaceListResult>>;
|
|
861
|
+
listWorkspaces(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceListResult>>;
|
|
845
862
|
createWorkspace(input: ICreateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
|
|
846
|
-
getWorkspace(id: string): Promise<IApiResponse<IWorkspaceResult>>;
|
|
863
|
+
getWorkspace(id: string, opts?: IReadOptions): Promise<IApiResponse<IWorkspaceResult>>;
|
|
847
864
|
updateWorkspace(input: IUpdateWorkspaceInput): Promise<IApiResponse<IWorkspaceResult>>;
|
|
848
865
|
archiveWorkspace(): Promise<IApiResponse<undefined>>;
|
|
849
866
|
restoreWorkspace(): Promise<IApiResponse<undefined>>;
|
|
850
|
-
listRoles(): Promise<IApiResponse<IRoleListResult>>;
|
|
867
|
+
listRoles(opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
|
|
851
868
|
createRole(input: ICreateRoleInput): Promise<IApiResponse<IRoleResult>>;
|
|
852
|
-
getRole(roleId: string): Promise<IApiResponse<IRoleResult>>;
|
|
869
|
+
getRole(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleResult>>;
|
|
853
870
|
updateRole(roleId: string, input: IUpdateRoleInput): Promise<IApiResponse<IRoleResult>>;
|
|
854
871
|
removeRole(roleId: string): Promise<IApiResponse<undefined>>;
|
|
855
|
-
getRolePermissions(roleId: string): Promise<IApiResponse<IRolePermissionsResult>>;
|
|
872
|
+
getRolePermissions(roleId: string, opts?: IReadOptions): Promise<IApiResponse<IRolePermissionsResult>>;
|
|
856
873
|
setRolePermissions(roleId: string, permissions: IRolePermissionInput[]): Promise<IApiResponse<undefined>>;
|
|
857
|
-
listMembers(): Promise<IApiResponse<IMemberListResult>>;
|
|
874
|
+
listMembers(opts?: IReadOptions): Promise<IApiResponse<IMemberListResult>>;
|
|
858
875
|
removeMember(userId: string): Promise<IApiResponse<undefined>>;
|
|
859
|
-
getMemberRoles(userId: string): Promise<IApiResponse<IRoleListResult>>;
|
|
876
|
+
getMemberRoles(userId: string, opts?: IReadOptions): Promise<IApiResponse<IRoleListResult>>;
|
|
860
877
|
addMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
|
|
861
878
|
removeMemberRole(userId: string, roleId: string): Promise<IApiResponse<undefined>>;
|
|
862
|
-
listInvitations(): Promise<IApiResponse<IInvitationListResult>>;
|
|
879
|
+
listInvitations(opts?: IReadOptions): Promise<IApiResponse<IInvitationListResult>>;
|
|
863
880
|
invite(entries: IInviteEntry | IInviteEntry[]): Promise<IApiResponse<IInviteResult>>;
|
|
864
881
|
cancelInvitation(inviteId: string): Promise<IApiResponse<undefined>>;
|
|
865
882
|
acceptInvitation(pin: string): Promise<IApiResponse<IAcceptInvitationResult>>;
|
|
866
|
-
getSettings(): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
883
|
+
getSettings(opts?: IReadOptions): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
867
884
|
updateSettings(input: IUpdateSettingsInput): Promise<IApiResponse<IWorkspaceSettingsResult>>;
|
|
868
885
|
}
|
|
869
886
|
|
|
@@ -924,11 +941,13 @@ declare class FonderieClient {
|
|
|
924
941
|
interface ISetConfigInput {
|
|
925
942
|
value: unknown;
|
|
926
943
|
description?: string;
|
|
944
|
+
active?: boolean;
|
|
927
945
|
ifVersion?: number;
|
|
928
946
|
}
|
|
929
947
|
interface ISetSecretInput {
|
|
930
948
|
value: string;
|
|
931
949
|
description?: string;
|
|
950
|
+
active?: boolean;
|
|
932
951
|
ifVersion?: number;
|
|
933
952
|
}
|
|
934
953
|
interface IRollbackInput {
|
|
@@ -937,10 +956,12 @@ interface IRollbackInput {
|
|
|
937
956
|
interface IConfigAdminClientOptions {
|
|
938
957
|
baseUrl: string;
|
|
939
958
|
adminToken: string;
|
|
959
|
+
actor?: string;
|
|
940
960
|
}
|
|
941
961
|
declare class ConfigAdminClient {
|
|
942
962
|
private http;
|
|
943
963
|
private adminToken;
|
|
964
|
+
private actorHeaders;
|
|
944
965
|
constructor(opts: IConfigAdminClientOptions);
|
|
945
966
|
listConfig(environment?: string): Promise<IApiResponse<IConfigEntry[]>>;
|
|
946
967
|
getConfig(key: string, environment?: string): Promise<IApiResponse<IConfigEntry>>;
|
|
@@ -970,10 +991,12 @@ interface IRollbackTemplateInput {
|
|
|
970
991
|
interface ICourierAdminClientOptions {
|
|
971
992
|
baseUrl: string;
|
|
972
993
|
adminToken: string;
|
|
994
|
+
actor?: string;
|
|
973
995
|
}
|
|
974
996
|
declare class CourierAdminClient {
|
|
975
997
|
private http;
|
|
976
998
|
private adminToken;
|
|
999
|
+
private actorHeaders;
|
|
977
1000
|
constructor(opts: ICourierAdminClientOptions);
|
|
978
1001
|
listTemplates(): Promise<IApiResponse<ITemplateEntry[]>>;
|
|
979
1002
|
getTemplate(type: string, locale?: string | null): Promise<IApiResponse<ITemplateEntry>>;
|
|
@@ -983,4 +1006,4 @@ declare class CourierAdminClient {
|
|
|
983
1006
|
rollback(type: string, input: IRollbackTemplateInput, locale?: string | null): Promise<IApiResponse<ITemplateEntry>>;
|
|
984
1007
|
}
|
|
985
1008
|
|
|
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
|
|
1009
|
+
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 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 };
|