@proveanything/smartlinks 1.1.14 → 1.1.16

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/API_SUMMARY.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.1.14 | Generated: 2026-01-03T20:08:46.358Z
3
+ Version: 1.1.16 | Generated: 2026-01-03T21:01:22.707Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -683,11 +683,12 @@ interface AppendBulkResult {
683
683
 
684
684
  ### contact
685
685
 
686
- **ContactResponse** (interface)
686
+ **Contact** (interface)
687
687
  ```typescript
688
- interface ContactResponse {
688
+ interface Contact {
689
689
  contactId: string
690
690
  orgId: string
691
+ userId: string | null
691
692
  firstName: string | null
692
693
  lastName: string | null
693
694
  displayName: string | null
@@ -696,6 +697,13 @@ interface ContactResponse {
696
697
  phone: string | null
697
698
  emails?: string[]
698
699
  phones?: string[]
700
+ tags?: string[]
701
+ source?: string | null
702
+ notes?: string | null
703
+ avatarUrl?: string | null
704
+ locale?: string | null
705
+ timezone?: string | null
706
+ externalIds?: Record<string, any>
699
707
  customFields: ContactCustomFields
700
708
  createdAt: string
701
709
  updatedAt: string
@@ -704,62 +712,15 @@ interface ContactResponse {
704
712
  }
705
713
  ```
706
714
 
707
- **ContactCreateRequest** (interface)
708
- ```typescript
709
- interface ContactCreateRequest {
710
- firstName?: string | null
711
- lastName?: string | null
712
- displayName?: string | null
713
- company?: string | null
714
- email?: string | null
715
- phone?: string | null
716
- customFields?: ContactCustomFields
717
- }
718
- ```
719
-
720
- **ContactUpdateRequest** (interface)
721
- ```typescript
722
- interface ContactUpdateRequest {
723
- firstName?: string | null
724
- lastName?: string | null
725
- displayName?: string | null
726
- company?: string | null
727
- email?: string | null
728
- phone?: string | null
729
- customFields?: ContactCustomFields
730
- }
731
- ```
732
-
733
715
  **ContactListResponse** (interface)
734
716
  ```typescript
735
717
  interface ContactListResponse {
736
- items: ContactResponse[]
718
+ items: Contact[]
737
719
  limit: number
738
720
  offset: number
739
721
  }
740
722
  ```
741
723
 
742
- **PublicContactUpsertRequest** (interface)
743
- ```typescript
744
- interface PublicContactUpsertRequest {
745
- email?: string
746
- phone?: string
747
- userId?: string
748
- firstName?: string
749
- lastName?: string
750
- displayName?: string
751
- company?: string
752
- tags?: string[]
753
- source?: string
754
- notes?: string
755
- avatarUrl?: string
756
- locale?: string
757
- timezone?: string
758
- externalIds?: Record<string, any>
759
- customFields?: ContactCustomFields
760
- }
761
- ```
762
-
763
724
  **PublicContactUpsertResponse** (interface)
764
725
  ```typescript
765
726
  interface PublicContactUpsertResponse {
@@ -768,8 +729,31 @@ interface PublicContactUpsertResponse {
768
729
  }
769
730
  ```
770
731
 
732
+ **UserSearchResponse** (interface)
733
+ ```typescript
734
+ interface UserSearchResponse {
735
+ user: {
736
+ uid: string,
737
+ displayName: string | null,
738
+ email: string | null,
739
+ phoneNumber: string | null,
740
+ photoURL: string | null
741
+ },
742
+ contact: ContactResponse | null
743
+ existsAsContact: boolean
744
+ }
745
+ ```
746
+
771
747
  **ContactCustomFields** = `Record<string, any>`
772
748
 
749
+ **ContactResponse** = `Contact`
750
+
751
+ **ContactCreateRequest** = `Omit<`
752
+
753
+ **ContactUpdateRequest** = `Partial<ContactCreateRequest>`
754
+
755
+ **PublicContactUpsertRequest** = `Partial<`
756
+
773
757
  ### error
774
758
 
775
759
  **ErrorResponse** (interface)
@@ -1963,7 +1947,7 @@ Logging: Append many communication events for a list of IDs. POST /admin/collect
1963
1947
  **erase**(collectionId: string, contactId: string, body?: any) → `Promise<ContactResponse>`
1964
1948
 
1965
1949
  **getUser**(collectionId: string,
1966
- userId: string,) → `Promise<ContactResponse>`
1950
+ userId: string,) → `Promise<UserSearchResponse>`
1967
1951
 
1968
1952
  ### crate
1969
1953
 
@@ -1,4 +1,4 @@
1
- import { ContactResponse, ContactCreateRequest, ContactUpdateRequest, ContactListResponse, PublicContactUpsertRequest, PublicContactUpsertResponse } from "../types";
1
+ import { ContactResponse, ContactCreateRequest, ContactUpdateRequest, ContactListResponse, PublicContactUpsertRequest, PublicContactUpsertResponse, UserSearchResponse } from "../types";
2
2
  export declare namespace contact {
3
3
  function create(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
4
4
  function list(collectionId: string, params?: {
@@ -18,5 +18,5 @@ export declare namespace contact {
18
18
  function upsert(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
19
19
  function publicUpsert(collectionId: string, data: PublicContactUpsertRequest): Promise<PublicContactUpsertResponse>;
20
20
  function erase(collectionId: string, contactId: string, body?: any): Promise<ContactResponse>;
21
- function getUser(collectionId: string, userId: string): Promise<ContactResponse>;
21
+ function getUser(collectionId: string, userId: string): Promise<UserSearchResponse>;
22
22
  }
@@ -1,7 +1,8 @@
1
1
  export type ContactCustomFields = Record<string, any>;
2
- export interface ContactResponse {
2
+ export interface Contact {
3
3
  contactId: string;
4
4
  orgId: string;
5
+ userId: string | null;
5
6
  firstName: string | null;
6
7
  lastName: string | null;
7
8
  displayName: string | null;
@@ -10,53 +11,42 @@ export interface ContactResponse {
10
11
  phone: string | null;
11
12
  emails?: string[];
12
13
  phones?: string[];
14
+ tags?: string[];
15
+ source?: string | null;
16
+ notes?: string | null;
17
+ avatarUrl?: string | null;
18
+ locale?: string | null;
19
+ timezone?: string | null;
20
+ externalIds?: Record<string, any>;
13
21
  customFields: ContactCustomFields;
14
22
  createdAt: string;
15
23
  updatedAt: string;
16
24
  deletedAt: string | null;
17
25
  erasedAt: string | null;
18
26
  }
19
- export interface ContactCreateRequest {
20
- firstName?: string | null;
21
- lastName?: string | null;
22
- displayName?: string | null;
23
- company?: string | null;
24
- email?: string | null;
25
- phone?: string | null;
26
- customFields?: ContactCustomFields;
27
- }
28
- export interface ContactUpdateRequest {
29
- firstName?: string | null;
30
- lastName?: string | null;
31
- displayName?: string | null;
32
- company?: string | null;
33
- email?: string | null;
34
- phone?: string | null;
35
- customFields?: ContactCustomFields;
36
- }
27
+ export type ContactResponse = Contact;
28
+ export type ContactCreateRequest = Omit<Contact, "contactId" | "orgId" | "createdAt" | "updatedAt" | "deletedAt" | "erasedAt">;
29
+ export type ContactUpdateRequest = Partial<ContactCreateRequest>;
37
30
  export interface ContactListResponse {
38
- items: ContactResponse[];
31
+ items: Contact[];
39
32
  limit: number;
40
33
  offset: number;
41
34
  }
42
- export interface PublicContactUpsertRequest {
43
- email?: string;
44
- phone?: string;
45
- userId?: string;
46
- firstName?: string;
47
- lastName?: string;
48
- displayName?: string;
49
- company?: string;
50
- tags?: string[];
51
- source?: string;
52
- notes?: string;
53
- avatarUrl?: string;
54
- locale?: string;
55
- timezone?: string;
56
- externalIds?: Record<string, any>;
35
+ export type PublicContactUpsertRequest = Partial<Pick<Contact, "email" | "phone" | "userId" | "firstName" | "lastName" | "displayName" | "company" | "tags" | "source" | "notes" | "avatarUrl" | "locale" | "timezone" | "externalIds">> & {
57
36
  customFields?: ContactCustomFields;
58
- }
37
+ };
59
38
  export interface PublicContactUpsertResponse {
60
39
  ok: boolean;
61
40
  contactId: string;
62
41
  }
42
+ export interface UserSearchResponse {
43
+ user: {
44
+ uid: string;
45
+ displayName: string | null;
46
+ email: string | null;
47
+ phoneNumber: string | null;
48
+ photoURL: string | null;
49
+ };
50
+ contact: ContactResponse | null;
51
+ existsAsContact: boolean;
52
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proveanything/smartlinks",
3
- "version": "1.1.14",
3
+ "version": "1.1.16",
4
4
  "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",