@ikatec/digisac-api-sdk 2.1.0 → 2.1.1

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.
@@ -4,6 +4,7 @@ import type { Message } from '../messages';
4
4
  import type { Service } from '../services';
5
5
  import type { Tag } from '../tags';
6
6
  import type { User } from '../users';
7
+ import type { WhatsappBusinessTemplate } from '../whatsappBusinessTemplates';
7
8
  export type CampaignStatus = 'ready' | 'queued' | 'processing' | 'paused' | 'waiting_connection' | 'canceled' | 'done' | 'insufficient_credits' | 'hsm_limit_exceeded' | 'import_error' | 'error' | 'importing_contacts' | 'preventive_break';
8
9
  export type CampaignConfig = {
9
10
  /** Minimum interval in ms between sends. */
@@ -57,6 +58,22 @@ export type Campaign = {
57
58
  importFile?: File | null;
58
59
  };
59
60
  export type CampaignRelationships = 'service' | 'defaultDepartment' | 'defaultUser' | 'createdBy' | 'sentBy' | 'tags' | 'messages' | 'importFile';
61
+ export type CampaignTemplateParameterItem = {
62
+ type: string;
63
+ text?: string;
64
+ };
65
+ export type CampaignTemplateParameter = {
66
+ type: string;
67
+ parameters: CampaignTemplateParameterItem[];
68
+ sub_type?: string;
69
+ index?: number;
70
+ };
71
+ export type CampaignFileTemplate = {
72
+ blob?: undefined;
73
+ base64Url?: string;
74
+ mimetype?: string;
75
+ name?: string;
76
+ };
60
77
  export type CreateCampaignPayload = {
61
78
  title: string;
62
79
  serviceId: string;
@@ -74,15 +91,15 @@ export type CreateCampaignPayload = {
74
91
  mustOpenTicket?: boolean;
75
92
  defaultDepartmentId?: string | null;
76
93
  defaultUserId?: string | null;
77
- hsm?: unknown;
78
- parameters?: unknown;
79
- fileTemplate?: unknown;
80
- contacts?: unknown[];
94
+ contacts?: Record<string, string>[];
81
95
  useTags?: boolean;
82
- marketingIntegration?: boolean;
83
96
  fileId?: string;
84
97
  nameField?: string;
85
98
  numberField?: string;
99
+ hsm?: WhatsappBusinessTemplate;
100
+ parameters?: CampaignTemplateParameter[];
101
+ fileTemplate?: CampaignFileTemplate;
102
+ marketingIntegration?: boolean;
86
103
  };
87
104
  export type UpdateCampaignPayload = Partial<CreateCampaignPayload>;
88
105
  export type CampaignStatsInfo = {
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/campaigns/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAEpC,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,oBAAoB,GACpB,UAAU,GACV,MAAM,GACN,sBAAsB,GACtB,oBAAoB,GACpB,cAAc,GACd,OAAO,GACP,oBAAoB,GACpB,kBAAkB,CAAA;AAEtB,MAAM,MAAM,cAAc,GAAG;IAC3B,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,MAAM,CAAA;IACpC,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,cAAc,CAAA;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,cAAc,EAAE,OAAO,CAAA;IACvB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,iBAAiB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACrC,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAC7B,SAAS,GACT,mBAAmB,GACnB,aAAa,GACb,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,GACV,YAAY,CAAA;AAEhB,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACvE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC/C,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAElE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;IACvB,8BAA8B,EAAE,MAAM,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,iBAAiB,CAAA;IAC/B,WAAW,EAAE,qBAAqB,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/campaigns/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAA;AAE5E,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,oBAAoB,GACpB,UAAU,GACV,MAAM,GACN,sBAAsB,GACtB,oBAAoB,GACpB,cAAc,GACd,OAAO,GACP,oBAAoB,GACpB,kBAAkB,CAAA;AAEtB,MAAM,MAAM,cAAc,GAAG;IAC3B,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,MAAM,CAAA;IACpC,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,cAAc,CAAA;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,cAAc,EAAE,OAAO,CAAA;IACvB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,iBAAiB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACrC,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAC7B,SAAS,GACT,mBAAmB,GACnB,aAAa,GACb,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,GACV,YAAY,CAAA;AAEhB,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,6BAA6B,EAAE,CAAA;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACvE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC/C,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAA;IACnC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,GAAG,CAAC,EAAE,wBAAwB,CAAA;IAC9B,UAAU,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACxC,YAAY,CAAC,EAAE,oBAAoB,CAAA;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAElE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;IACvB,8BAA8B,EAAE,MAAM,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,iBAAiB,CAAA;IAC/B,WAAW,EAAE,qBAAqB,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA"}
@@ -1,11 +1,28 @@
1
1
  export type WhatsappBusinessTemplateMessageType = 'text_only' | 'interactive';
2
2
  export type WhatsappBusinessTemplateLanguage = 'pt_BR' | 'es' | 'en';
3
3
  export type WhatsappBusinessTemplateCategory = 'AUTHENTICATION' | 'MARKETING' | 'UTILITY';
4
+ export type WhatsappBusinessTemplateComponentType = 'HEADER' | 'BODY' | 'FOOTER' | 'BUTTONS';
5
+ export type WhatsappBusinessTemplateHeaderFormat = 'TEXT' | 'IMAGE' | 'VIDEO' | 'DOCUMENT';
6
+ export type WhatsappBusinessTemplateButton = {
7
+ type: string;
8
+ text: string;
9
+ url?: string;
10
+ params?: string[];
11
+ phone_number?: string;
12
+ };
13
+ export type WhatsappBusinessTemplateComponent = {
14
+ type: WhatsappBusinessTemplateComponentType;
15
+ format?: WhatsappBusinessTemplateHeaderFormat;
16
+ text?: string;
17
+ params?: string[];
18
+ buttons?: WhatsappBusinessTemplateButton[];
19
+ code_expiration_minutes?: number;
20
+ };
4
21
  export type WhatsappBusinessTemplate = {
5
22
  id: string;
6
23
  internalName: string | null;
7
24
  category: string;
8
- components: Record<string, unknown>[];
25
+ components: WhatsappBusinessTemplateComponent[];
9
26
  language: string;
10
27
  name: string;
11
28
  namespace: string;
@@ -24,7 +41,7 @@ export type WhatsappBusinessTemplate = {
24
41
  export type CreateWhatsappBusinessTemplatePayload = {
25
42
  name: string;
26
43
  internalName: string;
27
- components: Record<string, unknown>[];
44
+ components: WhatsappBusinessTemplateComponent[];
28
45
  serviceId: string;
29
46
  messageType: WhatsappBusinessTemplateMessageType;
30
47
  language: WhatsappBusinessTemplateLanguage;
@@ -33,7 +50,7 @@ export type CreateWhatsappBusinessTemplatePayload = {
33
50
  export type UpdateWhatsappBusinessTemplatePayload = {
34
51
  name?: string;
35
52
  internalName?: string;
36
- components?: Record<string, unknown>[];
53
+ components?: WhatsappBusinessTemplateComponent[];
37
54
  serviceId?: string;
38
55
  messageType?: WhatsappBusinessTemplateMessageType;
39
56
  language?: WhatsappBusinessTemplateLanguage;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/whatsappBusinessTemplates/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mCAAmC,GAAG,WAAW,GAAG,aAAa,CAAA;AAE7E,MAAM,MAAM,gCAAgC,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,CAAA;AAEpE,MAAM,MAAM,gCAAgC,GAAG,gBAAgB,GAAG,WAAW,GAAG,SAAS,CAAA;AAEzF,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;IACrC,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,mCAAmC,CAAA;IAChD,QAAQ,EAAE,gCAAgC,CAAA;IAC1C,QAAQ,EAAE,gCAAgC,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;IACtC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,mCAAmC,CAAA;IACjD,QAAQ,CAAC,EAAE,gCAAgC,CAAA;IAC3C,QAAQ,CAAC,EAAE,gCAAgC,CAAA;CAC5C,CAAA"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/whatsappBusinessTemplates/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mCAAmC,GAAG,WAAW,GAAG,aAAa,CAAA;AAE7E,MAAM,MAAM,gCAAgC,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,CAAA;AAEpE,MAAM,MAAM,gCAAgC,GAAG,gBAAgB,GAAG,WAAW,GAAG,SAAS,CAAA;AAEzF,MAAM,MAAM,qCAAqC,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE5F,MAAM,MAAM,oCAAoC,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,CAAA;AAE1F,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,qCAAqC,CAAA;IAC3C,MAAM,CAAC,EAAE,oCAAoC,CAAA;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,OAAO,CAAC,EAAE,8BAA8B,EAAE,CAAA;IAC1C,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,iCAAiC,EAAE,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,iCAAiC,EAAE,CAAA;IAC/C,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,mCAAmC,CAAA;IAChD,QAAQ,EAAE,gCAAgC,CAAA;IAC1C,QAAQ,EAAE,gCAAgC,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,iCAAiC,EAAE,CAAA;IAChD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,mCAAmC,CAAA;IACjD,QAAQ,CAAC,EAAE,gCAAgC,CAAA;IAC3C,QAAQ,CAAC,EAAE,gCAAgC,CAAA;CAC5C,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ikatec/digisac-api-sdk",
3
- "version": "2.1.0",
3
+ "version": "2.1.1",
4
4
  "type": "module",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",
@@ -4,6 +4,7 @@ import type { Message } from '../messages'
4
4
  import type { Service } from '../services'
5
5
  import type { Tag } from '../tags'
6
6
  import type { User } from '../users'
7
+ import type { WhatsappBusinessTemplate } from '../whatsappBusinessTemplates'
7
8
 
8
9
  export type CampaignStatus =
9
10
  | 'ready'
@@ -84,6 +85,25 @@ export type CampaignRelationships =
84
85
  | 'messages'
85
86
  | 'importFile'
86
87
 
88
+ export type CampaignTemplateParameterItem = {
89
+ type: string
90
+ text?: string
91
+ }
92
+
93
+ export type CampaignTemplateParameter = {
94
+ type: string
95
+ parameters: CampaignTemplateParameterItem[]
96
+ sub_type?: string
97
+ index?: number
98
+ }
99
+
100
+ export type CampaignFileTemplate = {
101
+ blob?: undefined
102
+ base64Url?: string
103
+ mimetype?: string
104
+ name?: string
105
+ }
106
+
87
107
  export type CreateCampaignPayload = {
88
108
  title: string
89
109
  serviceId: string
@@ -95,15 +115,16 @@ export type CreateCampaignPayload = {
95
115
  mustOpenTicket?: boolean
96
116
  defaultDepartmentId?: string | null
97
117
  defaultUserId?: string | null
98
- hsm?: unknown
99
- parameters?: unknown
100
- fileTemplate?: unknown
101
- contacts?: unknown[]
118
+ contacts?: Record<string, string>[]
102
119
  useTags?: boolean
103
- marketingIntegration?: boolean
104
120
  fileId?: string
105
121
  nameField?: string
106
122
  numberField?: string
123
+ // whatsapp-business specific
124
+ hsm?: WhatsappBusinessTemplate
125
+ parameters?: CampaignTemplateParameter[]
126
+ fileTemplate?: CampaignFileTemplate
127
+ marketingIntegration?: boolean
107
128
  }
108
129
 
109
130
  export type UpdateCampaignPayload = Partial<CreateCampaignPayload>
@@ -4,11 +4,32 @@ export type WhatsappBusinessTemplateLanguage = 'pt_BR' | 'es' | 'en'
4
4
 
5
5
  export type WhatsappBusinessTemplateCategory = 'AUTHENTICATION' | 'MARKETING' | 'UTILITY'
6
6
 
7
+ export type WhatsappBusinessTemplateComponentType = 'HEADER' | 'BODY' | 'FOOTER' | 'BUTTONS'
8
+
9
+ export type WhatsappBusinessTemplateHeaderFormat = 'TEXT' | 'IMAGE' | 'VIDEO' | 'DOCUMENT'
10
+
11
+ export type WhatsappBusinessTemplateButton = {
12
+ type: string
13
+ text: string
14
+ url?: string
15
+ params?: string[]
16
+ phone_number?: string
17
+ }
18
+
19
+ export type WhatsappBusinessTemplateComponent = {
20
+ type: WhatsappBusinessTemplateComponentType
21
+ format?: WhatsappBusinessTemplateHeaderFormat
22
+ text?: string
23
+ params?: string[]
24
+ buttons?: WhatsappBusinessTemplateButton[]
25
+ code_expiration_minutes?: number
26
+ }
27
+
7
28
  export type WhatsappBusinessTemplate = {
8
29
  id: string
9
30
  internalName: string | null
10
31
  category: string
11
- components: Record<string, unknown>[]
32
+ components: WhatsappBusinessTemplateComponent[]
12
33
  language: string
13
34
  name: string
14
35
  namespace: string
@@ -28,7 +49,7 @@ export type WhatsappBusinessTemplate = {
28
49
  export type CreateWhatsappBusinessTemplatePayload = {
29
50
  name: string
30
51
  internalName: string
31
- components: Record<string, unknown>[]
52
+ components: WhatsappBusinessTemplateComponent[]
32
53
  serviceId: string
33
54
  messageType: WhatsappBusinessTemplateMessageType
34
55
  language: WhatsappBusinessTemplateLanguage
@@ -38,7 +59,7 @@ export type CreateWhatsappBusinessTemplatePayload = {
38
59
  export type UpdateWhatsappBusinessTemplatePayload = {
39
60
  name?: string
40
61
  internalName?: string
41
- components?: Record<string, unknown>[]
62
+ components?: WhatsappBusinessTemplateComponent[]
42
63
  serviceId?: string
43
64
  messageType?: WhatsappBusinessTemplateMessageType
44
65
  language?: WhatsappBusinessTemplateLanguage