@qlik/api 0.0.1 → 0.0.3

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 (156) hide show
  1. package/.github/CODEOWNERS +2 -0
  2. package/.github/workflows/release.yaml +35 -0
  3. package/README.md +1 -3
  4. package/api-keys.d.mts +27 -13
  5. package/api-keys.d.ts +27 -13
  6. package/api-keys.js +17 -13
  7. package/api-keys.mjs +12 -8
  8. package/apps.d.mts +580 -165
  9. package/apps.d.ts +580 -165
  10. package/apps.js +111 -44
  11. package/apps.mjs +78 -11
  12. package/audits.d.mts +20 -8
  13. package/audits.d.ts +20 -8
  14. package/audits.js +12 -11
  15. package/audits.mjs +7 -6
  16. package/auth-AWZV4DPP.js +41 -0
  17. package/{auth-TE272Q34.mjs → auth-CPBNNC7S.mjs} +8 -3
  18. package/auth.js +4 -3
  19. package/auth.mjs +3 -2
  20. package/automations.d.mts +56 -20
  21. package/automations.d.ts +56 -20
  22. package/automations.js +32 -25
  23. package/automations.mjs +18 -11
  24. package/brands.d.mts +45 -4
  25. package/brands.d.ts +45 -4
  26. package/brands.js +20 -15
  27. package/brands.mjs +7 -2
  28. package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
  29. package/{chunk-WM7FQU2U.mjs → chunk-3SVRHJII.mjs} +3 -3
  30. package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
  31. package/{chunk-4ES65KO3.js → chunk-7RY3NO6N.js} +2 -2
  32. package/{chunk-4OMEH5SW.mjs → chunk-CYRLVHU3.mjs} +321 -53
  33. package/{chunk-XASXL2NC.js → chunk-D52VW5UN.js} +323 -55
  34. package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
  35. package/{chunk-4FLMND6T.js → chunk-GV5SRHY2.js} +4 -4
  36. package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
  37. package/chunk-P57PW2II.js +11 -0
  38. package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
  39. package/chunk-ZFXKCRJC.mjs +11 -0
  40. package/collections.d.mts +52 -18
  41. package/collections.d.ts +52 -18
  42. package/collections.js +28 -14
  43. package/collections.mjs +16 -2
  44. package/csp-origins.d.mts +12 -0
  45. package/csp-origins.d.ts +12 -0
  46. package/csp-origins.js +12 -9
  47. package/csp-origins.mjs +5 -2
  48. package/data-assets.d.mts +10 -0
  49. package/data-assets.d.ts +10 -0
  50. package/data-assets.js +13 -8
  51. package/data-assets.mjs +7 -2
  52. package/data-connections.d.mts +20 -0
  53. package/data-connections.d.ts +20 -0
  54. package/data-connections.js +19 -12
  55. package/data-connections.mjs +9 -2
  56. package/data-credentials.d.mts +10 -0
  57. package/data-credentials.d.ts +10 -0
  58. package/data-credentials.js +10 -7
  59. package/data-credentials.mjs +5 -2
  60. package/data-files.d.mts +114 -29
  61. package/data-files.d.ts +114 -29
  62. package/data-files.js +25 -18
  63. package/data-files.mjs +15 -8
  64. package/{enigma-session-TEB53FAF.js → enigma-session-XPXDQAIV.js} +12 -7
  65. package/{enigma-session-4L373ALV.mjs → enigma-session-ZH6MYA54.mjs} +10 -5
  66. package/{esm-4X3DKK5D.js → esm-3VXX2GKL.js} +13 -9
  67. package/{esm-SOWVJKOQ.mjs → esm-OY4XVIJB.mjs} +13 -9
  68. package/extensions.d.mts +26 -2
  69. package/extensions.d.ts +26 -2
  70. package/extensions.js +13 -10
  71. package/extensions.mjs +5 -2
  72. package/glossaries.d.mts +55 -20
  73. package/glossaries.d.ts +55 -20
  74. package/glossaries.js +39 -27
  75. package/glossaries.mjs +14 -2
  76. package/groups.d.mts +29 -13
  77. package/groups.d.ts +29 -13
  78. package/groups.js +19 -14
  79. package/groups.mjs +13 -8
  80. package/identity-providers.d.mts +23 -7
  81. package/identity-providers.d.ts +23 -7
  82. package/identity-providers.js +16 -13
  83. package/identity-providers.mjs +8 -5
  84. package/index.js +150 -112
  85. package/index.mjs +146 -108
  86. package/{invoke-fetch-MSSJAZ7K.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
  87. package/invoke-fetch-UNTAUR7O.js +17 -0
  88. package/items.d.mts +25 -22
  89. package/items.d.ts +25 -22
  90. package/items.js +17 -14
  91. package/items.mjs +11 -8
  92. package/licenses.d.mts +20 -0
  93. package/licenses.d.ts +20 -0
  94. package/licenses.js +17 -12
  95. package/licenses.mjs +7 -2
  96. package/package.json +7 -18
  97. package/{qix-RLTISYTB.js → qix-UNWXPGMA.js} +9 -8
  98. package/{qix-EU7PXRZ6.mjs → qix-ZSJ4PIK3.mjs} +5 -4
  99. package/qix.d.mts +1066 -1017
  100. package/qix.d.ts +1066 -1017
  101. package/qix.js +4 -3
  102. package/qix.mjs +3 -2
  103. package/quotas.d.mts +4 -0
  104. package/quotas.d.ts +4 -0
  105. package/quotas.js +6 -5
  106. package/quotas.mjs +3 -2
  107. package/reload-tasks.d.mts +2 -0
  108. package/reload-tasks.d.ts +2 -0
  109. package/reload-tasks.js +11 -8
  110. package/reload-tasks.mjs +5 -2
  111. package/reloads.d.mts +20 -11
  112. package/reloads.d.ts +20 -11
  113. package/reloads.js +9 -7
  114. package/reloads.mjs +4 -2
  115. package/roles.d.mts +4 -0
  116. package/roles.d.ts +4 -0
  117. package/roles.js +6 -5
  118. package/roles.mjs +3 -2
  119. package/spaces.d.mts +36 -30
  120. package/spaces.d.ts +36 -30
  121. package/spaces.js +21 -15
  122. package/spaces.mjs +8 -2
  123. package/temp-contents.d.mts +9 -70
  124. package/temp-contents.d.ts +9 -70
  125. package/temp-contents.js +10 -29
  126. package/temp-contents.mjs +5 -24
  127. package/tenants.d.mts +12 -0
  128. package/tenants.d.ts +12 -0
  129. package/tenants.js +14 -9
  130. package/tenants.mjs +7 -2
  131. package/themes.d.mts +26 -2
  132. package/themes.d.ts +26 -2
  133. package/themes.js +13 -10
  134. package/themes.mjs +5 -2
  135. package/transports.d.mts +12 -0
  136. package/transports.d.ts +12 -0
  137. package/transports.js +12 -9
  138. package/transports.mjs +5 -2
  139. package/users.d.mts +48 -29
  140. package/users.d.ts +48 -29
  141. package/users.js +18 -13
  142. package/users.mjs +7 -2
  143. package/web-integrations.d.mts +10 -0
  144. package/web-integrations.d.ts +10 -0
  145. package/web-integrations.js +11 -8
  146. package/web-integrations.mjs +5 -2
  147. package/web-notifications.d.mts +12 -0
  148. package/web-notifications.d.ts +12 -0
  149. package/web-notifications.js +12 -9
  150. package/web-notifications.mjs +5 -2
  151. package/webhooks.d.mts +27 -7
  152. package/webhooks.d.ts +27 -7
  153. package/webhooks.js +17 -13
  154. package/webhooks.mjs +6 -2
  155. package/auth-CSVTXOZX.js +0 -36
  156. package/invoke-fetch-PEI54KZO.js +0 -14
package/automations.js CHANGED
@@ -1,131 +1,138 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunkOULT3V2Ujs = require('./chunk-OULT3V2U.js');
5
- require('./chunk-ZT4C7KCQ.js');
4
+ var _chunkJNGURO23js = require('./chunk-JNGURO23.js');
5
+ require('./chunk-2STFUQKQ.js');
6
+ require('./chunk-P57PW2II.js');
6
7
 
7
8
  // src/public/rest/automations.ts
8
- var getAutomations = async (query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
9
+ var getAutomations = async (query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
9
10
  method: "get",
10
11
  pathTemplate: "/api/v1/automations",
11
12
  query,
12
13
  options
13
14
  });
14
- var createAutomation = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
15
+ var createAutomation = async (body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
15
16
  method: "post",
16
17
  pathTemplate: "/api/v1/automations",
17
18
  body,
19
+ contentType: "application/json",
18
20
  options
19
21
  });
20
- var getAutomationSettings = async (options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
22
+ var getAutomationsSettings = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
21
23
  method: "get",
22
24
  pathTemplate: "/api/v1/automations/settings",
23
25
  options
24
26
  });
25
- var updateAutomationSettings = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
27
+ var updateAutomationsSettings = async (body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
26
28
  method: "put",
27
29
  pathTemplate: "/api/v1/automations/settings",
28
30
  body,
31
+ contentType: "application/json",
29
32
  options
30
33
  });
31
- var getAutomationUsageMetrics = async (query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
34
+ var getAutomationsUsageMetrics = async (query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
32
35
  method: "get",
33
36
  pathTemplate: "/api/v1/automations/usage",
34
37
  query,
35
38
  options
36
39
  });
37
- var deleteAutomation = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
40
+ var deleteAutomation = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
38
41
  method: "delete",
39
42
  pathTemplate: "/api/v1/automations/{id}",
40
43
  pathVariables: { id },
41
44
  options
42
45
  });
43
- var getAutomation = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
46
+ var getAutomation = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
44
47
  method: "get",
45
48
  pathTemplate: "/api/v1/automations/{id}",
46
49
  pathVariables: { id },
47
50
  options
48
51
  });
49
- var updateAutomation = async (id, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
52
+ var updateAutomation = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
50
53
  method: "put",
51
54
  pathTemplate: "/api/v1/automations/{id}",
52
55
  pathVariables: { id },
53
56
  body,
57
+ contentType: "application/json",
54
58
  options
55
59
  });
56
- var copyAutomation = async (id, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
60
+ var copyAutomation = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
57
61
  method: "post",
58
62
  pathTemplate: "/api/v1/automations/{id}/actions/copy",
59
63
  pathVariables: { id },
60
64
  body,
65
+ contentType: "application/json",
61
66
  options
62
67
  });
63
- var disableAutomation = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
68
+ var disableAutomation = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
64
69
  method: "post",
65
70
  pathTemplate: "/api/v1/automations/{id}/actions/disable",
66
71
  pathVariables: { id },
67
72
  options
68
73
  });
69
- var enableAutomation = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
74
+ var enableAutomation = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
70
75
  method: "post",
71
76
  pathTemplate: "/api/v1/automations/{id}/actions/enable",
72
77
  pathVariables: { id },
73
78
  options
74
79
  });
75
- var moveAutomation = async (id, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
80
+ var moveAutomation = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
76
81
  method: "post",
77
82
  pathTemplate: "/api/v1/automations/{id}/actions/move",
78
83
  pathVariables: { id },
79
84
  body,
85
+ contentType: "application/json",
80
86
  options
81
87
  });
82
- var getAutomationRuns = async (id, query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
88
+ var getAutomationRuns = async (id, query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
83
89
  method: "get",
84
90
  pathTemplate: "/api/v1/automations/{id}/runs",
85
91
  pathVariables: { id },
86
92
  query,
87
93
  options
88
94
  });
89
- var queueAutomationRun = async (id, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
95
+ var queueAutomationRun = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
90
96
  method: "post",
91
97
  pathTemplate: "/api/v1/automations/{id}/runs",
92
98
  pathVariables: { id },
93
99
  body,
100
+ contentType: "application/json",
94
101
  options
95
102
  });
96
- var getAutomationRun = async (id, runId, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
103
+ var getAutomationRun = async (id, runId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
97
104
  method: "get",
98
105
  pathTemplate: "/api/v1/automations/{id}/runs/{runId}",
99
106
  pathVariables: { id, runId },
100
107
  options
101
108
  });
102
- var getAutomationRunDetails = async (id, runId, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
109
+ var getAutomationRunDetails = async (id, runId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
103
110
  method: "post",
104
111
  pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/export",
105
112
  pathVariables: { id, runId },
106
113
  options
107
114
  });
108
- var retryAutomationRun = async (id, runId, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
115
+ var retryAutomationRun = async (id, runId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
109
116
  method: "post",
110
117
  pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/retry",
111
118
  pathVariables: { id, runId },
112
119
  options
113
120
  });
114
- var stopAutomationRun = async (id, runId, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "automations", {
121
+ var stopAutomationRun = async (id, runId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "automations", {
115
122
  method: "post",
116
123
  pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/stop",
117
124
  pathVariables: { id, runId },
118
125
  options
119
126
  });
120
127
  function clearCache() {
121
- return _chunkOULT3V2Ujs.clearApiCache.call(void 0, "automations");
128
+ return _chunkJNGURO23js.clearApiCache.call(void 0, "automations");
122
129
  }
123
130
  var automationsExport = {
124
131
  getAutomations,
125
132
  createAutomation,
126
- getAutomationSettings,
127
- updateAutomationSettings,
128
- getAutomationUsageMetrics,
133
+ getAutomationsSettings,
134
+ updateAutomationsSettings,
135
+ getAutomationsUsageMetrics,
129
136
  deleteAutomation,
130
137
  getAutomation,
131
138
  updateAutomation,
@@ -163,4 +170,4 @@ var automations_default = automationsExport;
163
170
 
164
171
 
165
172
 
166
- exports.clearCache = clearCache; exports.copyAutomation = copyAutomation; exports.createAutomation = createAutomation; exports.default = automations_default; exports.deleteAutomation = deleteAutomation; exports.disableAutomation = disableAutomation; exports.enableAutomation = enableAutomation; exports.getAutomation = getAutomation; exports.getAutomationRun = getAutomationRun; exports.getAutomationRunDetails = getAutomationRunDetails; exports.getAutomationRuns = getAutomationRuns; exports.getAutomationSettings = getAutomationSettings; exports.getAutomationUsageMetrics = getAutomationUsageMetrics; exports.getAutomations = getAutomations; exports.moveAutomation = moveAutomation; exports.queueAutomationRun = queueAutomationRun; exports.retryAutomationRun = retryAutomationRun; exports.stopAutomationRun = stopAutomationRun; exports.updateAutomation = updateAutomation; exports.updateAutomationSettings = updateAutomationSettings;
173
+ exports.clearCache = clearCache; exports.copyAutomation = copyAutomation; exports.createAutomation = createAutomation; exports.default = automations_default; exports.deleteAutomation = deleteAutomation; exports.disableAutomation = disableAutomation; exports.enableAutomation = enableAutomation; exports.getAutomation = getAutomation; exports.getAutomationRun = getAutomationRun; exports.getAutomationRunDetails = getAutomationRunDetails; exports.getAutomationRuns = getAutomationRuns; exports.getAutomations = getAutomations; exports.getAutomationsSettings = getAutomationsSettings; exports.getAutomationsUsageMetrics = getAutomationsUsageMetrics; exports.moveAutomation = moveAutomation; exports.queueAutomationRun = queueAutomationRun; exports.retryAutomationRun = retryAutomationRun; exports.stopAutomationRun = stopAutomationRun; exports.updateAutomation = updateAutomation; exports.updateAutomationsSettings = updateAutomationsSettings;
package/automations.mjs CHANGED
@@ -1,8 +1,9 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-3YE7EI7I.mjs";
5
- import "./chunk-WM7FQU2U.mjs";
4
+ } from "./chunk-TE7XMBT5.mjs";
5
+ import "./chunk-3SVRHJII.mjs";
6
+ import "./chunk-ZFXKCRJC.mjs";
6
7
 
7
8
  // src/public/rest/automations.ts
8
9
  var getAutomations = async (query, options) => invokeFetch("automations", {
@@ -15,20 +16,22 @@ var createAutomation = async (body, options) => invokeFetch("automations", {
15
16
  method: "post",
16
17
  pathTemplate: "/api/v1/automations",
17
18
  body,
19
+ contentType: "application/json",
18
20
  options
19
21
  });
20
- var getAutomationSettings = async (options) => invokeFetch("automations", {
22
+ var getAutomationsSettings = async (options) => invokeFetch("automations", {
21
23
  method: "get",
22
24
  pathTemplate: "/api/v1/automations/settings",
23
25
  options
24
26
  });
25
- var updateAutomationSettings = async (body, options) => invokeFetch("automations", {
27
+ var updateAutomationsSettings = async (body, options) => invokeFetch("automations", {
26
28
  method: "put",
27
29
  pathTemplate: "/api/v1/automations/settings",
28
30
  body,
31
+ contentType: "application/json",
29
32
  options
30
33
  });
31
- var getAutomationUsageMetrics = async (query, options) => invokeFetch("automations", {
34
+ var getAutomationsUsageMetrics = async (query, options) => invokeFetch("automations", {
32
35
  method: "get",
33
36
  pathTemplate: "/api/v1/automations/usage",
34
37
  query,
@@ -51,6 +54,7 @@ var updateAutomation = async (id, body, options) => invokeFetch("automations", {
51
54
  pathTemplate: "/api/v1/automations/{id}",
52
55
  pathVariables: { id },
53
56
  body,
57
+ contentType: "application/json",
54
58
  options
55
59
  });
56
60
  var copyAutomation = async (id, body, options) => invokeFetch("automations", {
@@ -58,6 +62,7 @@ var copyAutomation = async (id, body, options) => invokeFetch("automations", {
58
62
  pathTemplate: "/api/v1/automations/{id}/actions/copy",
59
63
  pathVariables: { id },
60
64
  body,
65
+ contentType: "application/json",
61
66
  options
62
67
  });
63
68
  var disableAutomation = async (id, options) => invokeFetch("automations", {
@@ -77,6 +82,7 @@ var moveAutomation = async (id, body, options) => invokeFetch("automations", {
77
82
  pathTemplate: "/api/v1/automations/{id}/actions/move",
78
83
  pathVariables: { id },
79
84
  body,
85
+ contentType: "application/json",
80
86
  options
81
87
  });
82
88
  var getAutomationRuns = async (id, query, options) => invokeFetch("automations", {
@@ -91,6 +97,7 @@ var queueAutomationRun = async (id, body, options) => invokeFetch("automations",
91
97
  pathTemplate: "/api/v1/automations/{id}/runs",
92
98
  pathVariables: { id },
93
99
  body,
100
+ contentType: "application/json",
94
101
  options
95
102
  });
96
103
  var getAutomationRun = async (id, runId, options) => invokeFetch("automations", {
@@ -123,9 +130,9 @@ function clearCache() {
123
130
  var automationsExport = {
124
131
  getAutomations,
125
132
  createAutomation,
126
- getAutomationSettings,
127
- updateAutomationSettings,
128
- getAutomationUsageMetrics,
133
+ getAutomationsSettings,
134
+ updateAutomationsSettings,
135
+ getAutomationsUsageMetrics,
129
136
  deleteAutomation,
130
137
  getAutomation,
131
138
  updateAutomation,
@@ -154,13 +161,13 @@ export {
154
161
  getAutomationRun,
155
162
  getAutomationRunDetails,
156
163
  getAutomationRuns,
157
- getAutomationSettings,
158
- getAutomationUsageMetrics,
159
164
  getAutomations,
165
+ getAutomationsSettings,
166
+ getAutomationsUsageMetrics,
160
167
  moveAutomation,
161
168
  queueAutomationRun,
162
169
  retryAutomationRun,
163
170
  stopAutomationRun,
164
171
  updateAutomation,
165
- updateAutomationSettings
172
+ updateAutomationsSettings
166
173
  };
package/brands.d.mts CHANGED
@@ -86,6 +86,7 @@ type Link = {
86
86
  type NoActiveBrand = unknown;
87
87
  /**
88
88
  * Lists all brand entries for a tenant
89
+ *
89
90
  * @param query an object with query parameters
90
91
  * @throws GetBrandsHttpError
91
92
  */
@@ -129,10 +130,22 @@ type GetBrands500HttpError = {
129
130
  type GetBrandsHttpError = GetBrands400HttpError | GetBrands401HttpError | GetBrands403HttpError | GetBrands500HttpError;
130
131
  /**
131
132
  * Creates a new brand
133
+ *
132
134
  * @param body an object with the body content
133
135
  * @throws CreateBrandHttpError
134
136
  */
135
- declare const createBrand: (body: unknown, options?: ApiCallOptions) => Promise<CreateBrandHttpResponse>;
137
+ declare const createBrand: (body: {
138
+ /** Description of the brand. */
139
+ description?: string;
140
+ /** The path and name of a properly formatted ICO file. Maximum size is 100 KB. */
141
+ favIcon?: BodyInit;
142
+ /** The path and name of a JPG or PNG file that will be adjusted to fit in a 'box' measuring 109px in width and 62 px in height while maintaining aspect ratio. Maximum size of 300 KB, but smaller is recommended. */
143
+ logo?: BodyInit;
144
+ /** Name of the brand. */
145
+ name: string;
146
+ /** The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational. */
147
+ styles?: BodyInit;
148
+ }, options?: ApiCallOptions) => Promise<CreateBrandHttpResponse>;
136
149
  type CreateBrandHttpResponse = {
137
150
  data: Brand;
138
151
  headers: Headers;
@@ -161,6 +174,7 @@ type CreateBrand500HttpError = {
161
174
  type CreateBrandHttpError = CreateBrand400HttpError | CreateBrand401HttpError | CreateBrand403HttpError | CreateBrand500HttpError;
162
175
  /**
163
176
  * Retrieves the current active brand
177
+ *
164
178
  * @throws GetActiveBrandHttpError
165
179
  */
166
180
  declare const getActiveBrand: (options?: ApiCallOptions) => Promise<GetActiveBrandHttpResponse>;
@@ -176,6 +190,7 @@ type GetActiveBrandHttpError = {
176
190
  };
177
191
  /**
178
192
  * Deletes a specific brand
193
+ *
179
194
  * @param brandId The brand's unique identifier.
180
195
  * @throws DeleteBrandHttpError
181
196
  */
@@ -213,6 +228,7 @@ type DeleteBrand500HttpError = {
213
228
  type DeleteBrandHttpError = DeleteBrand400HttpError | DeleteBrand401HttpError | DeleteBrand403HttpError | DeleteBrand404HttpError | DeleteBrand500HttpError;
214
229
  /**
215
230
  * Retrieves a specific brand
231
+ *
216
232
  * @param brandId The brand's unique identifier.
217
233
  * @throws GetBrandHttpError
218
234
  */
@@ -250,6 +266,7 @@ type GetBrand500HttpError = {
250
266
  type GetBrandHttpError = GetBrand400HttpError | GetBrand401HttpError | GetBrand403HttpError | GetBrand404HttpError | GetBrand500HttpError;
251
267
  /**
252
268
  * Patches a brand
269
+ *
253
270
  * @param brandId The brand's unique identifier.
254
271
  * @param body an object with the body content
255
272
  * @throws PatchBrandHttpError
@@ -288,6 +305,7 @@ type PatchBrand500HttpError = {
288
305
  type PatchBrandHttpError = PatchBrand400HttpError | PatchBrand401HttpError | PatchBrand403HttpError | PatchBrand404HttpError | PatchBrand500HttpError;
289
306
  /**
290
307
  * Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken.
308
+ *
291
309
  * @param brandId The brand's unique identifier.
292
310
  * @param body an object with the body content
293
311
  * @throws ActivateBrandHttpError
@@ -326,6 +344,7 @@ type ActivateBrand500HttpError = {
326
344
  type ActivateBrandHttpError = ActivateBrand400HttpError | ActivateBrand401HttpError | ActivateBrand403HttpError | ActivateBrand404HttpError | ActivateBrand500HttpError;
327
345
  /**
328
346
  * Sets the brand so it is no longer active. If the brand is already inactive, no action is taken.
347
+ *
329
348
  * @param brandId The brand's unique identifier.
330
349
  * @param body an object with the body content
331
350
  * @throws DeactivateBrandHttpError
@@ -364,6 +383,7 @@ type DeactivateBrand500HttpError = {
364
383
  type DeactivateBrandHttpError = DeactivateBrand400HttpError | DeactivateBrand401HttpError | DeactivateBrand403HttpError | DeactivateBrand404HttpError | DeactivateBrand500HttpError;
365
384
  /**
366
385
  * Deletes a specific brand file
386
+ *
367
387
  * @param brandId The brand's unique identifier.
368
388
  * @param brandFileId The unique identifier of a file within a brand.
369
389
  * @throws DeleteBrandFileHttpError
@@ -402,13 +422,14 @@ type DeleteBrandFile500HttpError = {
402
422
  type DeleteBrandFileHttpError = DeleteBrandFile400HttpError | DeleteBrandFile401HttpError | DeleteBrandFile403HttpError | DeleteBrandFile404HttpError | DeleteBrandFile500HttpError;
403
423
  /**
404
424
  * Downloads the brand file
425
+ *
405
426
  * @param brandId The brand's unique identifier.
406
427
  * @param brandFileId The unique identifier of a file within a brand.
407
428
  * @throws GetBrandFileHttpError
408
429
  */
409
430
  declare const getBrandFile: (brandId: string, brandFileId: string, options?: ApiCallOptions) => Promise<GetBrandFileHttpResponse>;
410
431
  type GetBrandFileHttpResponse = {
411
- data: string;
432
+ data: BodyInit;
412
433
  headers: Headers;
413
434
  status: number;
414
435
  };
@@ -440,12 +461,16 @@ type GetBrandFile500HttpError = {
440
461
  type GetBrandFileHttpError = GetBrandFile400HttpError | GetBrandFile401HttpError | GetBrandFile403HttpError | GetBrandFile404HttpError | GetBrandFile500HttpError;
441
462
  /**
442
463
  * Creates a brand file
464
+ *
443
465
  * @param brandId The brand's unique identifier.
444
466
  * @param brandFileId The unique identifier of a file within a brand.
445
467
  * @param body an object with the body content
446
468
  * @throws CreateBrandFileHttpError
447
469
  */
448
- declare const createBrandFile: (brandId: string, brandFileId: string, body: unknown, options?: ApiCallOptions) => Promise<CreateBrandFileHttpResponse>;
470
+ declare const createBrandFile: (brandId: string, brandFileId: string, body: {
471
+ /** The path and name of a file to upload. */
472
+ file?: BodyInit;
473
+ }, options?: ApiCallOptions) => Promise<CreateBrandFileHttpResponse>;
449
474
  type CreateBrandFileHttpResponse = {
450
475
  data: BrandFile;
451
476
  headers: Headers;
@@ -479,12 +504,16 @@ type CreateBrandFile500HttpError = {
479
504
  type CreateBrandFileHttpError = CreateBrandFile400HttpError | CreateBrandFile401HttpError | CreateBrandFile403HttpError | CreateBrandFile404HttpError | CreateBrandFile500HttpError;
480
505
  /**
481
506
  * Updates existing file
507
+ *
482
508
  * @param brandId The brand's unique identifier.
483
509
  * @param brandFileId The unique identifier of a file within a brand.
484
510
  * @param body an object with the body content
485
511
  * @throws UpdateBrandFileHttpError
486
512
  */
487
- declare const updateBrandFile: (brandId: string, brandFileId: string, body: unknown, options?: ApiCallOptions) => Promise<UpdateBrandFileHttpResponse>;
513
+ declare const updateBrandFile: (brandId: string, brandFileId: string, body: {
514
+ /** A file to upload. */
515
+ file?: BodyInit;
516
+ }, options?: ApiCallOptions) => Promise<UpdateBrandFileHttpResponse>;
488
517
  type UpdateBrandFileHttpResponse = {
489
518
  data: BrandFile;
490
519
  headers: Headers;
@@ -523,35 +552,41 @@ declare function clearCache(): void;
523
552
  interface BrandsAPI {
524
553
  /**
525
554
  * Lists all brand entries for a tenant
555
+ *
526
556
  * @param query an object with query parameters
527
557
  * @throws GetBrandsHttpError
528
558
  */
529
559
  getBrands: typeof getBrands;
530
560
  /**
531
561
  * Creates a new brand
562
+ *
532
563
  * @param body an object with the body content
533
564
  * @throws CreateBrandHttpError
534
565
  */
535
566
  createBrand: typeof createBrand;
536
567
  /**
537
568
  * Retrieves the current active brand
569
+ *
538
570
  * @throws GetActiveBrandHttpError
539
571
  */
540
572
  getActiveBrand: typeof getActiveBrand;
541
573
  /**
542
574
  * Deletes a specific brand
575
+ *
543
576
  * @param brandId The brand's unique identifier.
544
577
  * @throws DeleteBrandHttpError
545
578
  */
546
579
  deleteBrand: typeof deleteBrand;
547
580
  /**
548
581
  * Retrieves a specific brand
582
+ *
549
583
  * @param brandId The brand's unique identifier.
550
584
  * @throws GetBrandHttpError
551
585
  */
552
586
  getBrand: typeof getBrand;
553
587
  /**
554
588
  * Patches a brand
589
+ *
555
590
  * @param brandId The brand's unique identifier.
556
591
  * @param body an object with the body content
557
592
  * @throws PatchBrandHttpError
@@ -559,6 +594,7 @@ interface BrandsAPI {
559
594
  patchBrand: typeof patchBrand;
560
595
  /**
561
596
  * Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken.
597
+ *
562
598
  * @param brandId The brand's unique identifier.
563
599
  * @param body an object with the body content
564
600
  * @throws ActivateBrandHttpError
@@ -566,6 +602,7 @@ interface BrandsAPI {
566
602
  activateBrand: typeof activateBrand;
567
603
  /**
568
604
  * Sets the brand so it is no longer active. If the brand is already inactive, no action is taken.
605
+ *
569
606
  * @param brandId The brand's unique identifier.
570
607
  * @param body an object with the body content
571
608
  * @throws DeactivateBrandHttpError
@@ -573,6 +610,7 @@ interface BrandsAPI {
573
610
  deactivateBrand: typeof deactivateBrand;
574
611
  /**
575
612
  * Deletes a specific brand file
613
+ *
576
614
  * @param brandId The brand's unique identifier.
577
615
  * @param brandFileId The unique identifier of a file within a brand.
578
616
  * @throws DeleteBrandFileHttpError
@@ -580,6 +618,7 @@ interface BrandsAPI {
580
618
  deleteBrandFile: typeof deleteBrandFile;
581
619
  /**
582
620
  * Downloads the brand file
621
+ *
583
622
  * @param brandId The brand's unique identifier.
584
623
  * @param brandFileId The unique identifier of a file within a brand.
585
624
  * @throws GetBrandFileHttpError
@@ -587,6 +626,7 @@ interface BrandsAPI {
587
626
  getBrandFile: typeof getBrandFile;
588
627
  /**
589
628
  * Creates a brand file
629
+ *
590
630
  * @param brandId The brand's unique identifier.
591
631
  * @param brandFileId The unique identifier of a file within a brand.
592
632
  * @param body an object with the body content
@@ -595,6 +635,7 @@ interface BrandsAPI {
595
635
  createBrandFile: typeof createBrandFile;
596
636
  /**
597
637
  * Updates existing file
638
+ *
598
639
  * @param brandId The brand's unique identifier.
599
640
  * @param brandFileId The unique identifier of a file within a brand.
600
641
  * @param body an object with the body content