@automate.ax/integration-contracts 0.152.0 → 0.152.2

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.
@@ -1274,7 +1274,11 @@ export namespace HighLevelCalendars {
1274
1274
  * This is only to set the standard availability. For custom
1275
1275
  * availability, use the availabilities property
1276
1276
  */
1277
- openHours?: components["schemas"]["OpenHour"][]
1277
+ openHours?:
1278
+ | components["schemas"]["OpenHour"][]
1279
+ | {
1280
+ [key: string]: unknown
1281
+ }
1278
1282
  /**
1279
1283
  * Enable recurring appointments for the calendars. Please note that
1280
1284
  * only one member should be added in the calendar to enable this
@@ -1391,30 +1395,30 @@ export namespace HighLevelCalendars {
1391
1395
  * @example
1392
1396
  * 9NkT25Vor1v4aQatFsv2
1393
1397
  */
1394
- contactId: string
1398
+ contactId?: string
1395
1399
  /**
1396
1400
  * Group ID
1397
1401
  *
1398
1402
  * @example
1399
1403
  * 9NkT25Vor1v4aQatFsv2
1400
1404
  */
1401
- groupId: string
1405
+ groupId?: string
1402
1406
  /**
1403
1407
  * Appointment Status
1404
1408
  *
1405
1409
  * @example
1406
1410
  * confirmed
1407
1411
  */
1408
- appointmentStatus: string
1412
+ appointmentStatus?: string
1409
1413
  /**
1410
1414
  * AssignedUser - the primary owner of an appointment
1411
1415
  *
1412
1416
  * @example
1413
1417
  * YlWd2wuCAZQzh2cH1fVZ
1414
1418
  */
1415
- assignedUserId: string
1419
+ assignedUserId?: string
1416
1420
  /** Users - the secondary owners of an appointment. */
1417
- users: string[]
1421
+ users?: string[]
1418
1422
  /**
1419
1423
  * Notes
1420
1424
  *
@@ -1448,28 +1452,28 @@ export namespace HighLevelCalendars {
1448
1452
  * @example
1449
1453
  * 2023-09-25T16:00:00+05:30
1450
1454
  */
1451
- startTime: Record<string, never>
1455
+ startTime: string
1452
1456
  /**
1453
1457
  * End Time
1454
1458
  *
1455
1459
  * @example
1456
1460
  * 2023-09-25T16:00:00+05:30
1457
1461
  */
1458
- endTime: Record<string, never>
1462
+ endTime: string
1459
1463
  /**
1460
1464
  * Date Added
1461
1465
  *
1462
1466
  * @example
1463
1467
  * 2023-09-25T16:00:00+05:30
1464
1468
  */
1465
- dateAdded: Record<string, never>
1469
+ dateAdded: string
1466
1470
  /**
1467
1471
  * Date Updated
1468
1472
  *
1469
1473
  * @example
1470
1474
  * 2023-09-25T16:00:00+05:30
1471
1475
  */
1472
- dateUpdated: Record<string, never>
1476
+ dateUpdated: string
1473
1477
  /** Ids of associated resources rooms and/or equipments */
1474
1478
  assignedResources?: string[]
1475
1479
  /** Appointment booked by metadata */
@@ -1729,9 +1733,9 @@ export namespace HighLevelCalendars {
1729
1733
  }
1730
1734
  CreatedOrUpdatedBy: {
1731
1735
  /** The ID of the user who created or updated the appointment */
1732
- userId?: string
1736
+ userId?: string | null
1733
1737
  /** The source of the appointment */
1734
- source: string
1738
+ source?: string
1735
1739
  }
1736
1740
  DeleteAppointmentSchema: Record<string, never>
1737
1741
  DeleteEventSuccessfulResponseDto: {
@@ -3206,12 +3210,12 @@ export namespace HighLevelContacts {
3206
3210
  * @example
3207
3211
  * JohnDeo@gmail.com
3208
3212
  */
3209
- email?: string
3213
+ email?: string | null
3210
3214
  /**
3211
3215
  * @example
3212
3216
  * Asia / Calcutta
3213
3217
  */
3214
- timezone?: string
3218
+ timezone?: string | null
3215
3219
  /**
3216
3220
  * @example
3217
3221
  * DE
@@ -3221,7 +3225,7 @@ export namespace HighLevelContacts {
3221
3225
  * @example
3222
3226
  * xyz form
3223
3227
  */
3224
- source?: string
3228
+ source?: string | null
3225
3229
  /**
3226
3230
  * @example
3227
3231
  * 2020-10-29T09:31:30.255Z
@@ -3233,7 +3237,7 @@ export namespace HighLevelContacts {
3233
3237
  * @example
3234
3238
  * 641c094001436dbc2081e642
3235
3239
  */
3236
- businessId?: string
3240
+ businessId?: string | null
3237
3241
  attributions?: components["schemas"]["AttributionSource"][]
3238
3242
  /**
3239
3243
  * @example
@@ -5152,6 +5156,28 @@ export namespace HighLevelConversations {
5152
5156
  patch?: never
5153
5157
  trace?: never
5154
5158
  }
5159
+ "/conversations/messages/email/{emailMessageId}/schedule": {
5160
+ parameters: {
5161
+ query?: never
5162
+ header?: never
5163
+ path?: never
5164
+ cookie?: never
5165
+ }
5166
+ get?: never
5167
+ put?: never
5168
+ post?: never
5169
+ /**
5170
+ * Cancel a scheduled email message.
5171
+ *
5172
+ * Post the messageId for the API to delete a scheduled email message. <br
5173
+ * />
5174
+ */
5175
+ delete: operations["cancel-scheduled-email-message"]
5176
+ options?: never
5177
+ head?: never
5178
+ patch?: never
5179
+ trace?: never
5180
+ }
5155
5181
  "/conversations/messages/{id}": {
5156
5182
  parameters: {
5157
5183
  query?: never
@@ -5536,7 +5562,7 @@ export namespace HighLevelConversations {
5536
5562
  * @example
5537
5563
  * This is a sample message body
5538
5564
  */
5539
- lastMessageBody: string
5565
+ lastMessageBody?: string
5540
5566
  /**
5541
5567
  * Channel/type of the most recent message (SMS, Email, Call, etc)
5542
5568
  *
@@ -5588,6 +5614,7 @@ export namespace HighLevelConversations {
5588
5614
  | "TYPE_ACTIVITY_WHATSAPP"
5589
5615
  | "TYPE_FORM_SUBMISSION"
5590
5616
  | "TYPE_SMS_REACTION"
5617
+ | "TYPE_NO_SHOW"
5591
5618
  /**
5592
5619
  * Primary channel/type of the conversation (Phone, Email, etc)
5593
5620
  *
@@ -5630,14 +5657,14 @@ export namespace HighLevelConversations {
5630
5657
  * @example
5631
5658
  * johndoe@mailingdomain.com
5632
5659
  */
5633
- email: string
5660
+ email?: string | null
5634
5661
  /**
5635
5662
  * Primary phone number of the contact
5636
5663
  *
5637
5664
  * @example
5638
5665
  * ;+15550001234
5639
5666
  */
5640
- phone: string
5667
+ phone?: string | null
5641
5668
  }
5642
5669
  CreateConversationDto: {
5643
5670
  /**
@@ -6384,7 +6411,9 @@ export namespace HighLevelConversations {
6384
6411
  *
6385
6412
  * @enum {string}
6386
6413
  */
6387
- status: "delivered" | "failed" | "pending" | "read"
6414
+ status?: "delivered" | "failed" | "pending" | "read"
6415
+ /** Email conversation thread ID. */
6416
+ threadId?: string
6388
6417
  }
6389
6418
  StartAfterArrayNumberSchema: {
6390
6419
  /**
@@ -6644,6 +6673,29 @@ export namespace HighLevelConversations {
6644
6673
  }
6645
6674
  }
6646
6675
  }
6676
+ "cancel-scheduled-email-message": {
6677
+ parameters: {
6678
+ query?: never
6679
+ header?: never
6680
+ path: {
6681
+ /** Email Message Id */
6682
+ emailMessageId: string
6683
+ }
6684
+ cookie?: never
6685
+ }
6686
+ requestBody?: never
6687
+ responses: {
6688
+ /** The scheduled email message was cancelled successfully */
6689
+ 200: {
6690
+ headers: {
6691
+ [name: string]: unknown
6692
+ }
6693
+ content: {
6694
+ "application/json": components["schemas"]["CancelScheduledResponseDto"]
6695
+ }
6696
+ }
6697
+ }
6698
+ }
6647
6699
  "get-message": {
6648
6700
  parameters: {
6649
6701
  query?: never
@@ -7825,7 +7877,16 @@ export namespace HighLevelOpportunities {
7825
7877
  * new pipeline()
7826
7878
  */
7827
7879
  name?: string
7828
- stages?: unknown[][]
7880
+ stages?: ({
7881
+ id: string
7882
+ name: string
7883
+ position?: number
7884
+ showInFunnel?: boolean
7885
+ showInPieChart?: boolean
7886
+ stageWinProbability?: number
7887
+ } & {
7888
+ [key: string]: unknown
7889
+ })[]
7829
7890
  /**
7830
7891
  * @example
7831
7892
  * false
@@ -7874,12 +7935,12 @@ export namespace HighLevelOpportunities {
7874
7935
  * @example
7875
7936
  * 3
7876
7937
  */
7877
- nextPage?: number
7938
+ nextPage?: number | string | null
7878
7939
  /**
7879
7940
  * @example
7880
7941
  * 1
7881
7942
  */
7882
- prevPage?: number
7943
+ prevPage?: number | null
7883
7944
  }
7884
7945
  SearchOpportunitiesContactResponseSchema: {
7885
7946
  /**
@@ -7896,17 +7957,17 @@ export namespace HighLevelOpportunities {
7896
7957
  * @example
7897
7958
  * Tesla Inc
7898
7959
  */
7899
- companyName?: string
7960
+ companyName?: string | null
7900
7961
  /**
7901
7962
  * @example
7902
7963
  * john@deo.com
7903
7964
  */
7904
- email?: string
7965
+ email?: string | null
7905
7966
  /**
7906
7967
  * @example
7907
7968
  * +1202-555-0107
7908
7969
  */
7909
- phone?: string
7970
+ phone?: string | null
7910
7971
  tags?: string[]
7911
7972
  }
7912
7973
  SearchOpportunitiesResponseSchema: {
@@ -7939,13 +8000,13 @@ export namespace HighLevelOpportunities {
7939
8000
  * @example
7940
8001
  * zT46WSCPbudrq4zhWMk6
7941
8002
  */
7942
- assignedTo?: string
8003
+ assignedTo?: string | null
7943
8004
  /**
7944
8005
  * @example
7945
8006
  * open
7946
8007
  */
7947
8008
  status?: string
7948
- source?: string
8009
+ source?: string | null
7949
8010
  /**
7950
8011
  * @example
7951
8012
  * 2021-08-03T04:55:17.355Z
@@ -7994,7 +8055,7 @@ export namespace HighLevelOpportunities {
7994
8055
  * @example
7995
8056
  * zT46WSCPbudrq4zhWMk6
7996
8057
  */
7997
- lostReasonId?: string
8058
+ lostReasonId?: string | null
7998
8059
  customFields?: components["schemas"]["CustomFieldResponseSchema"][]
7999
8060
  followers?: unknown[][]
8000
8061
  externalObjectId?: string
@@ -8115,7 +8176,7 @@ export namespace HighLevelOpportunities {
8115
8176
  * @example
8116
8177
  * 220
8117
8178
  */
8118
- monetaryValue?: Record<string, never>
8179
+ monetaryValue?: number
8119
8180
  /**
8120
8181
  * @example
8121
8182
  * 082goXVW3lIExEQPOnd3
@@ -9906,6 +9967,7 @@ export interface HighLevelOperationMap {
9906
9967
  "conversations:get-message": HighLevelConversations.operations["get-message"]
9907
9968
  "conversations:send-a-new-message": HighLevelConversations.operations["send-a-new-message"]
9908
9969
  "conversations:cancel-scheduled-message": HighLevelConversations.operations["cancel-scheduled-message"]
9970
+ "conversations:cancel-scheduled-email-message": HighLevelConversations.operations["cancel-scheduled-email-message"]
9909
9971
  "conversations:get-message-recording": HighLevelConversations.operations["get-message-recording"]
9910
9972
  "conversations:get-message-transcription": HighLevelConversations.operations["get-message-transcription"]
9911
9973
  "forms:get-forms": HighLevelForms.operations["get-forms"]
@@ -588,6 +588,15 @@ export const HIGH_LEVEL_OPERATION_DEFINITIONS = [
588
588
  "Cancels one scheduled message before delivery.",
589
589
  "safe",
590
590
  ),
591
+ operation(
592
+ "conversations",
593
+ "cancel-scheduled-email-message",
594
+ "cancelScheduledEmailMessage",
595
+ "cancelScheduledHighLevelEmailMessage",
596
+ "Cancel scheduled HighLevel email message",
597
+ "Cancels one scheduled email before delivery.",
598
+ "safe",
599
+ ),
591
600
  operation(
592
601
  "conversations",
593
602
  "get-message-recording",