@adspireai/adspire-node-sdk 1.0.341 → 1.0.342
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-public/types.gen.d.ts +139 -64
- package/package.json +1 -1
|
@@ -242,70 +242,6 @@ export declare const WorkspaceInvitationStatus: {
|
|
|
242
242
|
readonly PENDING: "pending";
|
|
243
243
|
readonly ACCEPTED: "accepted";
|
|
244
244
|
};
|
|
245
|
-
export type AiCreditUsageStoreRequest = {
|
|
246
|
-
/**
|
|
247
|
-
* Sqid of the brand
|
|
248
|
-
*/
|
|
249
|
-
brand_id: string;
|
|
250
|
-
/**
|
|
251
|
-
* Sqid of the user who used credits
|
|
252
|
-
*/
|
|
253
|
-
used_by_user_id?: string | null;
|
|
254
|
-
/**
|
|
255
|
-
* Type of AI usage
|
|
256
|
-
*/
|
|
257
|
-
usage_type: string;
|
|
258
|
-
/**
|
|
259
|
-
* Number of credits consumed
|
|
260
|
-
*/
|
|
261
|
-
credits_used: number;
|
|
262
|
-
/**
|
|
263
|
-
* Optional reference ID
|
|
264
|
-
*/
|
|
265
|
-
reference_id?: number | null;
|
|
266
|
-
/**
|
|
267
|
-
* Free-form metadata about the usage
|
|
268
|
-
*/
|
|
269
|
-
details?: {
|
|
270
|
-
[key: string]: unknown;
|
|
271
|
-
} | null;
|
|
272
|
-
/**
|
|
273
|
-
* When the credits were used
|
|
274
|
-
*/
|
|
275
|
-
used_at?: string | null;
|
|
276
|
-
};
|
|
277
|
-
export type AiCreditUsageUpdateRequest = {
|
|
278
|
-
/**
|
|
279
|
-
* Sqid of the brand
|
|
280
|
-
*/
|
|
281
|
-
brand_id: string;
|
|
282
|
-
/**
|
|
283
|
-
* Sqid of the user who used credits
|
|
284
|
-
*/
|
|
285
|
-
used_by_user_id?: string | null;
|
|
286
|
-
/**
|
|
287
|
-
* Type of AI usage
|
|
288
|
-
*/
|
|
289
|
-
usage_type?: string;
|
|
290
|
-
/**
|
|
291
|
-
* Number of credits consumed
|
|
292
|
-
*/
|
|
293
|
-
credits_used?: number;
|
|
294
|
-
/**
|
|
295
|
-
* Optional reference ID
|
|
296
|
-
*/
|
|
297
|
-
reference_id?: number | null;
|
|
298
|
-
/**
|
|
299
|
-
* Free-form metadata about the usage
|
|
300
|
-
*/
|
|
301
|
-
details?: {
|
|
302
|
-
[key: string]: unknown;
|
|
303
|
-
} | null;
|
|
304
|
-
/**
|
|
305
|
-
* When the credits were used
|
|
306
|
-
*/
|
|
307
|
-
used_at?: string | null;
|
|
308
|
-
};
|
|
309
245
|
export type ApprovalRequestRespondRequest = {
|
|
310
246
|
status: ApprovalRequestStatus;
|
|
311
247
|
feedback?: string | null;
|
|
@@ -994,6 +930,129 @@ export type ApprovalRequests = {
|
|
|
994
930
|
*/
|
|
995
931
|
approval_url?: string | null;
|
|
996
932
|
};
|
|
933
|
+
export type BackofficeApproval = {
|
|
934
|
+
id?: string;
|
|
935
|
+
status?: ApprovalRequestStatus;
|
|
936
|
+
/**
|
|
937
|
+
* Pending and past its due date
|
|
938
|
+
*/
|
|
939
|
+
is_overdue?: boolean;
|
|
940
|
+
workspace?: {
|
|
941
|
+
id?: string;
|
|
942
|
+
name?: string;
|
|
943
|
+
} | null;
|
|
944
|
+
campaign?: string | null;
|
|
945
|
+
preview?: string | null;
|
|
946
|
+
requester?: {
|
|
947
|
+
name?: string;
|
|
948
|
+
email?: string;
|
|
949
|
+
} | null;
|
|
950
|
+
approver?: {
|
|
951
|
+
name?: string | null;
|
|
952
|
+
email?: string | null;
|
|
953
|
+
is_external?: boolean;
|
|
954
|
+
} | null;
|
|
955
|
+
due_date?: string | null;
|
|
956
|
+
sent_at?: string | null;
|
|
957
|
+
viewed_at?: string | null;
|
|
958
|
+
responded_at?: string | null;
|
|
959
|
+
created_at?: string;
|
|
960
|
+
};
|
|
961
|
+
export type BackofficePublishingIssue = {
|
|
962
|
+
id?: string;
|
|
963
|
+
title?: string | null;
|
|
964
|
+
status?: string;
|
|
965
|
+
issue?: 'error' | 'overdue';
|
|
966
|
+
post_date?: string | null;
|
|
967
|
+
channel?: string | null;
|
|
968
|
+
campaign?: string | null;
|
|
969
|
+
workspace?: {
|
|
970
|
+
id?: string;
|
|
971
|
+
name?: string;
|
|
972
|
+
} | null;
|
|
973
|
+
failed_events?: Array<{
|
|
974
|
+
id?: number;
|
|
975
|
+
attempts?: number;
|
|
976
|
+
will_retry?: boolean;
|
|
977
|
+
next_retry_at?: string | null;
|
|
978
|
+
error?: string | null;
|
|
979
|
+
updated_at?: string;
|
|
980
|
+
}>;
|
|
981
|
+
};
|
|
982
|
+
export type BackofficeUser = {
|
|
983
|
+
id?: string;
|
|
984
|
+
name?: string;
|
|
985
|
+
email?: string;
|
|
986
|
+
user_type?: string;
|
|
987
|
+
active?: boolean;
|
|
988
|
+
workspaces_count?: number;
|
|
989
|
+
last_login_at?: string | null;
|
|
990
|
+
created_at?: string;
|
|
991
|
+
};
|
|
992
|
+
export type BackofficeWorkspaceDetail = BackofficeWorkspace & {
|
|
993
|
+
plan?: {
|
|
994
|
+
name?: string;
|
|
995
|
+
is_cancelled?: boolean;
|
|
996
|
+
is_resumable?: boolean;
|
|
997
|
+
past_due?: boolean;
|
|
998
|
+
expires_within?: string | null;
|
|
999
|
+
};
|
|
1000
|
+
onboarding_completed_at?: string | null;
|
|
1001
|
+
members?: Array<{
|
|
1002
|
+
id?: string;
|
|
1003
|
+
name?: string;
|
|
1004
|
+
email?: string;
|
|
1005
|
+
role?: string | null;
|
|
1006
|
+
active?: boolean;
|
|
1007
|
+
is_owner?: boolean;
|
|
1008
|
+
last_login_at?: string | null;
|
|
1009
|
+
}>;
|
|
1010
|
+
brands?: Array<{
|
|
1011
|
+
id?: string;
|
|
1012
|
+
name?: string;
|
|
1013
|
+
website?: string | null;
|
|
1014
|
+
channels?: Array<{
|
|
1015
|
+
name?: string;
|
|
1016
|
+
type?: string;
|
|
1017
|
+
}>;
|
|
1018
|
+
}>;
|
|
1019
|
+
connector_installations?: Array<{
|
|
1020
|
+
id?: number;
|
|
1021
|
+
connector?: string | null;
|
|
1022
|
+
type?: string | null;
|
|
1023
|
+
status?: string;
|
|
1024
|
+
is_active?: boolean;
|
|
1025
|
+
last_webhook_sent_at?: string | null;
|
|
1026
|
+
last_webhook_received_at?: string | null;
|
|
1027
|
+
}>;
|
|
1028
|
+
brand_connector_installations?: Array<{
|
|
1029
|
+
id?: number;
|
|
1030
|
+
brand?: string | null;
|
|
1031
|
+
connector_type?: string;
|
|
1032
|
+
status?: string;
|
|
1033
|
+
installed_at?: string | null;
|
|
1034
|
+
}>;
|
|
1035
|
+
};
|
|
1036
|
+
export type BackofficeWorkspace = {
|
|
1037
|
+
id?: string;
|
|
1038
|
+
name?: string;
|
|
1039
|
+
owner?: {
|
|
1040
|
+
id?: string;
|
|
1041
|
+
name?: string;
|
|
1042
|
+
email?: string;
|
|
1043
|
+
} | null;
|
|
1044
|
+
users_count?: number;
|
|
1045
|
+
brands_count?: number;
|
|
1046
|
+
created_at?: string;
|
|
1047
|
+
/**
|
|
1048
|
+
* Latest login, brand, campaign, approval or token usage. Only on the list endpoint.
|
|
1049
|
+
*/
|
|
1050
|
+
last_activity_at?: string | null;
|
|
1051
|
+
/**
|
|
1052
|
+
* No activity in the last 30 days. Only on the list endpoint.
|
|
1053
|
+
*/
|
|
1054
|
+
dormant?: boolean | null;
|
|
1055
|
+
};
|
|
997
1056
|
export type BrandAsset = {
|
|
998
1057
|
id?: string;
|
|
999
1058
|
brand_id?: string;
|
|
@@ -1351,6 +1410,13 @@ export type Comments = {
|
|
|
1351
1410
|
* Parent comment ID for replies
|
|
1352
1411
|
*/
|
|
1353
1412
|
parent_id?: string | null;
|
|
1413
|
+
/**
|
|
1414
|
+
* Preview iteration the comment was left on (only for whiteboard preview post comments)
|
|
1415
|
+
*/
|
|
1416
|
+
preview?: {
|
|
1417
|
+
id?: string;
|
|
1418
|
+
version?: number;
|
|
1419
|
+
};
|
|
1354
1420
|
content: string;
|
|
1355
1421
|
/**
|
|
1356
1422
|
* Indicates if comment was edited
|
|
@@ -1636,6 +1702,15 @@ export type WorkspaceDetail = {
|
|
|
1636
1702
|
* When the onboarding wizard was completed or skipped for this workspace
|
|
1637
1703
|
*/
|
|
1638
1704
|
onboarding_completed_at?: string | null;
|
|
1705
|
+
/**
|
|
1706
|
+
* AI credit balance for the current billing period, which resets on the subscription renewal day
|
|
1707
|
+
*/
|
|
1708
|
+
ai_credits?: {
|
|
1709
|
+
quota?: number;
|
|
1710
|
+
used?: number;
|
|
1711
|
+
remaining?: number;
|
|
1712
|
+
period_start?: string;
|
|
1713
|
+
};
|
|
1639
1714
|
};
|
|
1640
1715
|
export type WorkspaceInvitation = {
|
|
1641
1716
|
/**
|