@compassdigital/sdk.typescript 4.67.0 → 4.68.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 (87) hide show
  1. package/lib/index.d.ts +58 -57
  2. package/lib/index.d.ts.map +1 -1
  3. package/lib/index.js +503 -501
  4. package/lib/index.js.map +1 -1
  5. package/lib/interface/ai.d.ts +1 -1
  6. package/lib/interface/ai.d.ts.map +1 -1
  7. package/lib/interface/announcement.d.ts +1 -1
  8. package/lib/interface/announcement.d.ts.map +1 -1
  9. package/lib/interface/auth.d.ts +3 -3
  10. package/lib/interface/auth.d.ts.map +1 -1
  11. package/lib/interface/calendar.d.ts +2 -2
  12. package/lib/interface/calendar.d.ts.map +1 -1
  13. package/lib/interface/centricos.d.ts +11 -11
  14. package/lib/interface/centricos.d.ts.map +1 -1
  15. package/lib/interface/compassconnect.d.ts +1 -1
  16. package/lib/interface/compassconnect.d.ts.map +1 -1
  17. package/lib/interface/config.d.ts +1 -1
  18. package/lib/interface/config.d.ts.map +1 -1
  19. package/lib/interface/datalake.d.ts +1 -1
  20. package/lib/interface/datalake.d.ts.map +1 -1
  21. package/lib/interface/email.d.ts +1 -1
  22. package/lib/interface/email.d.ts.map +1 -1
  23. package/lib/interface/file.d.ts +2 -2
  24. package/lib/interface/file.d.ts.map +1 -1
  25. package/lib/interface/frictionless.d.ts +9 -9
  26. package/lib/interface/frictionless.d.ts.map +1 -1
  27. package/lib/interface/kds.d.ts +1 -1
  28. package/lib/interface/kds.d.ts.map +1 -1
  29. package/lib/interface/location.d.ts +5 -3
  30. package/lib/interface/location.d.ts.map +1 -1
  31. package/lib/interface/mealplan.d.ts +2 -1
  32. package/lib/interface/mealplan.d.ts.map +1 -1
  33. package/lib/interface/menu.d.ts +149 -109
  34. package/lib/interface/menu.d.ts.map +1 -1
  35. package/lib/interface/notification.d.ts +3 -3
  36. package/lib/interface/notification.d.ts.map +1 -1
  37. package/lib/interface/order.d.ts +7 -7
  38. package/lib/interface/order.d.ts.map +1 -1
  39. package/lib/interface/partner.d.ts +10 -10
  40. package/lib/interface/partner.d.ts.map +1 -1
  41. package/lib/interface/payment.d.ts +3 -3
  42. package/lib/interface/payment.d.ts.map +1 -1
  43. package/lib/interface/promo.d.ts +8 -8
  44. package/lib/interface/promo.d.ts.map +1 -1
  45. package/lib/interface/report.d.ts +10 -10
  46. package/lib/interface/report.d.ts.map +1 -1
  47. package/lib/interface/search.d.ts +8 -8
  48. package/lib/interface/search.d.ts.map +1 -1
  49. package/lib/interface/shoppingcart.d.ts +7 -7
  50. package/lib/interface/shoppingcart.d.ts.map +1 -1
  51. package/lib/interface/task.d.ts +8 -8
  52. package/lib/interface/task.d.ts.map +1 -1
  53. package/lib/interface/tax.d.ts +2 -2
  54. package/lib/interface/tax.d.ts.map +1 -1
  55. package/lib/interface/user.d.ts +16 -16
  56. package/lib/interface/user.d.ts.map +1 -1
  57. package/lib/interface/vendor.d.ts +6 -6
  58. package/lib/interface/vendor.d.ts.map +1 -1
  59. package/package.json +1 -1
  60. package/src/index.ts +10395 -10394
  61. package/src/interface/ai.ts +22 -22
  62. package/src/interface/announcement.ts +60 -60
  63. package/src/interface/auth.ts +68 -68
  64. package/src/interface/calendar.ts +94 -94
  65. package/src/interface/centricos.ts +145 -145
  66. package/src/interface/compassconnect.ts +59 -59
  67. package/src/interface/config.ts +166 -166
  68. package/src/interface/datalake.ts +13 -13
  69. package/src/interface/email.ts +13 -13
  70. package/src/interface/file.ts +18 -18
  71. package/src/interface/frictionless.ts +177 -177
  72. package/src/interface/kds.ts +49 -49
  73. package/src/interface/location.ts +771 -769
  74. package/src/interface/mealplan.ts +155 -154
  75. package/src/interface/menu.ts +4079 -4018
  76. package/src/interface/notification.ts +51 -51
  77. package/src/interface/order.ts +464 -464
  78. package/src/interface/partner.ts +823 -823
  79. package/src/interface/payment.ts +278 -278
  80. package/src/interface/promo.ts +373 -373
  81. package/src/interface/report.ts +348 -348
  82. package/src/interface/search.ts +135 -135
  83. package/src/interface/shoppingcart.ts +429 -429
  84. package/src/interface/task.ts +212 -212
  85. package/src/interface/tax.ts +69 -69
  86. package/src/interface/user.ts +410 -410
  87. package/src/interface/vendor.ts +215 -215
@@ -1,54 +1,54 @@
1
1
  /* eslint-disable */
2
2
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
3
 
4
- import { RequestQuery, BaseRequest } from "./util";
4
+ import { RequestQuery, BaseRequest } from './util';
5
5
 
6
6
  export interface OptionsDTO {
7
- temperature?: number;
8
- max_tokens?: number;
7
+ temperature?: number;
8
+ max_tokens?: number;
9
9
  }
10
10
 
11
11
  export interface MessageDTO {
12
- actor: string;
13
- content: string;
12
+ actor: string;
13
+ content: string;
14
14
  }
15
15
 
16
16
  export interface GenerateTextRequest {
17
- options?: OptionsDTO;
18
- messages: MessageDTO[];
17
+ options?: OptionsDTO;
18
+ messages: MessageDTO[];
19
19
  }
20
20
 
21
21
  export interface GenerateTextResponse {
22
- messages: MessageDTO[];
22
+ messages: MessageDTO[];
23
23
  }
24
24
 
25
25
  export interface BadRequestErrorDTO {
26
- message: string;
27
- code: number;
28
- data: Record<string, any>;
26
+ message: string;
27
+ code: number;
28
+ data: Record<string, any>;
29
29
  }
30
30
 
31
31
  export interface UnauthorizedErrorDTO {
32
- message: string;
33
- code: number;
34
- data: Record<string, any>;
32
+ message: string;
33
+ code: number;
34
+ data: Record<string, any>;
35
35
  }
36
36
 
37
37
  export type InternalServerErrorException = Record<string, any>;
38
38
 
39
39
  export interface GenerateImageRequest {
40
- prompt: string;
41
- number_of_images?: number;
42
- negative_prompt?: string;
40
+ prompt: string;
41
+ number_of_images?: number;
42
+ negative_prompt?: string;
43
43
  }
44
44
 
45
45
  export interface ImageDTO {
46
- data: string;
47
- mime_type: string;
46
+ data: string;
47
+ mime_type: string;
48
48
  }
49
49
 
50
50
  export interface GenerateImageResponse {
51
- images: ImageDTO[];
51
+ images: ImageDTO[];
52
52
  }
53
53
 
54
54
  // POST /ai/language/generate - Generate text from a given prompt
@@ -58,7 +58,7 @@ export type PostAiLanguageGenerateBody = GenerateTextRequest;
58
58
  export type PostAiLanguageGenerateResponse = GenerateTextResponse;
59
59
 
60
60
  export interface PostAiLanguageGenerateRequest extends BaseRequest {
61
- body: PostAiLanguageGenerateBody;
61
+ body: PostAiLanguageGenerateBody;
62
62
  }
63
63
 
64
64
  // POST /ai/image/generate - Generate image from a given prompt
@@ -68,5 +68,5 @@ export type PostAiImageGenerateBody = GenerateImageRequest;
68
68
  export type PostAiImageGenerateResponse = GenerateImageResponse;
69
69
 
70
70
  export interface PostAiImageGenerateRequest extends BaseRequest {
71
- body: PostAiImageGenerateBody;
71
+ body: PostAiImageGenerateBody;
72
72
  }
@@ -1,52 +1,52 @@
1
1
  /* eslint-disable */
2
2
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
3
 
4
- import { RequestQuery, BaseRequest } from "./util";
4
+ import { RequestQuery, BaseRequest } from './util';
5
5
 
6
6
  export interface Error {
7
- code?: number;
8
- message?: string;
9
- data?: Record<string, any>;
7
+ code?: number;
8
+ message?: string;
9
+ data?: Record<string, any>;
10
10
  }
11
11
 
12
12
  export interface Success {
13
- success?: boolean;
13
+ success?: boolean;
14
14
  }
15
15
 
16
16
  export interface Announcement {
17
- // announcement
18
- id?: string;
19
- // Name of Announcement
20
- name?: string;
21
- // Announcement Type
22
- type?: string;
23
- key?: string;
24
- // App name
25
- app?: string;
26
- // True if all the sites are linked
27
- is_global?: boolean;
28
- allowed_resources?: string[];
29
- position?: number;
30
- active?: boolean;
31
- // Announcement Properties
32
- info?: {
33
- en?: Announcement_info;
34
- fr?: Announcement_info;
35
- };
36
- date?: Record<string, any>;
37
- [index: string]: any;
17
+ // announcement
18
+ id?: string;
19
+ // Name of Announcement
20
+ name?: string;
21
+ // Announcement Type
22
+ type?: string;
23
+ key?: string;
24
+ // App name
25
+ app?: string;
26
+ // True if all the sites are linked
27
+ is_global?: boolean;
28
+ allowed_resources?: string[];
29
+ position?: number;
30
+ active?: boolean;
31
+ // Announcement Properties
32
+ info?: {
33
+ en?: Announcement_info;
34
+ fr?: Announcement_info;
35
+ };
36
+ date?: Record<string, any>;
37
+ [index: string]: any;
38
38
  }
39
39
 
40
40
  export interface Announcements {
41
- announcements?: Announcement[];
41
+ announcements?: Announcement[];
42
42
  }
43
43
 
44
44
  export interface Announcement_info {
45
- image_url?: string;
46
- title?: string;
47
- description?: string;
48
- sub_text?: string;
49
- button_text?: string;
45
+ image_url?: string;
46
+ title?: string;
47
+ description?: string;
48
+ sub_text?: string;
49
+ button_text?: string;
50
50
  }
51
51
 
52
52
  // POST /announcement - Create Announcement
@@ -56,69 +56,69 @@ export type PostAnnouncementBody = Announcement;
56
56
  export type PostAnnouncementResponse = Announcement;
57
57
 
58
58
  export interface PostAnnouncementRequest extends BaseRequest {
59
- body: PostAnnouncementBody;
59
+ body: PostAnnouncementBody;
60
60
  }
61
61
 
62
62
  // GET /announcement/resource/{id} - Get Announcements
63
63
 
64
64
  export interface GetAnnouncementResourcePath {
65
- // Id of the entity to which announcement is specifically related.
66
- id: string;
65
+ // Id of the entity to which announcement is specifically related.
66
+ id: string;
67
67
  }
68
68
 
69
69
  export interface GetAnnouncementResourceQuery {
70
- // Resource Id linked to announcement
71
- allowed_resource_id?: string;
72
- disabled?: boolean;
73
- // Graphql query string
74
- _query?: string;
70
+ // Resource Id linked to announcement
71
+ allowed_resource_id?: string;
72
+ disabled?: boolean;
73
+ // Graphql query string
74
+ _query?: string;
75
75
  }
76
76
 
77
77
  export type GetAnnouncementResourceResponse = Announcements;
78
78
 
79
79
  export interface GetAnnouncementResourceRequest
80
- extends BaseRequest,
81
- RequestQuery<GetAnnouncementResourceQuery>,
82
- GetAnnouncementResourcePath {}
80
+ extends BaseRequest,
81
+ RequestQuery<GetAnnouncementResourceQuery>,
82
+ GetAnnouncementResourcePath {}
83
83
 
84
84
  // GET /announcement/resource - Get Announcements
85
85
 
86
86
  export interface GetAnnouncementResourcesQuery {
87
- disabled?: boolean;
88
- // Graphql query string
89
- _query?: string;
87
+ disabled?: boolean;
88
+ // Graphql query string
89
+ _query?: string;
90
90
  }
91
91
 
92
92
  export type GetAnnouncementResourcesResponse = Announcements;
93
93
 
94
94
  export interface GetAnnouncementResourcesRequest
95
- extends BaseRequest,
96
- RequestQuery<GetAnnouncementResourcesQuery> {}
95
+ extends BaseRequest,
96
+ RequestQuery<GetAnnouncementResourcesQuery> {}
97
97
 
98
98
  // GET /announcement/{id} - Get Announcement
99
99
 
100
100
  export interface GetAnnouncementPath {
101
- // Id of the entity to which announcement is specifically related.
102
- id: string;
101
+ // Id of the entity to which announcement is specifically related.
102
+ id: string;
103
103
  }
104
104
 
105
105
  export interface GetAnnouncementQuery {
106
- // Graphql query string
107
- _query?: string;
106
+ // Graphql query string
107
+ _query?: string;
108
108
  }
109
109
 
110
110
  export type GetAnnouncementResponse = Announcement;
111
111
 
112
112
  export interface GetAnnouncementRequest
113
- extends BaseRequest,
114
- RequestQuery<GetAnnouncementQuery>,
115
- GetAnnouncementPath {}
113
+ extends BaseRequest,
114
+ RequestQuery<GetAnnouncementQuery>,
115
+ GetAnnouncementPath {}
116
116
 
117
117
  // PUT /announcement/{id} - Update Announcement
118
118
 
119
119
  export interface PutAnnouncementPath {
120
- // Id of the announcement
121
- id: string;
120
+ // Id of the announcement
121
+ id: string;
122
122
  }
123
123
 
124
124
  export type PutAnnouncementBody = Announcement;
@@ -126,14 +126,14 @@ export type PutAnnouncementBody = Announcement;
126
126
  export type PutAnnouncementResponse = Announcement;
127
127
 
128
128
  export interface PutAnnouncementRequest extends BaseRequest, PutAnnouncementPath {
129
- body: PutAnnouncementBody;
129
+ body: PutAnnouncementBody;
130
130
  }
131
131
 
132
132
  // DELETE /announcement/{id} - Delete announcement item
133
133
 
134
134
  export interface DeleteAnnouncementPath {
135
- // Id of the announcement
136
- id: string;
135
+ // Id of the announcement
136
+ id: string;
137
137
  }
138
138
 
139
139
  export type DeleteAnnouncementResponse = Success;
@@ -1,106 +1,106 @@
1
1
  /* eslint-disable */
2
2
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
3
 
4
- import { RequestQuery, BaseRequest } from "./util";
4
+ import { RequestQuery, BaseRequest } from './util';
5
5
 
6
6
  export interface SSOFlowRequestDTO {
7
- email: string;
8
- realm: string;
9
- clientId: string;
7
+ email: string;
8
+ realm: string;
9
+ clientId: string;
10
10
  }
11
11
 
12
12
  export interface OIDC {
13
- authorizationUrl: string;
14
- name: string;
13
+ authorizationUrl: string;
14
+ name: string;
15
15
  }
16
16
 
17
17
  export interface SSOFlowResponseDTO {
18
- flowType: "sso" | "new" | "existing";
19
- oidc?: OIDC;
18
+ flowType: 'sso' | 'new' | 'existing';
19
+ oidc?: OIDC;
20
20
  }
21
21
 
22
22
  export interface SSOMapping {
23
- id: string;
24
- given_name: string;
25
- family_name: string;
26
- email: string;
27
- updated_at: string;
23
+ id: string;
24
+ given_name: string;
25
+ family_name: string;
26
+ email: string;
27
+ updated_at: string;
28
28
  }
29
29
 
30
30
  export interface SSOConfigsResponseDTO {
31
- name: string;
32
- clientId: string;
33
- authorizationEndpoint: string;
34
- tokenEndpoint: string;
35
- userinfoEndpoint: string;
36
- realm: string;
37
- mapping?: SSOMapping;
31
+ name: string;
32
+ clientId: string;
33
+ authorizationEndpoint: string;
34
+ tokenEndpoint: string;
35
+ userinfoEndpoint: string;
36
+ realm: string;
37
+ mapping?: SSOMapping;
38
38
  }
39
39
 
40
40
  export interface SSOConfigRequestDTO {
41
- name: string;
42
- clientId: string;
43
- authorizationEndpoint: string;
44
- clientSecret: string;
45
- tokenEndpoint: string;
46
- userinfoEndpoint: string;
47
- realm: string;
48
- protocol: "OIDC" | "SAML2";
49
- mapping?: SSOMapping;
41
+ name: string;
42
+ clientId: string;
43
+ authorizationEndpoint: string;
44
+ clientSecret: string;
45
+ tokenEndpoint: string;
46
+ userinfoEndpoint: string;
47
+ realm: string;
48
+ protocol: 'OIDC' | 'SAML2';
49
+ mapping?: SSOMapping;
50
50
  }
51
51
 
52
52
  export interface SSOConfigResponseDTO {
53
- success: boolean;
53
+ success: boolean;
54
54
  }
55
55
 
56
56
  export interface SSOAuthRequestDTO {
57
- code: string;
58
- name: string;
59
- clientId: string;
57
+ code: string;
58
+ name: string;
59
+ clientId: string;
60
60
  }
61
61
 
62
62
  export interface Token {
63
- token: string;
64
- expires: string;
63
+ token: string;
64
+ expires: string;
65
65
  }
66
66
 
67
67
  export interface Name {
68
- first: string;
69
- last: string;
68
+ first: string;
69
+ last: string;
70
70
  }
71
71
 
72
72
  export interface Date {
73
- modified: string;
74
- created: string;
73
+ modified: string;
74
+ created: string;
75
75
  }
76
76
 
77
77
  export interface Is {
78
- disabled: boolean;
79
- verified: boolean;
78
+ disabled: boolean;
79
+ verified: boolean;
80
80
  }
81
81
 
82
82
  export interface Profile {
83
- id: string;
84
- email: string;
85
- name?: Name;
86
- date?: Date;
87
- ssoId: string;
88
- is?: Is;
83
+ id: string;
84
+ email: string;
85
+ name?: Name;
86
+ date?: Date;
87
+ ssoId: string;
88
+ is?: Is;
89
89
  }
90
90
 
91
91
  export interface SSOAuthResponseDTO {
92
- access: Token;
93
- profile: Profile;
92
+ access: Token;
93
+ profile: Profile;
94
94
  }
95
95
 
96
96
  export interface SSOExchangeDTO {
97
- token: string;
97
+ token: string;
98
98
  }
99
99
 
100
100
  export interface HttpStandardError {
101
- message: string;
102
- error: string;
103
- statusCode: string;
101
+ message: string;
102
+ error: string;
103
+ statusCode: string;
104
104
  }
105
105
 
106
106
  // POST /auth/flow - Determines the authentication flow for a user based on their email address
@@ -110,21 +110,21 @@ export type PostAuthFlowBody = SSOFlowRequestDTO;
110
110
  export type PostAuthFlowResponse = SSOFlowResponseDTO;
111
111
 
112
112
  export interface PostAuthFlowRequest extends BaseRequest {
113
- body: PostAuthFlowBody;
113
+ body: PostAuthFlowBody;
114
114
  }
115
115
 
116
116
  // GET /auth/sso-configs - Returns all available SSO configurations
117
117
 
118
118
  export interface GetAuthSsoConfigsQuery {
119
- // Graphql query string
120
- _query?: string;
119
+ // Graphql query string
120
+ _query?: string;
121
121
  }
122
122
 
123
123
  export type GetAuthSsoConfigsResponse = SSOConfigsResponseDTO[];
124
124
 
125
125
  export interface GetAuthSsoConfigsRequest
126
- extends BaseRequest,
127
- RequestQuery<GetAuthSsoConfigsQuery> {}
126
+ extends BaseRequest,
127
+ RequestQuery<GetAuthSsoConfigsQuery> {}
128
128
 
129
129
  // POST /auth/sso-config - Create a new SSO configuration
130
130
 
@@ -133,14 +133,14 @@ export type PostAuthSsoConfigBody = SSOConfigRequestDTO;
133
133
  export type PostAuthSsoConfigResponse = SSOConfigResponseDTO;
134
134
 
135
135
  export interface PostAuthSsoConfigRequest extends BaseRequest {
136
- body: PostAuthSsoConfigBody;
136
+ body: PostAuthSsoConfigBody;
137
137
  }
138
138
 
139
139
  // DELETE /auth/sso-config/{name}/{clientId} - Delete a SSO configuration
140
140
 
141
141
  export interface DeleteAuthSsoConfigPath {
142
- name: string;
143
- clientId: string;
142
+ name: string;
143
+ clientId: string;
144
144
  }
145
145
 
146
146
  export type DeleteAuthSsoConfigResponse = SSOConfigResponseDTO;
@@ -154,7 +154,7 @@ export type PostAuthSsoBody = SSOAuthRequestDTO;
154
154
  export type PostAuthSsoResponse = SSOAuthResponseDTO;
155
155
 
156
156
  export interface PostAuthSsoRequest extends BaseRequest {
157
- body: PostAuthSsoBody;
157
+ body: PostAuthSsoBody;
158
158
  }
159
159
 
160
160
  // POST /auth/sso/exchange - exchange idP information for short lived exchange token
@@ -165,19 +165,19 @@ export type PostAuthSsoExchangeBody = SSOAuthRequestDTO;
165
165
  export type PostAuthSsoExchangeResponse = SSOExchangeDTO;
166
166
 
167
167
  export interface PostAuthSsoExchangeRequest extends BaseRequest {
168
- body: PostAuthSsoExchangeBody;
168
+ body: PostAuthSsoExchangeBody;
169
169
  }
170
170
 
171
171
  // GET /auth/sso/exchange - Exchange short lived JWT for access & refresh
172
172
 
173
173
  export interface GetAuthSsoExchangeQuery {
174
- token: string;
175
- // Graphql query string
176
- _query?: string;
174
+ token: string;
175
+ // Graphql query string
176
+ _query?: string;
177
177
  }
178
178
 
179
179
  export type GetAuthSsoExchangeResponse = SSOAuthResponseDTO;
180
180
 
181
181
  export interface GetAuthSsoExchangeRequest
182
- extends BaseRequest,
183
- RequestQuery<GetAuthSsoExchangeQuery> {}
182
+ extends BaseRequest,
183
+ RequestQuery<GetAuthSsoExchangeQuery> {}