@or-sdk/hitl 0.35.2-beta.3703.0 → 0.35.2-beta.3708.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 (93) hide show
  1. package/dist/cjs/api/Agents.js.map +1 -1
  2. package/dist/cjs/api/CannedMessages.js.map +1 -1
  3. package/dist/cjs/api/Commands.js.map +1 -1
  4. package/dist/cjs/api/Conferences.js.map +1 -1
  5. package/dist/cjs/api/Listeners.js +3 -2
  6. package/dist/cjs/api/Listeners.js.map +1 -1
  7. package/dist/cjs/types/commands.js.map +1 -1
  8. package/dist/cjs/types/conferences.js.map +1 -1
  9. package/dist/cjs/types/listeners.js +1 -2
  10. package/dist/cjs/types/listeners.js.map +1 -1
  11. package/dist/cjs/types/migrations.js.map +1 -1
  12. package/dist/cjs/types/tasks.js.map +1 -1
  13. package/dist/esm/api/Agents.js.map +1 -1
  14. package/dist/esm/api/CannedMessages.js.map +1 -1
  15. package/dist/esm/api/Commands.js.map +1 -1
  16. package/dist/esm/api/Conferences.js.map +1 -1
  17. package/dist/esm/api/Listeners.js +2 -1
  18. package/dist/esm/api/Listeners.js.map +1 -1
  19. package/dist/esm/types/commands.js.map +1 -1
  20. package/dist/esm/types/conferences.js.map +1 -1
  21. package/dist/esm/types/listeners.js +1 -2
  22. package/dist/esm/types/listeners.js.map +1 -1
  23. package/dist/esm/types/migrations.js.map +1 -1
  24. package/dist/esm/types/tasks.js.map +1 -1
  25. package/dist/types/api/Agents.d.ts.map +1 -1
  26. package/dist/types/api/CannedMessages.d.ts.map +1 -1
  27. package/dist/types/api/Commands.d.ts.map +1 -1
  28. package/dist/types/api/Conferences.d.ts +3 -3
  29. package/dist/types/api/Conferences.d.ts.map +1 -1
  30. package/dist/types/api/Listeners.d.ts +1 -0
  31. package/dist/types/api/Listeners.d.ts.map +1 -1
  32. package/dist/types/types/canned-messages.d.ts +18 -6
  33. package/dist/types/types/canned-messages.d.ts.map +1 -1
  34. package/dist/types/types/commands.d.ts +2 -1
  35. package/dist/types/types/commands.d.ts.map +1 -1
  36. package/dist/types/types/conferences.d.ts +18 -5
  37. package/dist/types/types/conferences.d.ts.map +1 -1
  38. package/dist/types/types/contacts-meta.d.ts +7 -3
  39. package/dist/types/types/contacts-meta.d.ts.map +1 -1
  40. package/dist/types/types/contacts.d.ts +4 -2
  41. package/dist/types/types/contacts.d.ts.map +1 -1
  42. package/dist/types/types/event-templates.d.ts +18 -6
  43. package/dist/types/types/event-templates.d.ts.map +1 -1
  44. package/dist/types/types/filters.d.ts +48 -26
  45. package/dist/types/types/filters.d.ts.map +1 -1
  46. package/dist/types/types/helpers.d.ts +2 -1
  47. package/dist/types/types/helpers.d.ts.map +1 -1
  48. package/dist/types/types/listeners.d.ts +23 -9
  49. package/dist/types/types/listeners.d.ts.map +1 -1
  50. package/dist/types/types/migrations.d.ts +29 -12
  51. package/dist/types/types/migrations.d.ts.map +1 -1
  52. package/dist/types/types/read-events.d.ts +8 -4
  53. package/dist/types/types/read-events.d.ts.map +1 -1
  54. package/dist/types/types/rule-groups.d.ts +13 -6
  55. package/dist/types/types/rule-groups.d.ts.map +1 -1
  56. package/dist/types/types/session-events.d.ts +18 -7
  57. package/dist/types/types/session-events.d.ts.map +1 -1
  58. package/dist/types/types/session-relations.d.ts +18 -6
  59. package/dist/types/types/session-relations.d.ts.map +1 -1
  60. package/dist/types/types/sessions.d.ts +82 -24
  61. package/dist/types/types/sessions.d.ts.map +1 -1
  62. package/dist/types/types/settings.d.ts +19 -8
  63. package/dist/types/types/settings.d.ts.map +1 -1
  64. package/dist/types/types/tasks.d.ts +2 -1
  65. package/dist/types/types/tasks.d.ts.map +1 -1
  66. package/dist/types/types/versions.d.ts +7 -2
  67. package/dist/types/types/versions.d.ts.map +1 -1
  68. package/package.json +1 -1
  69. package/src/api/Agents.ts +25 -11
  70. package/src/api/CannedMessages.ts +167 -18
  71. package/src/api/Commands.ts +43 -3
  72. package/src/api/Conferences.ts +135 -12
  73. package/src/api/ContactRuleGroups.ts +5 -5
  74. package/src/api/Contacts.ts +1 -1
  75. package/src/api/Listeners.ts +14 -10
  76. package/src/types/canned-messages.ts +28 -16
  77. package/src/types/commands.ts +3 -4
  78. package/src/types/conferences.ts +25 -10
  79. package/src/types/contacts-meta.ts +8 -7
  80. package/src/types/contacts.ts +4 -3
  81. package/src/types/event-templates.ts +26 -11
  82. package/src/types/filters.ts +63 -21
  83. package/src/types/helpers.ts +2 -2
  84. package/src/types/listeners.ts +33 -25
  85. package/src/types/migrations.ts +37 -12
  86. package/src/types/read-events.ts +10 -10
  87. package/src/types/rule-groups.ts +18 -12
  88. package/src/types/session-events.ts +33 -17
  89. package/src/types/session-relations.ts +19 -10
  90. package/src/types/sessions.ts +96 -44
  91. package/src/types/settings.ts +24 -15
  92. package/src/types/tasks.ts +3 -4
  93. package/src/types/versions.ts +7 -3
@@ -20,17 +20,18 @@ import { HITLBase } from './HITLBase';
20
20
  */
21
21
  export class Listeners extends HITLBase {
22
22
  protected static MODULE_URL = 'listeners';
23
+ protected static LISTENER_VERSION_FIELD = 'listenerVersion' as const;
23
24
 
24
25
  /**
25
26
  * @description Get a list of HitL event listeners
26
27
  * @param options
27
28
  */
28
29
  public static async getListeners(
29
- options: GetListenersOptions = {}
30
+ options: GetListenersOptions = {},
30
31
  ): Promise<GetListenersResponse> {
31
32
  const route = this.getBaseUrl(options);
32
33
  const params = Object.fromEntries(
33
- Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key))
34
+ Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
34
35
  );
35
36
 
36
37
  return this.request({
@@ -46,7 +47,7 @@ export class Listeners extends HITLBase {
46
47
  * @param options
47
48
  */
48
49
  public static async getListenerById(
49
- { agentId, callbackId, ...options }: GetListenerByIdOptions
50
+ { agentId, callbackId, ...options }: GetListenerByIdOptions,
50
51
  ): Promise<GetListenersResponse> {
51
52
  const baseUrl = this.getBaseUrl(options);
52
53
  const route = new URI(baseUrl).segment(callbackId).href();
@@ -64,12 +65,15 @@ export class Listeners extends HITLBase {
64
65
  * @param options
65
66
  */
66
67
  public static async createListener(
67
- options: CreateListenersOptions
68
+ options: CreateListenersOptions,
68
69
  ): Promise<Listener> {
69
70
  const route = this.getBaseUrl(options);
70
- const data = Object.fromEntries(
71
- Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key))
72
- );
71
+ const data = {
72
+ ...Object.fromEntries(
73
+ Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
74
+ ),
75
+ version: options[this.LISTENER_VERSION_FIELD],
76
+ };
73
77
 
74
78
  return this.request({
75
79
  method: 'POST',
@@ -84,12 +88,12 @@ export class Listeners extends HITLBase {
84
88
  * @param options
85
89
  */
86
90
  public static async updateListener(
87
- { callbackId, ...options }: UpdateListenersOptions
91
+ { callbackId, ...options }: UpdateListenersOptions,
88
92
  ): Promise<Listener> {
89
93
  const baseUrl = this.getBaseUrl(options);
90
94
  const route = new URI(baseUrl).segment(callbackId).href();
91
95
  const data = Object.fromEntries(
92
- Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key))
96
+ Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
93
97
  );
94
98
 
95
99
  return this.request({
@@ -105,7 +109,7 @@ export class Listeners extends HITLBase {
105
109
  * @param options
106
110
  */
107
111
  public static async deleteListener(
108
- { callbackId, ...options }: DeleteListenersOptions
112
+ { callbackId, ...options }: DeleteListenersOptions,
109
113
  ): Promise<void> {
110
114
  const baseUrl = this.getBaseUrl(options);
111
115
  const route = new URI(baseUrl).segment(callbackId).href();
@@ -2,19 +2,31 @@ import { CannedMessages } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type CannedMessage = CannedMessages.ICannedMessage;
7
- export type GetCannedMessagesOptions = ApiVersionOptions
8
- & NoAccountId<CannedMessages.IGetCannedMessagesQuery>;
9
- export type GetCannedMessagesResponse
10
- = CannedMessages.IGetCannedMessagesResponse;
11
-
12
- export type CreateCannedMessageOptions = ApiVersionOptions
13
- & NoAccountId<CannedMessages.ICreateCannedMessageQuery>
14
- & CannedMessages.ICreateCannedMessageBody;
15
-
16
- export type UpdateCannedMessageOptions = ApiVersionOptions
17
- & CannedMessages.IUpdateCannedMessageBody;
18
-
19
- export type DeleteCannedMessageOptions = ApiVersionOptions
20
- & NoAccountId<CannedMessages.IDeleteCannedMessageQuery>;
5
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
6
+ export interface CannedMessageAttachment extends CannedMessages.ICannedMessageAttachment {}
7
+
8
+ export interface CannedMessage extends CannedMessages.ICannedMessage {
9
+ attachments: CannedMessageAttachment[];
10
+ }
11
+
12
+ export interface GetCannedMessagesOptions extends ApiVersionOptions,
13
+ NoAccountId<CannedMessages.IGetCannedMessagesQuery> {}
14
+
15
+ export interface GetCannedMessagesResponse
16
+ extends CannedMessages.IGetCannedMessagesResponse {
17
+ data: CannedMessage[];
18
+ }
19
+
20
+ export interface CreateCannedMessageOptions extends ApiVersionOptions,
21
+ NoAccountId<CannedMessages.ICreateCannedMessageQuery>,
22
+ CannedMessages.ICreateCannedMessageBody {
23
+ attachments?: CannedMessageAttachment[];
24
+ }
25
+
26
+ export interface UpdateCannedMessageOptions extends ApiVersionOptions,
27
+ CannedMessages.IUpdateCannedMessageBody {
28
+ attachments?: CannedMessageAttachment[];
29
+ }
30
+
31
+ export interface DeleteCannedMessageOptions extends ApiVersionOptions,
32
+ NoAccountId<CannedMessages.IDeleteCannedMessageQuery> {}
@@ -2,9 +2,8 @@ import { Commands, COMMANDS } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type ApplyCommandOptions = ApiVersionOptions
7
- & Commands.IApplyCommandQuery
8
- & Commands.IApplyCommandBody;
5
+ export interface ApplyCommandOptions extends ApiVersionOptions,
6
+ Commands.IApplyCommandQuery,
7
+ Commands.IApplyCommandBody {}
9
8
 
10
9
  export { COMMANDS };
@@ -2,15 +2,30 @@ import { Conferences, CALL_MEMBER_TYPE, CALL_MEMBER_STATUS } from '@onereach/typ
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type GetConferenceMembersOptions = ApiVersionOptions &
7
- NoAccountId<Conferences.IGetConferenceMembersQuery>;
8
- export type GetConferenceMembersResponse =
9
- Conferences.IGetConferenceMembersResponse;
10
- export type Conference = Conferences.IConferenceMember;
11
- export type AddOrUpdateConferenceMemberOptions = ApiVersionOptions &
12
- Conferences.IAddOrUpdateConferenceMemberBody;
13
- export type CleanUpConferenceOptions = ApiVersionOptions &
14
- NoAccountId<Conferences.ICleanUpConferenceQuery>;
5
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
6
+ export interface ConferenceMemberState extends Conferences.IConferenceMemberState {}
7
+
8
+ export interface ConferenceMember extends Conferences.IConferenceMember {
9
+ status: CALL_MEMBER_STATUS;
10
+ type: CALL_MEMBER_TYPE;
11
+ }
12
+
13
+ export interface GetConferenceMembersOptions extends ApiVersionOptions,
14
+ NoAccountId<Conferences.IGetConferenceMembersQuery> {}
15
+
16
+ export interface GetConferenceMembersResponse extends
17
+ Conferences.IGetConferenceMembersResponse {
18
+ data: ConferenceMember[];
19
+ }
20
+
21
+ export interface AddOrUpdateConferenceMemberOptions extends ApiVersionOptions,
22
+ Conferences.IAddOrUpdateConferenceMemberBody {
23
+ state?: ConferenceMemberState;
24
+ status: CALL_MEMBER_STATUS;
25
+ type: CALL_MEMBER_TYPE;
26
+ }
27
+
28
+ export interface CleanUpConferenceOptions extends ApiVersionOptions,
29
+ NoAccountId<Conferences.ICleanUpConferenceQuery> {}
15
30
 
16
31
  export { CALL_MEMBER_TYPE, CALL_MEMBER_STATUS };
@@ -2,12 +2,13 @@ import { ContactsMeta, IDateToString } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- export type ContactMeta = IDateToString<ContactsMeta.IContactMeta>;
5
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
6
+ export interface ContactMeta extends IDateToString<ContactsMeta.IContactMeta> {}
6
7
 
7
- /* eslint-disable @typescript-eslint/indent */
8
- export type SearchContactsMetaOptions = ApiVersionOptions
9
- & NoAccountId<ContactsMeta.ISearchContactsMetaQuery>
10
- & ContactsMeta.ISearchContactsMetaBody;
8
+ export interface SearchContactsMetaOptions extends ApiVersionOptions,
9
+ NoAccountId<ContactsMeta.ISearchContactsMetaQuery>,
10
+ ContactsMeta.ISearchContactsMetaBody {}
11
11
 
12
- export type SearchContactsMetaResponse
13
- = ContactsMeta.ISearchContactsMetaResponse;
12
+ export interface SearchContactsMetaResponse extends ContactsMeta.ISearchContactsMetaResponse {
13
+ data: Record<string, ContactMeta>;
14
+ }
@@ -2,7 +2,8 @@ import { Contacts } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type SearchContactsOptions = ApiVersionOptions & Contacts.SearchContactsBody;
5
+ export interface SearchContactsOptions extends ApiVersionOptions,
6
+ Contacts.SearchContactsBody {}
7
7
 
8
- export type SearchContactsResponse = Contacts.SearchContactsResponse;
8
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
9
+ export interface SearchContactsResponse extends Contacts.SearchContactsResponse {}
@@ -2,14 +2,29 @@ import { EventTemplates } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type GetEventTemplatesOptions = ApiVersionOptions
7
- & NoAccountId<EventTemplates.IGetEventTemplatesQuery>;
8
- export type GetEventTemplatesResponse = EventTemplates.IGetEventTemplatesResponse;
9
- export type CreateEventTemplateOptions = ApiVersionOptions
10
- & EventTemplates.ICreateEventTemplateBody;
11
- export type UpdateEventTemplateOptions = ApiVersionOptions
12
- & EventTemplates.IUpdateEventTemplateBody;
13
- export type DeleteEventTemplateOptions = ApiVersionOptions
14
- & NoAccountId<EventTemplates.IDeleteEventTemplateQuery>;
15
- export type EventTemplate = EventTemplates.IEventTemplate;
5
+ /* eslint-disable @typescript-eslint/no-empty-object-type */
6
+ export interface EventTemplateContent extends EventTemplates.IEventTemplateContent {}
7
+ export interface EventTemplate extends EventTemplates.IEventTemplate {
8
+ template: EventTemplateContent;
9
+ }
10
+
11
+ export interface GetEventTemplatesOptions extends ApiVersionOptions,
12
+ NoAccountId<EventTemplates.IGetEventTemplatesQuery> {}
13
+
14
+ export interface GetEventTemplatesResponse extends EventTemplates.IGetEventTemplatesResponse {
15
+ data: EventTemplate[];
16
+ }
17
+
18
+ export interface CreateEventTemplateOptions extends ApiVersionOptions,
19
+ EventTemplates.ICreateEventTemplateBody {
20
+ template: EventTemplateContent;
21
+ }
22
+
23
+ export interface UpdateEventTemplateOptions extends ApiVersionOptions,
24
+ EventTemplates.IUpdateEventTemplateBody {
25
+ template?: EventTemplateContent;
26
+ }
27
+
28
+ export interface DeleteEventTemplateOptions extends ApiVersionOptions,
29
+ NoAccountId<EventTemplates.IDeleteEventTemplateQuery> {}
30
+
@@ -2,34 +2,76 @@ import { Filters } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type FilterV1 = Filters.IFilter;
7
- export type Filter = Filters.Filter;
5
+ /* eslint-disable @typescript-eslint/no-empty-object-type */
6
+ export interface FilterV1 extends Filters.IFilter {}
7
+ export interface Filter extends Filters.Filter {}
8
+ export interface UpdateFilterBodyV1 extends Filters.IUpdateFilterBody {}
9
+ export interface UpdateFilterBody extends Filters.UpdateFilterBody {}
8
10
 
9
11
  export type NoFilterVersion<T> = Omit<T, 'version'>;
10
- export type FilterVersion = { filterVersion?: number; };
12
+ export interface FilterVersion {
13
+ filterVersion?: number;
14
+ }
11
15
 
12
- export type GetFiltersOptionsV1 = { version?: 1 | '1'; } & NoAccountId<Filters.IGetFiltersQuery>;
13
- export type GetFiltersOptions = ApiVersionOptions
14
- & NoAccountId<Filters.GetFiltersQuery>;
16
+ export interface GetFiltersOptionsV1 extends NoAccountId<Filters.IGetFiltersQuery> {
17
+ version?: 1 | '1';
18
+ }
15
19
 
16
- export type GetFiltersResponseV1 = Filters.IGetFiltersResponse;
17
- export type GetFiltersResponse = Filters.GetFiltersResponse;
20
+ export interface GetFiltersOptions extends ApiVersionOptions,
21
+ NoAccountId<Filters.GetFiltersQuery> {}
18
22
 
19
- export type CreateFilterOptionsV1 = { version?: 1 | '1'; } & NoAccountId<Filters.ICreateFilterQuery> & Filters.ICreateFilterBody;
20
- export type CreateFilterOptions = ApiVersionOptions & NoAccountId<Filters.CreateFilterQuery> & NoFilterVersion<Filters.CreateFilterBody> & FilterVersion;
23
+ export interface GetFiltersResponseV1 extends Filters.IGetFiltersResponse {
24
+ data: FilterV1[];
25
+ }
26
+ export interface GetFiltersResponse extends Filters.GetFiltersResponse {
27
+ data: Filter[];
28
+ }
21
29
 
22
- export type UpdateFilterOptionsV1 = { version?: 1 | '1'; } & Filters.IUpdateFilterBody;
23
- export type UpdateFilterOptions = ApiVersionOptions & NoFilterVersion<Filters.UpdateFilterBody> & FilterVersion;
30
+ export interface CreateFilterOptionsV1 extends NoAccountId<Filters.ICreateFilterQuery>,
31
+ Filters.ICreateFilterBody {
32
+ version?: 1 | '1';
33
+ }
24
34
 
25
- export type BulkGetFiltersOptionsV1 = { version?: 1 | '1'; };
26
- export type BulkGetFiltersOptions = ApiVersionOptions & Filters.BulkGetFiltersQuery;
35
+ export interface CreateFilterOptions extends ApiVersionOptions,
36
+ NoAccountId<Filters.CreateFilterQuery>,
37
+ NoFilterVersion<Filters.CreateFilterBody>,
38
+ FilterVersion {}
27
39
 
28
- export type BulkUpdateFiltersOptionsV1 = { version?: 1 | '1'; } & Filters.IBulkUpdateFiltersBody;
29
- export type BulkUpdateFiltersOptions = ApiVersionOptions & Filters.BulkUpdateFiltersBody;
40
+ export interface UpdateFilterOptionsV1 extends Filters.IUpdateFilterBody {
41
+ version?: 1 | '1';
42
+ }
30
43
 
31
- export type BulkUpdateFiltersResponseV1 = Filters.IBulkUpdateFiltersResponse;
32
- export type BulkUpdateFiltersResponse = Filters.BulkUpdateFiltersResponse;
44
+ export interface UpdateFilterOptions extends ApiVersionOptions,
45
+ NoFilterVersion<UpdateFilterBody>,
46
+ FilterVersion {}
33
47
 
34
- export type DeleteFilterOptionsV1 = { version?: 1 | '1'; } & NoAccountId<Filters.IDeleteFilterQuery>;
35
- export type DeleteFilterOptions = ApiVersionOptions & NoAccountId<Filters.DeleteFilterQuery>;
48
+ export interface BulkGetFiltersOptionsV1 extends Filters.BulkGetFiltersQuery {
49
+ version?: 1 | '1';
50
+ }
51
+
52
+ export interface BulkGetFiltersOptions extends ApiVersionOptions,
53
+ Filters.BulkGetFiltersQuery {}
54
+
55
+ export interface BulkUpdateFiltersOptionsV1 extends Filters.IBulkUpdateFiltersBody {
56
+ version?: 1 | '1';
57
+ filters: UpdateFilterBodyV1[];
58
+ }
59
+
60
+ export interface BulkUpdateFiltersOptions extends ApiVersionOptions,
61
+ Filters.BulkUpdateFiltersBody {
62
+ filters: UpdateFilterBody[];
63
+ }
64
+
65
+ export interface BulkUpdateFiltersResponseV1 extends Filters.IBulkUpdateFiltersResponse {
66
+ data: FilterV1[];
67
+ }
68
+ export interface BulkUpdateFiltersResponse extends Filters.BulkUpdateFiltersResponse {
69
+ data: Filter[];
70
+ }
71
+
72
+ export interface DeleteFilterOptionsV1 extends NoAccountId<Filters.IDeleteFilterQuery> {
73
+ version?: 1 | '1';
74
+ }
75
+
76
+ export interface DeleteFilterOptions extends ApiVersionOptions,
77
+ NoAccountId<Filters.DeleteFilterQuery> {}
@@ -1,4 +1,4 @@
1
1
  import { Helpers } from '@onereach/types-hitl-api';
2
2
 
3
- /* eslint-disable @typescript-eslint/indent */
4
- export type CleanUpDuplicatesResponse = Helpers.ICleanUpDuplicatesResponse;
3
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
4
+ export interface CleanUpDuplicatesResponse extends Helpers.ICleanUpDuplicatesResponse {}
@@ -2,28 +2,36 @@ import { Listeners } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type Listener = Listeners.IListener;
7
-
8
- export type GetListenersOptions = ApiVersionOptions
9
- & NoAccountId<Listeners.IGetListenersQuery>;
10
- export type GetListenersResponse
11
- = Listeners.IGetListenersResponse;
12
-
13
- export type GetListenerByIdOptions = ApiVersionOptions
14
- & Listeners.ICallbackId
15
- & NoAccountId<Listeners.IGetListenersQuery>;
16
-
17
- export type CreateListenersOptions = ApiVersionOptions
18
- & NoAccountId<Listeners.ICreateListenerQuery>
19
- & Listeners.ICreateListenerBody;
20
-
21
- export type UpdateListenersOptions = ApiVersionOptions
22
- & Listeners.ICallbackId
23
- & Listeners.IUpdateListenerBody;
24
-
25
- export type DeleteListenersOptions = ApiVersionOptions
26
- & Listeners.ICallbackId;
27
-
28
- const CALLBACK_TYPE = Listeners.CALLBACK_TYPE;
29
- export { CALLBACK_TYPE };
5
+ export type NoListenerVersion<T> = Omit<T, 'version'>;
6
+ export interface ListenerVersion {
7
+ listenerVersion?: number;
8
+ }
9
+
10
+ /* eslint-disable @typescript-eslint/no-empty-object-type */
11
+ export const { CALLBACK_TYPE } = Listeners;
12
+ export interface ListenerCallback extends Listeners.IListenerCallback {}
13
+ export interface Listener extends Listeners.IListener {
14
+ callback: ListenerCallback;
15
+ type: typeof CALLBACK_TYPE[keyof typeof CALLBACK_TYPE];
16
+ }
17
+
18
+ export interface GetListenersOptions extends ApiVersionOptions,
19
+ NoAccountId<Listeners.IGetListenersQuery> {}
20
+
21
+ export interface GetListenersResponse extends Listeners.IGetListenersResponse {}
22
+
23
+ export interface GetListenerByIdOptions extends ApiVersionOptions,
24
+ Listeners.ICallbackId,
25
+ NoAccountId<Listeners.IGetListenersQuery> {}
26
+
27
+ export interface CreateListenersOptions extends ApiVersionOptions,
28
+ NoAccountId<Listeners.ICreateListenerQuery>,
29
+ NoListenerVersion<Listeners.ICreateListenerBody>,
30
+ ListenerVersion {}
31
+
32
+ export interface UpdateListenersOptions extends ApiVersionOptions,
33
+ Listeners.ICallbackId,
34
+ Listeners.IUpdateListenerBody {}
35
+
36
+ export interface DeleteListenersOptions extends ApiVersionOptions,
37
+ Listeners.ICallbackId {}
@@ -2,17 +2,42 @@ import { Migrations, DEFAULT_DATA_TABLE_NAME } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- export type GetMigrationsOptions = ApiVersionOptions & NoAccountId<Migrations.IGetMigrationsQuery>;
6
- export type GetMigrationsResponse = Migrations.IGetMigrationsResponse;
7
- export type RunMigrationsOptions = ApiVersionOptions & NoAccountId<Migrations.IRunMigrationsQuery>;
8
- export type RunMigrationsResponse = Migrations.IMigrationResult;
9
- export type GetRunMigrationsStatusResponse = Migrations.IGetRunMigrationsStatusResponse;
10
- export type Migration = Migrations.IMigration;
11
- export type GetMigrationsInfoResponse = Migrations.IGetMigrationsInfoResponse;
12
- export type GetDefaultRecordsOptions = ApiVersionOptions & Migrations.IGetDefaultRecordsQuery;
13
- export type GetDefaultRecordsResponse = Migrations.IGetDefaultRecordsResponse;
14
- export type CreateDefaultRecordsResponse = Migrations.ICreateDefaultRecordsResponse;
15
- export type SyncDefaultRecordsOptions = ApiVersionOptions & NoAccountId<Migrations.ISyncDefaultRecordsQuery>;
16
- export type SyncDefaultRecordsResponse = Migrations.ISyncDefaultRecordsResponse;
5
+ /* eslint-disable @typescript-eslint/no-empty-object-type */
6
+ export interface Migration extends Migrations.IMigration {}
7
+
8
+ export interface GetMigrationsOptions extends ApiVersionOptions,
9
+ NoAccountId<Migrations.IGetMigrationsQuery> {}
10
+
11
+ export interface GetMigrationsResponse extends Migrations.IGetMigrationsResponse {
12
+ executed: Migration[];
13
+ pending: Migration[];
14
+ }
15
+
16
+ export interface RunMigrationsOptions extends ApiVersionOptions,
17
+ NoAccountId<Migrations.IRunMigrationsQuery> {}
18
+
19
+ export interface RunMigrationsResponse extends Migrations.IMigrationResult {
20
+ migrations: Migration[];
21
+ }
22
+
23
+ export interface GetRunMigrationsStatusResponse extends Migrations.ISequelizeLock {}
24
+
25
+ export interface GetMigrationsInfoResponse extends Migrations.IGetMigrationsInfoResponse {}
26
+
27
+ export interface GetDefaultRecordsOptions extends ApiVersionOptions,
28
+ Migrations.IGetDefaultRecordsQuery {
29
+ tableName: DEFAULT_DATA_TABLE_NAME;
30
+ }
31
+
32
+ export interface GetDefaultRecordsResponse extends Migrations.IGetDefaultRecordsResponse {}
33
+
34
+ export interface CreateDefaultRecordsResponse extends Migrations.ICreateDefaultRecordsResponse {}
35
+
36
+ export interface SyncDefaultRecordsOptions extends ApiVersionOptions,
37
+ NoAccountId<Migrations.ISyncDefaultRecordsQuery> {
38
+ tableName: DEFAULT_DATA_TABLE_NAME;
39
+ }
40
+
41
+ export interface SyncDefaultRecordsResponse extends Migrations.ISyncDefaultRecordsResponse {}
17
42
 
18
43
  export { DEFAULT_DATA_TABLE_NAME };
@@ -2,15 +2,15 @@ import { ReadEvents } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type ReadEvent = ReadEvents.IReadEvent;
5
+ /* eslint-disable @typescript-eslint/no-empty-object-type */
6
+ export interface ReadEvent extends ReadEvents.IReadEvent {}
7
7
 
8
- export type GetNewEventsCountOptions = ApiVersionOptions
9
- & NoAccountId<ReadEvents.IGetNewEventsCountQuery>
10
- & ReadEvents.IGetNewEventsCountBody;
11
- export type GetNewEventsCountResponse
12
- = ReadEvents.IGetNewEventsCountResponse;
8
+ export interface GetNewEventsCountOptions extends ApiVersionOptions,
9
+ NoAccountId<ReadEvents.IGetNewEventsCountQuery>,
10
+ ReadEvents.IGetNewEventsCountBody {}
13
11
 
14
- export type SaveLastReadEventOptions = ApiVersionOptions
15
- & NoAccountId<ReadEvents.ISaveLastReadEventQuery>
16
- & ReadEvents.ISaveLastReadEventBody;
12
+ export interface GetNewEventsCountResponse extends ReadEvents.IGetNewEventsCountResponse {}
13
+
14
+ export interface SaveLastReadEventOptions extends ApiVersionOptions,
15
+ NoAccountId<ReadEvents.ISaveLastReadEventQuery>,
16
+ ReadEvents.ISaveLastReadEventBody {}
@@ -2,16 +2,22 @@ import { RuleGroups } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type SearchRuleGroupsOptions = ApiVersionOptions
7
- & NoAccountId<RuleGroups.ISearchRuleGroupsQuery>
8
- & RuleGroups.ISearchRuleGroupsBody;
9
- export type SearchRuleGroupsResponse = RuleGroups.ISearchRuleGroupsResponse;
10
- export type RuleGroup = RuleGroups.IRuleGroup;
5
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
6
+ export interface RuleGroup extends RuleGroups.IRuleGroup {}
11
7
 
12
- export type CreateRuleGroupOptions = ApiVersionOptions
13
- & RuleGroups.ICreateRuleGroupBody;
14
- export type UpdateRuleGroupOptions = ApiVersionOptions
15
- & RuleGroups.IUpdateRuleGroupBody;
16
- export type DeleteRuleGroupOptions = ApiVersionOptions
17
- & NoAccountId<RuleGroups.IDeleteRuleGroupQuery>;
8
+ export interface SearchRuleGroupsOptions extends ApiVersionOptions,
9
+ NoAccountId<RuleGroups.ISearchRuleGroupsQuery>,
10
+ RuleGroups.ISearchRuleGroupsBody {}
11
+
12
+ export interface SearchRuleGroupsResponse extends RuleGroups.ISearchRuleGroupsResponse {
13
+ data: RuleGroup[];
14
+ }
15
+
16
+ export interface CreateRuleGroupOptions extends ApiVersionOptions,
17
+ RuleGroups.ICreateRuleGroupBody {}
18
+
19
+ export interface UpdateRuleGroupOptions extends ApiVersionOptions,
20
+ RuleGroups.IUpdateRuleGroupBody {}
21
+
22
+ export interface DeleteRuleGroupOptions extends ApiVersionOptions,
23
+ NoAccountId<RuleGroups.IDeleteRuleGroupQuery> {}
@@ -2,20 +2,36 @@ import { SessionEvents, IDateToString } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- /* eslint-disable @typescript-eslint/indent */
6
- export type SessionEvent = IDateToString<SessionEvents.ISessionEvent>;
7
-
8
- export type GetSessionEventsOptions = ApiVersionOptions
9
- & NoAccountId<SessionEvents.IGetSessionEventsQuery>;
10
- export type GetSessionEventsResponse
11
- = SessionEvents.IGetSessionEventsResponse;
12
-
13
- export type GetBulkSessionEventsOptions = ApiVersionOptions
14
- & NoAccountId<SessionEvents.IGetBulkSessionEventsQuery>;
15
- export type GetBulkSessionsEventsResponse
16
- = SessionEvents.IGetBulkSessionEventsResponse;
17
-
18
- export type AddEventsOptions = ApiVersionOptions
19
- & NoAccountId<SessionEvents.IAddEventsBySessionIdQuery>
20
- & SessionEvents.IAddEventsBySessionIdBody;
21
- export type AddEventsResponse = SessionEvents.IAddEventsBySessionIdResponse;
5
+ /* eslint-disable @typescript-eslint/no-empty-object-type */
6
+ export interface SessionEvent extends IDateToString<SessionEvents.ISessionEvent> {}
7
+
8
+ export interface GetSessionEventsOptions extends ApiVersionOptions,
9
+ NoAccountId<SessionEvents.IGetSessionEventsQuery> {}
10
+
11
+ export interface GetSessionEventsResponse
12
+ // extends SessionEvents.IGetSessionEventsResponse
13
+ {
14
+ data: SessionEvent[];
15
+ }
16
+
17
+ export interface GetBulkSessionEventsOptions extends ApiVersionOptions,
18
+ NoAccountId<SessionEvents.IGetBulkSessionEventsQuery> {}
19
+
20
+ export interface GetBulkSessionsEventsResponse
21
+ // extends SessionEvents.IGetBulkSessionEventsResponse
22
+ {
23
+ data: Record<string, SessionEvent[]>;
24
+ }
25
+
26
+ export interface AddEventsOptions extends ApiVersionOptions,
27
+ NoAccountId<SessionEvents.IAddEventsBySessionIdQuery>
28
+ // SessionEvents.IAddEventsBySessionIdBody
29
+ {
30
+ events: Partial<SessionEvent>[];
31
+ }
32
+
33
+ export interface AddEventsResponse
34
+ // extends SessionEvents.IAddEventsBySessionIdResponse
35
+ {
36
+ data: SessionEvent[];
37
+ }
@@ -2,18 +2,27 @@ import { SessionRelations } from '@onereach/types-hitl-api';
2
2
 
3
3
  import { ApiVersionOptions, NoAccountId } from './common';
4
4
 
5
- export type SessionRelation = SessionRelations.SessionRelation;
5
+ /* eslint-disable @typescript-eslint/no-empty-object-type */
6
+ export interface SessionRelation extends SessionRelations.SessionRelation {}
7
+ export interface SessionRelationsWithSessions extends SessionRelations.SessionRelationsWithSessions {}
6
8
 
7
- /* eslint-disable @typescript-eslint/indent */
8
- export type GetSessionRelationsOptions = ApiVersionOptions
9
- & NoAccountId<SessionRelations.GetSessionRelationsQuery>;
9
+ export interface GetSessionRelationsOptions extends ApiVersionOptions,
10
+ NoAccountId<SessionRelations.GetSessionRelationsQuery> {}
10
11
 
11
- export type GetSessionRelationsResponse = SessionRelations.GetSessionRelationsResponse;
12
+ export interface GetSessionRelationsResponse extends SessionRelations.GetSessionRelationsResponse {
13
+ data: SessionRelationsWithSessions;
14
+ }
12
15
 
13
- export type CreateSessionRelationsOptions = ApiVersionOptions
14
- & SessionRelations.CreateSessionRelationsBody;
16
+ export interface CreateSessionRelationsOptions extends ApiVersionOptions,
17
+ SessionRelations.CreateSessionRelationsBody {
18
+ relations: SessionRelation[];
19
+ }
15
20
 
16
- export type CreateSessionRelationsResponse = SessionRelations.CreateSessionRelationsResponse;
21
+ export interface CreateSessionRelationsResponse extends SessionRelations.CreateSessionRelationsResponse {
22
+ relations: SessionRelation[];
23
+ }
17
24
 
18
- export type DeleteSessionRelationsOptions = ApiVersionOptions
19
- & SessionRelations.DeleteSessionRelationsBody;
25
+ export interface DeleteSessionRelationsOptions extends ApiVersionOptions,
26
+ SessionRelations.DeleteSessionRelationsBody {
27
+ relations: SessionRelation[];
28
+ }