@23blocks/block-crm 3.1.6 → 3.2.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.
Files changed (52) hide show
  1. package/dist/index.esm.js +19 -11
  2. package/dist/src/lib/crm.block.d.ts +41 -0
  3. package/dist/src/lib/crm.block.d.ts.map +1 -1
  4. package/dist/src/lib/services/accounts.service.d.ts +44 -0
  5. package/dist/src/lib/services/accounts.service.d.ts.map +1 -1
  6. package/dist/src/lib/services/billing-reports.service.d.ts +14 -0
  7. package/dist/src/lib/services/billing-reports.service.d.ts.map +1 -1
  8. package/dist/src/lib/services/busy-blocks.service.d.ts +19 -1
  9. package/dist/src/lib/services/busy-blocks.service.d.ts.map +1 -1
  10. package/dist/src/lib/services/calendar-accounts.service.d.ts +46 -3
  11. package/dist/src/lib/services/calendar-accounts.service.d.ts.map +1 -1
  12. package/dist/src/lib/services/calendar-sync.service.d.ts +9 -0
  13. package/dist/src/lib/services/calendar-sync.service.d.ts.map +1 -1
  14. package/dist/src/lib/services/categories.service.d.ts +27 -0
  15. package/dist/src/lib/services/categories.service.d.ts.map +1 -1
  16. package/dist/src/lib/services/communications.service.d.ts +5 -0
  17. package/dist/src/lib/services/communications.service.d.ts.map +1 -1
  18. package/dist/src/lib/services/contact-events.service.d.ts +75 -0
  19. package/dist/src/lib/services/contact-events.service.d.ts.map +1 -1
  20. package/dist/src/lib/services/contacts.service.d.ts +44 -0
  21. package/dist/src/lib/services/contacts.service.d.ts.map +1 -1
  22. package/dist/src/lib/services/ics-tokens.service.d.ts +19 -1
  23. package/dist/src/lib/services/ics-tokens.service.d.ts.map +1 -1
  24. package/dist/src/lib/services/lead-follows.service.d.ts +32 -0
  25. package/dist/src/lib/services/lead-follows.service.d.ts.map +1 -1
  26. package/dist/src/lib/services/leads.service.d.ts +44 -0
  27. package/dist/src/lib/services/leads.service.d.ts.map +1 -1
  28. package/dist/src/lib/services/mail-templates.service.d.ts +45 -0
  29. package/dist/src/lib/services/mail-templates.service.d.ts.map +1 -1
  30. package/dist/src/lib/services/meeting-billings.service.d.ts +57 -0
  31. package/dist/src/lib/services/meeting-billings.service.d.ts.map +1 -1
  32. package/dist/src/lib/services/meeting-participants.service.d.ts +18 -0
  33. package/dist/src/lib/services/meeting-participants.service.d.ts.map +1 -1
  34. package/dist/src/lib/services/meetings.service.d.ts +44 -0
  35. package/dist/src/lib/services/meetings.service.d.ts.map +1 -1
  36. package/dist/src/lib/services/opportunities.service.d.ts +44 -0
  37. package/dist/src/lib/services/opportunities.service.d.ts.map +1 -1
  38. package/dist/src/lib/services/quotes.service.d.ts +44 -0
  39. package/dist/src/lib/services/quotes.service.d.ts.map +1 -1
  40. package/dist/src/lib/services/referrals.service.d.ts +27 -0
  41. package/dist/src/lib/services/referrals.service.d.ts.map +1 -1
  42. package/dist/src/lib/services/subscribers.service.d.ts +27 -0
  43. package/dist/src/lib/services/subscribers.service.d.ts.map +1 -1
  44. package/dist/src/lib/services/touches.service.d.ts +27 -0
  45. package/dist/src/lib/services/touches.service.d.ts.map +1 -1
  46. package/dist/src/lib/services/users.service.d.ts +32 -0
  47. package/dist/src/lib/services/users.service.d.ts.map +1 -1
  48. package/dist/src/lib/services/zoom-hosts.service.d.ts +41 -0
  49. package/dist/src/lib/services/zoom-hosts.service.d.ts.map +1 -1
  50. package/dist/src/lib/services/zoom-meetings.service.d.ts +33 -0
  51. package/dist/src/lib/services/zoom-meetings.service.d.ts.map +1 -1
  52. package/package.json +1 -1
@@ -1,9 +1,27 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { IcsToken, CreateIcsTokenRequest, ListIcsTokensParams } from '../types/ics-token.js';
3
3
  export interface IcsTokensService {
4
+ /**
5
+ * List ICS tokens for a specific user with optional filtering, pagination, and sorting.
6
+ * @param userUniqueId - The unique identifier of the user.
7
+ * @param params - Optional filtering (status, search), pagination, and sorting parameters.
8
+ * @returns Paginated result containing IcsToken objects and metadata.
9
+ */
4
10
  list(userUniqueId: string, params?: ListIcsTokensParams): Promise<PageResult<IcsToken>>;
11
+ /**
12
+ * Create a new ICS token for a user, enabling calendar feed access.
13
+ * @param userUniqueId - The unique identifier of the user.
14
+ * @param data - The ICS token creation payload with name, description, and optional expiration.
15
+ * @returns The newly created IcsToken object containing the generated token value.
16
+ */
5
17
  create(userUniqueId: string, data: CreateIcsTokenRequest): Promise<IcsToken>;
6
- delete(userUniqueId: string, id: string): Promise<void>;
18
+ /**
19
+ * Delete an ICS token for a user, revoking calendar feed access.
20
+ * @param userUniqueId - The unique identifier of the user.
21
+ * @param uniqueId - The unique identifier of the ICS token to delete.
22
+ * @returns Resolves when the ICS token has been deleted.
23
+ */
24
+ delete(userUniqueId: string, uniqueId: string): Promise<void>;
7
25
  }
8
26
  export declare function createIcsTokensService(transport: Transport, _config: {
9
27
  appId: string;
@@ -1 +1 @@
1
- {"version":3,"file":"ics-tokens.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/ics-tokens.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAG/B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxF,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7E,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzD;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,gBAAgB,CA8BzG"}
1
+ {"version":3,"file":"ics-tokens.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/ics-tokens.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAG/B,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAExF;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,gBAAgB,CA8BzG"}
@@ -1,10 +1,42 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { LeadFollow, CreateLeadFollowRequest, UpdateLeadFollowRequest, ListLeadFollowsParams } from '../types/lead-follow.js';
3
3
  export interface LeadFollowsService {
4
+ /**
5
+ * List follow-up actions for a specific lead with optional filtering, pagination, and sorting.
6
+ * @param leadUniqueId - The unique identifier of the parent lead.
7
+ * @param params - Optional filtering (status, followType, search), pagination, and sorting parameters.
8
+ * @returns Paginated result containing LeadFollow objects and metadata.
9
+ */
4
10
  list(leadUniqueId: string, params?: ListLeadFollowsParams): Promise<PageResult<LeadFollow>>;
11
+ /**
12
+ * Retrieve a single follow-up action for a lead.
13
+ * @param leadUniqueId - The unique identifier of the parent lead.
14
+ * @param followUniqueId - The unique identifier of the follow-up.
15
+ * @returns The matching LeadFollow object.
16
+ */
5
17
  get(leadUniqueId: string, followUniqueId: string): Promise<LeadFollow>;
18
+ /**
19
+ * Create a new follow-up action for a lead.
20
+ * @param leadUniqueId - The unique identifier of the parent lead.
21
+ * @param data - The follow-up creation payload with user, type, scheduling, and notes.
22
+ * @returns The newly created LeadFollow object.
23
+ */
6
24
  create(leadUniqueId: string, data: CreateLeadFollowRequest): Promise<LeadFollow>;
25
+ /**
26
+ * Update an existing follow-up action for a lead.
27
+ * @param leadUniqueId - The unique identifier of the parent lead.
28
+ * @param followUniqueId - The unique identifier of the follow-up to update.
29
+ * @param data - The fields to update on the follow-up.
30
+ * @returns The updated LeadFollow object.
31
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
32
+ */
7
33
  update(leadUniqueId: string, followUniqueId: string, data: UpdateLeadFollowRequest): Promise<LeadFollow>;
34
+ /**
35
+ * Delete a follow-up action from a lead.
36
+ * @param leadUniqueId - The unique identifier of the parent lead.
37
+ * @param followUniqueId - The unique identifier of the follow-up to delete.
38
+ * @returns Resolves when the follow-up has been deleted.
39
+ */
8
40
  delete(leadUniqueId: string, followUniqueId: string): Promise<void>;
9
41
  }
10
42
  export declare function createLeadFollowsService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"lead-follows.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/lead-follows.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,UAAU,EACV,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAGjC,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5F,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjF,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACzG,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE;AAED,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAoD7G"}
1
+ {"version":3,"file":"lead-follows.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/lead-follows.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,UAAU,EACV,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAGjC,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IAE5F;;;;;OAKG;IACH,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvE;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEjF;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEzG;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE;AAED,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAoD7G"}
@@ -1,13 +1,57 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { Lead, CreateLeadRequest, UpdateLeadRequest, ListLeadsParams } from '../types/lead.js';
3
3
  export interface LeadsService {
4
+ /**
5
+ * List leads with optional filtering, pagination, and sorting.
6
+ * @param params - Optional filtering (status, contactStatus, source, search), pagination, and sorting parameters.
7
+ * @returns Paginated result containing Lead objects and metadata.
8
+ */
4
9
  list(params?: ListLeadsParams): Promise<PageResult<Lead>>;
10
+ /**
11
+ * Retrieve a single lead by its unique identifier.
12
+ * @param uniqueId - The unique identifier of the lead.
13
+ * @returns The matching Lead object.
14
+ */
5
15
  get(uniqueId: string): Promise<Lead>;
16
+ /**
17
+ * Create a new lead.
18
+ * @param data - The lead creation payload with name, email, social profiles, and other fields.
19
+ * @returns The newly created Lead object.
20
+ */
6
21
  create(data: CreateLeadRequest): Promise<Lead>;
22
+ /**
23
+ * Update an existing lead.
24
+ * @param uniqueId - The unique identifier of the lead to update.
25
+ * @param data - The fields to update on the lead.
26
+ * @returns The updated Lead object.
27
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
28
+ */
7
29
  update(uniqueId: string, data: UpdateLeadRequest): Promise<Lead>;
30
+ /**
31
+ * Soft-delete a lead.
32
+ * @param uniqueId - The unique identifier of the lead to delete.
33
+ * @returns Resolves when the lead has been deleted.
34
+ */
8
35
  delete(uniqueId: string): Promise<void>;
36
+ /**
37
+ * Recover a previously soft-deleted lead.
38
+ * @param uniqueId - The unique identifier of the lead to recover.
39
+ * @returns The recovered Lead object.
40
+ */
9
41
  recover(uniqueId: string): Promise<Lead>;
42
+ /**
43
+ * Search leads by a query string with optional pagination.
44
+ * @param query - The search query string.
45
+ * @param params - Optional pagination parameters.
46
+ * @returns Paginated result containing matching Lead objects.
47
+ * @note Performs a server-side POST-based search.
48
+ */
10
49
  search(query: string, params?: ListLeadsParams): Promise<PageResult<Lead>>;
50
+ /**
51
+ * List soft-deleted leads with optional pagination.
52
+ * @param params - Optional pagination parameters.
53
+ * @returns Paginated result containing soft-deleted Lead objects.
54
+ */
11
55
  listDeleted(params?: ListLeadsParams): Promise<PageResult<Lead>>;
12
56
  }
13
57
  export declare function createLeadsService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"leads.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/leads.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAG1B,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,WAAW,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;CAClE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,YAAY,CAkGjG"}
1
+ {"version":3,"file":"leads.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/leads.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAG1B,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAE1D;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3E;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;CAClE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,YAAY,CAkGjG"}
@@ -1,13 +1,58 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { CrmMailTemplate, CreateCrmMailTemplateRequest, UpdateCrmMailTemplateRequest, ListCrmMailTemplatesParams, CreateMandrillTemplateRequest, UpdateMandrillTemplateRequest, MandrillTemplateStats } from '../types/mail-template.js';
3
3
  export interface CrmMailTemplatesService {
4
+ /**
5
+ * List mail templates with optional filtering and pagination.
6
+ * @param params - Optional filtering (status, search) and pagination parameters.
7
+ * @returns Paginated result containing CrmMailTemplate objects and metadata.
8
+ */
4
9
  list(params?: ListCrmMailTemplatesParams): Promise<PageResult<CrmMailTemplate>>;
10
+ /**
11
+ * Retrieve a single mail template by its unique identifier.
12
+ * @param uniqueId - The unique identifier of the mail template.
13
+ * @returns The matching CrmMailTemplate object.
14
+ */
5
15
  get(uniqueId: string): Promise<CrmMailTemplate>;
16
+ /**
17
+ * Create a new mail template.
18
+ * @param data - The template creation payload with code, name, subject, sender info, and content.
19
+ * @returns The newly created CrmMailTemplate object.
20
+ */
6
21
  create(data: CreateCrmMailTemplateRequest): Promise<CrmMailTemplate>;
22
+ /**
23
+ * Update an existing mail template.
24
+ * @param uniqueId - The unique identifier of the template to update.
25
+ * @param data - The fields to update on the template.
26
+ * @returns The updated CrmMailTemplate object.
27
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
28
+ */
7
29
  update(uniqueId: string, data: UpdateCrmMailTemplateRequest): Promise<CrmMailTemplate>;
30
+ /**
31
+ * Retrieve Mandrill delivery statistics for a mail template.
32
+ * @param uniqueId - The unique identifier of the mail template.
33
+ * @returns MandrillTemplateStats with sent, open, click, bounce, and complaint counts.
34
+ */
8
35
  getMandrillStats(uniqueId: string): Promise<MandrillTemplateStats>;
36
+ /**
37
+ * Create a Mandrill template linked to a CRM mail template.
38
+ * @param uniqueId - The unique identifier of the CRM mail template.
39
+ * @param data - The Mandrill template creation payload with name, sender info, and content.
40
+ * @returns The updated CrmMailTemplate object with the Mandrill template linked.
41
+ */
9
42
  createMandrillTemplate(uniqueId: string, data: CreateMandrillTemplateRequest): Promise<CrmMailTemplate>;
43
+ /**
44
+ * Update the Mandrill template linked to a CRM mail template.
45
+ * @param uniqueId - The unique identifier of the CRM mail template.
46
+ * @param data - The fields to update on the Mandrill template.
47
+ * @returns The updated CrmMailTemplate object.
48
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
49
+ */
10
50
  updateMandrillTemplate(uniqueId: string, data: UpdateMandrillTemplateRequest): Promise<CrmMailTemplate>;
51
+ /**
52
+ * Publish the Mandrill template for a CRM mail template, making it available for sending.
53
+ * @param uniqueId - The unique identifier of the CRM mail template.
54
+ * @returns The updated CrmMailTemplate object after publishing.
55
+ */
11
56
  publishMandrill(uniqueId: string): Promise<CrmMailTemplate>;
12
57
  }
13
58
  export declare function createCrmMailTemplatesService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"mail-templates.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/mail-templates.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,eAAe,EACf,4BAA4B,EAC5B,4BAA4B,EAC5B,0BAA0B,EAC1B,6BAA6B,EAC7B,6BAA6B,EAC7B,qBAAqB,EACtB,MAAM,2BAA2B,CAAC;AAGnC,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,MAAM,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;IAChF,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAChD,MAAM,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACrE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACvF,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACnE,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC7D;AAED,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,uBAAuB,CAsGvH"}
1
+ {"version":3,"file":"mail-templates.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/mail-templates.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,eAAe,EACf,4BAA4B,EAC5B,4BAA4B,EAC5B,0BAA0B,EAC1B,6BAA6B,EAC7B,6BAA6B,EAC7B,qBAAqB,EACtB,MAAM,2BAA2B,CAAC;AAGnC,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEhD;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAErE;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEvF;;;;OAIG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAEnE;;;;;OAKG;IACH,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAExG;;;;;;OAMG;IACH,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAExG;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC7D;AAED,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,uBAAuB,CAsGvH"}
@@ -1,16 +1,73 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { MeetingBilling, CreateMeetingBillingRequest, UpdateMeetingBillingRequest, ListMeetingBillingsParams, PaymentSplit, EapSession, OutstandingByPayer, BillingRevenueReport, BillingAgingReport, BillingParticipantReport } from '../types/meeting-billing.js';
3
3
  export interface MeetingBillingsService {
4
+ /**
5
+ * List billing records for a specific meeting with optional filtering, pagination, and sorting.
6
+ * @param meetingUniqueId - The unique identifier of the parent meeting.
7
+ * @param params - Optional filtering (status, billingStatus, payerName, search), pagination, and sorting.
8
+ * @returns Paginated result containing MeetingBilling objects and metadata.
9
+ */
4
10
  list(meetingUniqueId: string, params?: ListMeetingBillingsParams): Promise<PageResult<MeetingBilling>>;
11
+ /**
12
+ * Retrieve a single billing record by its unique identifier.
13
+ * @param uniqueId - The unique identifier of the billing record.
14
+ * @returns The matching MeetingBilling object.
15
+ */
5
16
  get(uniqueId: string): Promise<MeetingBilling>;
17
+ /**
18
+ * Create a new billing record for a meeting.
19
+ * @param meetingUniqueId - The unique identifier of the parent meeting.
20
+ * @param data - The billing creation payload with participant, amount, currency, and due date.
21
+ * @returns The newly created MeetingBilling object.
22
+ */
6
23
  create(meetingUniqueId: string, data: CreateMeetingBillingRequest): Promise<MeetingBilling>;
24
+ /**
25
+ * Update an existing billing record.
26
+ * @param uniqueId - The unique identifier of the billing record to update.
27
+ * @param data - The fields to update on the billing record.
28
+ * @returns The updated MeetingBilling object.
29
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
30
+ */
7
31
  update(uniqueId: string, data: UpdateMeetingBillingRequest): Promise<MeetingBilling>;
32
+ /**
33
+ * Delete a billing record.
34
+ * @param uniqueId - The unique identifier of the billing record to delete.
35
+ * @returns Resolves when the billing record has been deleted.
36
+ */
8
37
  delete(uniqueId: string): Promise<void>;
38
+ /**
39
+ * Retrieve the payment split breakdown for a billing record.
40
+ * @param uniqueId - The unique identifier of the billing record.
41
+ * @returns An array of PaymentSplit objects showing how the payment is distributed.
42
+ */
9
43
  getPaymentSplit(uniqueId: string): Promise<PaymentSplit[]>;
44
+ /**
45
+ * Retrieve EAP (Employee Assistance Program) session details for a participant and payer.
46
+ * @param participantEmail - The email address of the participant.
47
+ * @param payerName - The name of the payer.
48
+ * @returns An EapSession object with session details.
49
+ */
10
50
  getEapSessions(participantEmail: string, payerName: string): Promise<EapSession>;
51
+ /**
52
+ * Retrieve outstanding billing amounts grouped by payer.
53
+ * @returns An array of OutstandingByPayer objects with payer names and amounts.
54
+ */
11
55
  getOutstandingByPayer(): Promise<OutstandingByPayer[]>;
56
+ /**
57
+ * Retrieve the billing revenue report.
58
+ * @returns A BillingRevenueReport with revenue totals and breakdowns.
59
+ */
12
60
  getRevenueReport(): Promise<BillingRevenueReport>;
61
+ /**
62
+ * Retrieve the billing aging report.
63
+ * @returns A BillingAgingReport with amounts bucketed by days outstanding.
64
+ */
13
65
  getAgingReport(): Promise<BillingAgingReport>;
66
+ /**
67
+ * Retrieve billing report for a specific participant.
68
+ * @param participantEmail - The email address of the participant.
69
+ * @returns A BillingParticipantReport with billing totals and session details.
70
+ */
14
71
  getParticipantReport(participantEmail: string): Promise<BillingParticipantReport>;
15
72
  }
16
73
  export declare function createMeetingBillingsService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"meeting-billings.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/meeting-billings.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC3B,yBAAyB,EACzB,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,wBAAwB,EACzB,MAAM,6BAA6B,CAAC;AAGrC,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC;IACvG,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/C,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC5F,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACrF,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAC3D,cAAc,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjF,qBAAqB,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACvD,gBAAgB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAClD,cAAc,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9C,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CACnF;AAED,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,sBAAsB,CA4FrH"}
1
+ {"version":3,"file":"meeting-billings.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/meeting-billings.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC3B,yBAAyB,EACzB,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,wBAAwB,EACzB,MAAM,6BAA6B,CAAC;AAGrC,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC;IAEvG;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE5F;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAErF;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,cAAc,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEjF;;;OAGG;IACH,qBAAqB,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAEvD;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAElD;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE9C;;;;OAIG;IACH,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CACnF;AAED,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,sBAAsB,CA4FrH"}
@@ -1,8 +1,26 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { MeetingParticipant, CreateMeetingParticipantRequest, ListMeetingParticipantsParams } from '../types/meeting-participant.js';
3
3
  export interface MeetingParticipantsService {
4
+ /**
5
+ * List participants for a specific meeting with optional filtering, pagination, and sorting.
6
+ * @param meetingUniqueId - The unique identifier of the parent meeting.
7
+ * @param params - Optional filtering (status, role, rsvpStatus, search), pagination, and sorting.
8
+ * @returns Paginated result containing MeetingParticipant objects and metadata.
9
+ */
4
10
  list(meetingUniqueId: string, params?: ListMeetingParticipantsParams): Promise<PageResult<MeetingParticipant>>;
11
+ /**
12
+ * Add a participant to a meeting.
13
+ * @param meetingUniqueId - The unique identifier of the parent meeting.
14
+ * @param data - The participant creation payload with contact/user reference, email, name, role, and RSVP status.
15
+ * @returns The newly created MeetingParticipant object.
16
+ */
5
17
  create(meetingUniqueId: string, data: CreateMeetingParticipantRequest): Promise<MeetingParticipant>;
18
+ /**
19
+ * Remove a participant from a meeting.
20
+ * @param meetingUniqueId - The unique identifier of the parent meeting.
21
+ * @param participantUniqueId - The unique identifier of the participant to remove.
22
+ * @returns Resolves when the participant has been removed.
23
+ */
6
24
  delete(meetingUniqueId: string, participantUniqueId: string): Promise<void>;
7
25
  }
8
26
  export declare function createMeetingParticipantsService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"meeting-participants.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/meeting-participants.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,kBAAkB,EAClB,+BAA+B,EAE/B,6BAA6B,EAC9B,MAAM,iCAAiC,CAAC;AAGzC,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,6BAA6B,GAAG,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC/G,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACpG,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7E;AAED,wBAAgB,gCAAgC,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,0BAA0B,CAmC7H"}
1
+ {"version":3,"file":"meeting-participants.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/meeting-participants.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,kBAAkB,EAClB,+BAA+B,EAE/B,6BAA6B,EAC9B,MAAM,iCAAiC,CAAC;AAGzC,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,6BAA6B,GAAG,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAE/G;;;;;OAKG;IACH,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEpG;;;;;OAKG;IACH,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7E;AAED,wBAAgB,gCAAgC,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,0BAA0B,CAmC7H"}
@@ -1,13 +1,57 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { Meeting, CreateMeetingRequest, UpdateMeetingRequest, ListMeetingsParams } from '../types/meeting.js';
3
3
  export interface MeetingsService {
4
+ /**
5
+ * List meetings with optional filtering, pagination, and sorting.
6
+ * @param params - Optional filtering (status, userUniqueId, accountUniqueId, meetingType, search), pagination, and sorting.
7
+ * @returns Paginated result containing Meeting objects and metadata.
8
+ */
4
9
  list(params?: ListMeetingsParams): Promise<PageResult<Meeting>>;
10
+ /**
11
+ * Retrieve a single meeting by its unique identifier.
12
+ * @param uniqueId - The unique identifier of the meeting.
13
+ * @returns The matching Meeting object.
14
+ */
5
15
  get(uniqueId: string): Promise<Meeting>;
16
+ /**
17
+ * Create a new meeting.
18
+ * @param data - The meeting creation payload with title, type, scheduling, location, and other fields.
19
+ * @returns The newly created Meeting object.
20
+ */
6
21
  create(data: CreateMeetingRequest): Promise<Meeting>;
22
+ /**
23
+ * Update an existing meeting.
24
+ * @param uniqueId - The unique identifier of the meeting to update.
25
+ * @param data - The fields to update on the meeting.
26
+ * @returns The updated Meeting object.
27
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
28
+ */
7
29
  update(uniqueId: string, data: UpdateMeetingRequest): Promise<Meeting>;
30
+ /**
31
+ * Soft-delete a meeting.
32
+ * @param uniqueId - The unique identifier of the meeting to delete.
33
+ * @returns Resolves when the meeting has been deleted.
34
+ */
8
35
  delete(uniqueId: string): Promise<void>;
36
+ /**
37
+ * Recover a previously soft-deleted meeting.
38
+ * @param uniqueId - The unique identifier of the meeting to recover.
39
+ * @returns The recovered Meeting object.
40
+ */
9
41
  recover(uniqueId: string): Promise<Meeting>;
42
+ /**
43
+ * Search meetings by a query string with optional pagination.
44
+ * @param query - The search query string.
45
+ * @param params - Optional pagination parameters.
46
+ * @returns Paginated result containing matching Meeting objects.
47
+ * @note Performs a server-side POST-based search.
48
+ */
10
49
  search(query: string, params?: ListMeetingsParams): Promise<PageResult<Meeting>>;
50
+ /**
51
+ * List soft-deleted meetings with optional pagination.
52
+ * @param params - Optional pagination parameters.
53
+ * @returns Paginated result containing soft-deleted Meeting objects.
54
+ */
11
55
  listDeleted(params?: ListMeetingsParams): Promise<PageResult<Meeting>>;
12
56
  }
13
57
  export declare function createMeetingsService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"meetings.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/meetings.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IACjF,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;CACxE;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,CAiGvG"}
1
+ {"version":3,"file":"meetings.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/meetings.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAEhE;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAExC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5C;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAEjF;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;CACxE;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,CAiGvG"}
@@ -1,13 +1,57 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { Opportunity, CreateOpportunityRequest, UpdateOpportunityRequest, ListOpportunitiesParams } from '../types/opportunity.js';
3
3
  export interface OpportunitiesService {
4
+ /**
5
+ * List opportunities with optional filtering, pagination, and sorting.
6
+ * @param params - Optional filtering (status, accountUniqueId, contactUniqueId, ownerUniqueId, search), pagination, and sorting.
7
+ * @returns Paginated result containing Opportunity objects and metadata.
8
+ */
4
9
  list(params?: ListOpportunitiesParams): Promise<PageResult<Opportunity>>;
10
+ /**
11
+ * Retrieve a single opportunity by its unique identifier.
12
+ * @param uniqueId - The unique identifier of the opportunity.
13
+ * @returns The matching Opportunity object.
14
+ */
5
15
  get(uniqueId: string): Promise<Opportunity>;
16
+ /**
17
+ * Create a new opportunity.
18
+ * @param data - The opportunity creation payload with account, contact, budget, duration, and other fields.
19
+ * @returns The newly created Opportunity object.
20
+ */
6
21
  create(data: CreateOpportunityRequest): Promise<Opportunity>;
22
+ /**
23
+ * Update an existing opportunity.
24
+ * @param uniqueId - The unique identifier of the opportunity to update.
25
+ * @param data - The fields to update on the opportunity.
26
+ * @returns The updated Opportunity object.
27
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
28
+ */
7
29
  update(uniqueId: string, data: UpdateOpportunityRequest): Promise<Opportunity>;
30
+ /**
31
+ * Soft-delete an opportunity.
32
+ * @param uniqueId - The unique identifier of the opportunity to delete.
33
+ * @returns Resolves when the opportunity has been deleted.
34
+ */
8
35
  delete(uniqueId: string): Promise<void>;
36
+ /**
37
+ * Recover a previously soft-deleted opportunity.
38
+ * @param uniqueId - The unique identifier of the opportunity to recover.
39
+ * @returns The recovered Opportunity object.
40
+ */
9
41
  recover(uniqueId: string): Promise<Opportunity>;
42
+ /**
43
+ * Search opportunities by a query string with optional pagination.
44
+ * @param query - The search query string.
45
+ * @param params - Optional pagination parameters.
46
+ * @returns Paginated result containing matching Opportunity objects.
47
+ * @note Performs a server-side POST-based search.
48
+ */
10
49
  search(query: string, params?: ListOpportunitiesParams): Promise<PageResult<Opportunity>>;
50
+ /**
51
+ * List soft-deleted opportunities with optional pagination.
52
+ * @param params - Optional pagination parameters.
53
+ * @returns Paginated result containing soft-deleted Opportunity objects.
54
+ */
11
55
  listDeleted(params?: ListOpportunitiesParams): Promise<PageResult<Opportunity>>;
12
56
  }
13
57
  export declare function createOpportunitiesService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"opportunities.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/opportunities.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,WAAW,EACX,wBAAwB,EACxB,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,yBAAyB,CAAC;AAGjC,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IACzE,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7D,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChD,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1F,WAAW,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;CACjF;AAED,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,oBAAoB,CA8FjH"}
1
+ {"version":3,"file":"opportunities.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/opportunities.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,WAAW,EACX,wBAAwB,EACxB,wBAAwB,EACxB,uBAAuB,EACxB,MAAM,yBAAyB,CAAC;AAGjC,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzE;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE5C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE7D;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE/E;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEhD;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1F;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;CACjF;AAED,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,oBAAoB,CA8FjH"}
@@ -1,13 +1,57 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { Quote, CreateQuoteRequest, UpdateQuoteRequest, ListQuotesParams } from '../types/quote.js';
3
3
  export interface QuotesService {
4
+ /**
5
+ * List quotes with optional filtering, pagination, and sorting.
6
+ * @param params - Optional filtering (status, accountUniqueId, contactUniqueId, ownerUniqueId, search), pagination, and sorting.
7
+ * @returns Paginated result containing Quote objects and metadata.
8
+ */
4
9
  list(params?: ListQuotesParams): Promise<PageResult<Quote>>;
10
+ /**
11
+ * Retrieve a single quote by its unique identifier.
12
+ * @param uniqueId - The unique identifier of the quote.
13
+ * @returns The matching Quote object.
14
+ */
5
15
  get(uniqueId: string): Promise<Quote>;
16
+ /**
17
+ * Create a new quote.
18
+ * @param data - The quote creation payload with account, contact, budget, duration, and other fields.
19
+ * @returns The newly created Quote object.
20
+ */
6
21
  create(data: CreateQuoteRequest): Promise<Quote>;
22
+ /**
23
+ * Update an existing quote.
24
+ * @param uniqueId - The unique identifier of the quote to update.
25
+ * @param data - The fields to update on the quote.
26
+ * @returns The updated Quote object.
27
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
28
+ */
7
29
  update(uniqueId: string, data: UpdateQuoteRequest): Promise<Quote>;
30
+ /**
31
+ * Soft-delete a quote.
32
+ * @param uniqueId - The unique identifier of the quote to delete.
33
+ * @returns Resolves when the quote has been deleted.
34
+ */
8
35
  delete(uniqueId: string): Promise<void>;
36
+ /**
37
+ * Recover a previously soft-deleted quote.
38
+ * @param uniqueId - The unique identifier of the quote to recover.
39
+ * @returns The recovered Quote object.
40
+ */
9
41
  recover(uniqueId: string): Promise<Quote>;
42
+ /**
43
+ * Search quotes by a query string with optional pagination.
44
+ * @param query - The search query string.
45
+ * @param params - Optional pagination parameters.
46
+ * @returns Paginated result containing matching Quote objects.
47
+ * @note Performs a server-side POST-based search.
48
+ */
10
49
  search(query: string, params?: ListQuotesParams): Promise<PageResult<Quote>>;
50
+ /**
51
+ * List soft-deleted quotes with optional pagination.
52
+ * @param params - Optional pagination parameters.
53
+ * @returns Paginated result containing soft-deleted Quote objects.
54
+ */
11
55
  listDeleted(params?: ListQuotesParams): Promise<PageResult<Quote>>;
12
56
  }
13
57
  export declare function createQuotesService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"quotes.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/quotes.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAG3B,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5D,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,MAAM,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACjD,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACnE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7E,WAAW,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;CACpE;AAED,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CA8FnG"}
1
+ {"version":3,"file":"quotes.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/quotes.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAG3B,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAE5D;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAEtC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAEnE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAE1C;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAE7E;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;CACpE;AAED,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CA8FnG"}
@@ -1,10 +1,37 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { Referral, CreateReferralRequest, UpdateReferralRequest, ListReferralsParams } from '../types/referral.js';
3
3
  export interface ReferralsService {
4
+ /**
5
+ * List referrals with optional filtering, pagination, and sorting.
6
+ * @param params - Optional filtering (status, referrerUniqueId, referredUniqueId, search), pagination, and sorting.
7
+ * @returns Paginated result containing Referral objects and metadata.
8
+ */
4
9
  list(params?: ListReferralsParams): Promise<PageResult<Referral>>;
10
+ /**
11
+ * Retrieve a single referral by its unique identifier.
12
+ * @param uniqueId - The unique identifier of the referral.
13
+ * @returns The matching Referral object.
14
+ */
5
15
  get(uniqueId: string): Promise<Referral>;
16
+ /**
17
+ * Create a new referral.
18
+ * @param data - The referral creation payload with referrer, referred, code, and source.
19
+ * @returns The newly created Referral object.
20
+ */
6
21
  create(data: CreateReferralRequest): Promise<Referral>;
22
+ /**
23
+ * Update an existing referral.
24
+ * @param uniqueId - The unique identifier of the referral to update.
25
+ * @param data - The fields to update on the referral.
26
+ * @returns The updated Referral object.
27
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
28
+ */
7
29
  update(uniqueId: string, data: UpdateReferralRequest): Promise<Referral>;
30
+ /**
31
+ * Delete a referral.
32
+ * @param uniqueId - The unique identifier of the referral to delete.
33
+ * @returns Resolves when the referral has been deleted.
34
+ */
8
35
  delete(uniqueId: string): Promise<void>;
9
36
  }
10
37
  export declare function createReferralsService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"referrals.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/referrals.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,sBAAsB,CAAC;AAG9B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClE,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvD,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,gBAAgB,CAmDzG"}
1
+ {"version":3,"file":"referrals.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/referrals.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,sBAAsB,CAAC;AAG9B,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAElE;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEzC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEzE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,gBAAgB,CAmDzG"}
@@ -1,10 +1,37 @@
1
1
  import type { Transport, PageResult } from '@23blocks/contracts';
2
2
  import type { Subscriber, CreateSubscriberRequest, UpdateSubscriberRequest, ListSubscribersParams } from '../types/subscriber.js';
3
3
  export interface SubscribersService {
4
+ /**
5
+ * List subscribers with optional filtering, pagination, and sorting.
6
+ * @param params - Optional filtering (status, source, search), pagination, and sorting parameters.
7
+ * @returns Paginated result containing Subscriber objects and metadata.
8
+ */
4
9
  list(params?: ListSubscribersParams): Promise<PageResult<Subscriber>>;
10
+ /**
11
+ * Retrieve a single subscriber by its unique identifier.
12
+ * @param uniqueId - The unique identifier of the subscriber.
13
+ * @returns The matching Subscriber object.
14
+ */
5
15
  get(uniqueId: string): Promise<Subscriber>;
16
+ /**
17
+ * Create a new subscriber.
18
+ * @param data - The subscriber creation payload with email, name, phone, source, and tags.
19
+ * @returns The newly created Subscriber object.
20
+ */
6
21
  create(data: CreateSubscriberRequest): Promise<Subscriber>;
22
+ /**
23
+ * Update an existing subscriber.
24
+ * @param uniqueId - The unique identifier of the subscriber to update.
25
+ * @param data - The fields to update on the subscriber.
26
+ * @returns The updated Subscriber object.
27
+ * @note Uses PUT (not PATCH) as required by the 23blocks backend.
28
+ */
7
29
  update(uniqueId: string, data: UpdateSubscriberRequest): Promise<Subscriber>;
30
+ /**
31
+ * Delete a subscriber.
32
+ * @param uniqueId - The unique identifier of the subscriber to delete.
33
+ * @returns Resolves when the subscriber has been deleted.
34
+ */
8
35
  delete(uniqueId: string): Promise<void>;
9
36
  }
10
37
  export declare function createSubscribersService(transport: Transport, _config: {
@@ -1 +1 @@
1
- {"version":3,"file":"subscribers.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/subscribers.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,UAAU,EACV,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,wBAAwB,CAAC;AAGhC,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,MAAM,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7E,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAyD7G"}
1
+ {"version":3,"file":"subscribers.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/subscribers.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,UAAU,EACV,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,wBAAwB,CAAC;AAGhC,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IAEtE;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3D;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7E;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAyD7G"}