twilio 6.0.0 → 6.0.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.
Files changed (121) hide show
  1. package/lib/rest/ConversationsBase.d.ts +3 -0
  2. package/lib/rest/ConversationsBase.js +5 -0
  3. package/lib/rest/InsightsBase.d.ts +3 -0
  4. package/lib/rest/InsightsBase.js +5 -0
  5. package/lib/rest/IntelligenceBase.d.ts +3 -0
  6. package/lib/rest/IntelligenceBase.js +5 -0
  7. package/lib/rest/KnowledgeBase.d.ts +3 -0
  8. package/lib/rest/KnowledgeBase.js +5 -0
  9. package/lib/rest/Memory.d.ts +4 -0
  10. package/lib/rest/Memory.js +8 -0
  11. package/lib/rest/MemoryBase.d.ts +13 -0
  12. package/lib/rest/MemoryBase.js +31 -0
  13. package/lib/rest/Twilio.d.ts +5 -0
  14. package/lib/rest/Twilio.js +5 -0
  15. package/lib/rest/VoiceBase.d.ts +3 -0
  16. package/lib/rest/VoiceBase.js +5 -0
  17. package/lib/rest/api/v2010/account/call/recording.d.ts +2 -0
  18. package/lib/rest/api/v2010/account/call/recording.js +4 -0
  19. package/lib/rest/api/v2010/account/call/transcription.d.ts +1 -1
  20. package/lib/rest/api/v2010/account/call/transcription.js +6 -4
  21. package/lib/rest/api/v2010/account/call.d.ts +2 -0
  22. package/lib/rest/api/v2010/account/call.js +4 -0
  23. package/lib/rest/api/v2010/account/conference/participant.d.ts +2 -0
  24. package/lib/rest/api/v2010/account/conference/participant.js +4 -0
  25. package/lib/rest/conversations/V2.d.ts +38 -0
  26. package/lib/rest/conversations/V2.js +72 -0
  27. package/lib/rest/conversations/v2/action.d.ts +241 -0
  28. package/lib/rest/conversations/v2/action.js +246 -0
  29. package/lib/rest/conversations/v2/communication.d.ts +479 -0
  30. package/lib/rest/conversations/v2/communication.js +436 -0
  31. package/lib/rest/conversations/v2/configuration.d.ts +906 -0
  32. package/lib/rest/conversations/v2/configuration.js +619 -0
  33. package/lib/rest/conversations/v2/conversation.d.ts +936 -0
  34. package/lib/rest/conversations/v2/conversation.js +664 -0
  35. package/lib/rest/conversations/v2/operation.d.ts +167 -0
  36. package/lib/rest/conversations/v2/operation.js +170 -0
  37. package/lib/rest/conversations/v2/participant.d.ts +469 -0
  38. package/lib/rest/conversations/v2/participant.js +442 -0
  39. package/lib/rest/flexApi/v1/plugin/pluginVersions.d.ts +1 -1
  40. package/lib/rest/flexApi/v1/plugin/pluginVersions.js +8 -6
  41. package/lib/rest/insights/V3.d.ts +20 -0
  42. package/lib/rest/insights/V3.js +42 -0
  43. package/lib/rest/insights/v1/call/callSummary.d.ts +10 -10
  44. package/lib/rest/insights/v1/call/event.d.ts +4 -4
  45. package/lib/rest/insights/v1/callSummaries.d.ts +12 -9
  46. package/lib/rest/insights/v3/metadata.d.ts +115 -0
  47. package/lib/rest/insights/v3/metadata.js +118 -0
  48. package/lib/rest/insights/v3/query.d.ts +180 -0
  49. package/lib/rest/insights/v3/query.js +214 -0
  50. package/lib/rest/intelligence/V3.d.ts +35 -0
  51. package/lib/rest/intelligence/V3.js +65 -0
  52. package/lib/rest/intelligence/v3/configuration.d.ts +693 -0
  53. package/lib/rest/intelligence/v3/configuration.js +528 -0
  54. package/lib/rest/intelligence/v3/conversation.d.ts +478 -0
  55. package/lib/rest/intelligence/v3/conversation.js +342 -0
  56. package/lib/rest/intelligence/v3/operator.d.ts +619 -0
  57. package/lib/rest/intelligence/v3/operator.js +493 -0
  58. package/lib/rest/intelligence/v3/operatorResult.d.ts +543 -0
  59. package/lib/rest/intelligence/v3/operatorResult.js +478 -0
  60. package/lib/rest/intelligence/v3/version.d.ts +469 -0
  61. package/lib/rest/intelligence/v3/version.js +341 -0
  62. package/lib/rest/knowledge/V2.d.ts +31 -0
  63. package/lib/rest/knowledge/V2.js +62 -0
  64. package/lib/rest/knowledge/v2/chunk.d.ts +209 -0
  65. package/lib/rest/knowledge/v2/chunk.js +178 -0
  66. package/lib/rest/knowledge/v2/knowledge.d.ts +507 -0
  67. package/lib/rest/knowledge/v2/knowledge.js +466 -0
  68. package/lib/rest/knowledge/v2/knowledgeBasis.d.ts +484 -0
  69. package/lib/rest/knowledge/v2/knowledgeBasis.js +441 -0
  70. package/lib/rest/knowledge/v2/operation.d.ts +162 -0
  71. package/lib/rest/knowledge/v2/operation.js +175 -0
  72. package/lib/rest/knowledge/v2/search.d.ts +180 -0
  73. package/lib/rest/knowledge/v2/search.js +174 -0
  74. package/lib/rest/memory/V1.d.ts +76 -0
  75. package/lib/rest/memory/V1.js +140 -0
  76. package/lib/rest/memory/v1/bulk.d.ts +129 -0
  77. package/lib/rest/memory/v1/bulk.js +158 -0
  78. package/lib/rest/memory/v1/conversationSummary.d.ts +531 -0
  79. package/lib/rest/memory/v1/conversationSummary.js +473 -0
  80. package/lib/rest/memory/v1/dataMapping.d.ts +630 -0
  81. package/lib/rest/memory/v1/dataMapping.js +512 -0
  82. package/lib/rest/memory/v1/event.d.ts +153 -0
  83. package/lib/rest/memory/v1/event.js +159 -0
  84. package/lib/rest/memory/v1/identifier.d.ts +362 -0
  85. package/lib/rest/memory/v1/identifier.js +369 -0
  86. package/lib/rest/memory/v1/identityResolutionSetting.d.ts +247 -0
  87. package/lib/rest/memory/v1/identityResolutionSetting.js +229 -0
  88. package/lib/rest/memory/v1/import.d.ts +292 -0
  89. package/lib/rest/memory/v1/import.js +280 -0
  90. package/lib/rest/memory/v1/lookup.d.ts +82 -0
  91. package/lib/rest/memory/v1/lookup.js +118 -0
  92. package/lib/rest/memory/v1/observation.d.ts +521 -0
  93. package/lib/rest/memory/v1/observation.js +477 -0
  94. package/lib/rest/memory/v1/operation.d.ts +162 -0
  95. package/lib/rest/memory/v1/operation.js +175 -0
  96. package/lib/rest/memory/v1/profile.d.ts +548 -0
  97. package/lib/rest/memory/v1/profile.js +531 -0
  98. package/lib/rest/memory/v1/recall.d.ts +306 -0
  99. package/lib/rest/memory/v1/recall.js +234 -0
  100. package/lib/rest/memory/v1/revision.d.ts +246 -0
  101. package/lib/rest/memory/v1/revision.js +195 -0
  102. package/lib/rest/memory/v1/store.d.ts +544 -0
  103. package/lib/rest/memory/v1/store.js +534 -0
  104. package/lib/rest/memory/v1/trait.d.ts +233 -0
  105. package/lib/rest/memory/v1/trait.js +190 -0
  106. package/lib/rest/memory/v1/traitGroup.d.ts +758 -0
  107. package/lib/rest/memory/v1/traitGroup.js +555 -0
  108. package/lib/rest/messaging/v2/channelsSender.d.ts +8 -0
  109. package/lib/rest/messaging/v2/channelsSender.js +2 -0
  110. package/lib/rest/previewIam/versionless/organization/roleAssignment.d.ts +32 -0
  111. package/lib/rest/previewIam/versionless/organization/roleAssignment.js +14 -0
  112. package/lib/rest/studio/v2/flow.d.ts +4 -0
  113. package/lib/rest/studio/v2/flow.js +8 -0
  114. package/lib/rest/verify/v2/service/webhook.d.ts +2 -2
  115. package/lib/rest/verify/v2/service/webhook.js +8 -8
  116. package/lib/rest/voice/V3.d.ts +15 -0
  117. package/lib/rest/voice/V3.js +37 -0
  118. package/lib/rest/voice/v3/transcription.d.ts +378 -0
  119. package/lib/rest/voice/v3/transcription.js +264 -0
  120. package/lib/twiml/VoiceResponse.d.ts +8 -0
  121. package/package.json +1 -1
@@ -0,0 +1,178 @@
1
+ "use strict";
2
+ /*
3
+ * This code was generated by
4
+ * ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
5
+ * | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
6
+ * | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
7
+ *
8
+ * Twilio Knowledge API
9
+ * APIs for managing knowledge bases and knowledge content for AI-powered applications.
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator.
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __importDefault = (this && this.__importDefault) || function (mod) {
16
+ return (mod && mod.__esModule) ? mod : { "default": mod };
17
+ };
18
+ Object.defineProperty(exports, "__esModule", { value: true });
19
+ exports.ChunkPage = exports.ChunkInstance = void 0;
20
+ exports.ChunkListInstance = ChunkListInstance;
21
+ const util_1 = require("util");
22
+ const TokenPage_1 = __importDefault(require("../../../base/TokenPage"));
23
+ const deserialize = require("../../../base/deserialize");
24
+ const serialize = require("../../../base/serialize");
25
+ const utility_1 = require("../../../base/utility");
26
+ function ChunkListInstance(version, kbId, knowledgeId) {
27
+ if (!(0, utility_1.isValidPathParam)(kbId)) {
28
+ throw new Error("Parameter 'kbId' is not valid.");
29
+ }
30
+ if (!(0, utility_1.isValidPathParam)(knowledgeId)) {
31
+ throw new Error("Parameter 'knowledgeId' is not valid.");
32
+ }
33
+ const instance = {};
34
+ instance._version = version;
35
+ instance._solution = { kbId, knowledgeId };
36
+ instance._uri = `/KnowledgeBases/${kbId}/Knowledge/${knowledgeId}/Chunks`;
37
+ instance.page = function page(params, callback) {
38
+ if (params instanceof Function) {
39
+ callback = params;
40
+ params = {};
41
+ }
42
+ else {
43
+ params = params || {};
44
+ }
45
+ let data = {};
46
+ if (params["pageSize"] !== undefined)
47
+ data["pageSize"] = params["pageSize"];
48
+ if (params["pageToken"] !== undefined)
49
+ data["pageToken"] = params["pageToken"];
50
+ const headers = {};
51
+ headers["Accept"] = "application/json";
52
+ let operationVersion = version, operationPromise = operationVersion.page({
53
+ uri: instance._uri,
54
+ method: "get",
55
+ params: data,
56
+ headers,
57
+ });
58
+ operationPromise = operationPromise.then((payload) => new ChunkPage(operationVersion, payload, instance._uri, data, instance._solution));
59
+ operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
60
+ return operationPromise;
61
+ };
62
+ instance.each = instance._version.each;
63
+ instance.list = instance._version.list;
64
+ instance.getPage = function getPage(targetUrl, callback) {
65
+ const operationPromise = instance._version._domain.twilio.request({
66
+ method: "get",
67
+ uri: targetUrl,
68
+ });
69
+ let pagePromise = operationPromise.then((payload) => new ChunkPage(instance._version, payload, instance._uri, {}, instance._solution));
70
+ pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
71
+ return pagePromise;
72
+ };
73
+ instance.pageWithHttpInfo = function pageWithHttpInfo(params, callback) {
74
+ if (params instanceof Function) {
75
+ callback = params;
76
+ params = {};
77
+ }
78
+ else {
79
+ params = params || {};
80
+ }
81
+ let data = {};
82
+ if (params["pageSize"] !== undefined)
83
+ data["pageSize"] = params["pageSize"];
84
+ if (params["pageToken"] !== undefined)
85
+ data["pageToken"] = params["pageToken"];
86
+ const headers = {};
87
+ headers["Accept"] = "application/json";
88
+ let operationVersion = version;
89
+ // For page operations, use page() directly as it already returns { statusCode, body, headers }
90
+ // IMPORTANT: Pass full response to Page constructor, not response.body
91
+ let operationPromise = operationVersion
92
+ .page({ uri: instance._uri, method: "get", params: data, headers })
93
+ .then((response) => ({
94
+ statusCode: response.statusCode,
95
+ headers: response.headers,
96
+ body: new ChunkPage(operationVersion, response, instance._uri, data, instance._solution),
97
+ }));
98
+ operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
99
+ return operationPromise;
100
+ };
101
+ instance.each = instance._version.each;
102
+ instance.eachWithHttpInfo = instance._version.eachWithHttpInfo;
103
+ instance.list = instance._version.list;
104
+ instance.listWithHttpInfo = instance._version.listWithHttpInfo;
105
+ instance.getPageWithHttpInfo = function getPageWithHttpInfo(targetUrl, callback) {
106
+ // Use request() directly as it already returns { statusCode, body, headers }
107
+ const operationPromise = instance._version._domain.twilio.request({
108
+ method: "get",
109
+ uri: targetUrl,
110
+ });
111
+ let pagePromise = operationPromise.then((response) => ({
112
+ statusCode: response.statusCode,
113
+ headers: response.headers,
114
+ body: new ChunkPage(instance._version, response, instance._uri, {}, instance._solution),
115
+ }));
116
+ pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
117
+ return pagePromise;
118
+ };
119
+ instance.toJSON = function toJSON() {
120
+ return instance._solution;
121
+ };
122
+ instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
123
+ return (0, util_1.inspect)(instance.toJSON(), options);
124
+ };
125
+ return instance;
126
+ }
127
+ /**
128
+ * Represents a processed content chunk extracted from knowledge source. Chunks are smaller segments of content that have been parsed and indexed for semantic search operations, containing the original text content.
129
+ */
130
+ class ChunkInstance {
131
+ constructor(_version, _payload, kbId, knowledgeId) {
132
+ this._version = _version;
133
+ const payload = _payload;
134
+ this.content = payload.content;
135
+ this.createdAt = deserialize.iso8601DateTime(payload.createdAt);
136
+ }
137
+ /**
138
+ * Provide a user-friendly representation
139
+ *
140
+ * @returns Object
141
+ */
142
+ toJSON() {
143
+ return {
144
+ content: this.content,
145
+ createdAt: this.createdAt,
146
+ };
147
+ }
148
+ [util_1.inspect.custom](_depth, options) {
149
+ return (0, util_1.inspect)(this.toJSON(), options);
150
+ }
151
+ }
152
+ exports.ChunkInstance = ChunkInstance;
153
+ class ChunkPage extends TokenPage_1.default {
154
+ /**
155
+ * Initialize the ChunkPage
156
+ *
157
+ * @param version - Version of the resource
158
+ * @param response - Response from the API
159
+ * @param uri - URI of the resource
160
+ * @param params - Query parameters
161
+ * @param solution - Path solution
162
+ */
163
+ constructor(version, response, uri, params, solution) {
164
+ super(version, response, uri, params, solution);
165
+ }
166
+ /**
167
+ * Build an instance of ChunkInstance
168
+ *
169
+ * @param payload - Payload response from the API
170
+ */
171
+ getInstance(payload) {
172
+ return new ChunkInstance(this._version, payload, this._solution.kbId, this._solution.knowledgeId);
173
+ }
174
+ [util_1.inspect.custom](depth, options) {
175
+ return (0, util_1.inspect)(this.toJSON(), options);
176
+ }
177
+ }
178
+ exports.ChunkPage = ChunkPage;
@@ -0,0 +1,507 @@
1
+ import { inspect, InspectOptions } from "util";
2
+ import TokenPage, { TokenPaginationPayload } from "../../../base/TokenPage";
3
+ import Response from "../../../http/response";
4
+ import V2 from "../V2";
5
+ import { ApiResponse } from "../../../base/ApiResponse";
6
+ /**
7
+ * Core properties for knowledge source that can be set at creation time. Regularly update and organize your Knowledge sources to ensure it contains the most accurate and relevant information. This includes adding new entries, updating existing ones, and removing outdated content.
8
+ */
9
+ export declare class KnowledgeCore {
10
+ /**
11
+ * The name of the knowledge source.
12
+ */
13
+ "name": string;
14
+ /**
15
+ * A detailed description of the knowledge source and when to use it. This helps provide context about the content and its intended purpose.
16
+ */
17
+ "description"?: string;
18
+ "source"?: KnowledgeSourceTypes;
19
+ constructor(payload: any);
20
+ }
21
+ /**
22
+ * Details specific to the knowledge source type. Each knowledge source type has its own set of configuration parameters and source specific properties.
23
+ */
24
+ export declare class KnowledgeSourceTypes {
25
+ /**
26
+ * Raw text knowledge sources
27
+ */
28
+ "type": string;
29
+ /**
30
+ * The raw text content to be processed
31
+ */
32
+ "content": string;
33
+ /**
34
+ * The URL to crawl for web content
35
+ */
36
+ "url": string;
37
+ /**
38
+ * The maximum depth to crawl from the source URL
39
+ */
40
+ "crawlDepth"?: number;
41
+ /**
42
+ * Frequency of re-crawling the website for updated content
43
+ */
44
+ "crawlPeriod"?: string;
45
+ /**
46
+ * Name of the file to be uploaded
47
+ */
48
+ "fileName": string;
49
+ /**
50
+ * Expected size of the file in bytes
51
+ */
52
+ "fileSize": number;
53
+ "mimeType": SupportedFileMimeType;
54
+ /**
55
+ * Presigned S3 URL for file upload (when status is SCHEDULED) or the permanent S3 location after upload completes. Use PUT method to upload the file to this URL when status is SCHEDULED.
56
+ */
57
+ "importUrl"?: string;
58
+ /**
59
+ * Expiration time of the presigned upload URL in ISO 8601 format (only present when status is SCHEDULED)
60
+ */
61
+ "uploadExpiration"?: Date;
62
+ constructor(payload: any);
63
+ }
64
+ /**
65
+ * Supported MIME types for knowledge file imports. Maximum file size for any file is 16MB (16 * 1024 * 1024 bytes). Extensions → MIME: .csv → text/csv .md → text/markdown .mdx → text/mdx .pdf → application/pdf .tsv → text/tab-separated-values .txt → text/plain
66
+ */
67
+ export type SupportedFileMimeType = "text/csv" | "text/markdown" | "text/mdx" | "application/pdf" | "text/tab-separated-values" | "text/plain";
68
+ /**
69
+ * Options to pass to update a KnowledgeInstance
70
+ */
71
+ export interface KnowledgeContextUpdateOptions {
72
+ /** When true, re-queues processing for this knowledge resource. Idempotent while the resource is already QUEUED or PROCESSING. */
73
+ refresh?: boolean;
74
+ /** */
75
+ knowledgeCore?: KnowledgeCore;
76
+ }
77
+ /**
78
+ * Options to pass to create a KnowledgeInstance
79
+ */
80
+ export interface KnowledgeListInstanceCreateOptions {
81
+ /** */
82
+ knowledgeCore: KnowledgeCore;
83
+ }
84
+ /**
85
+ * Options to pass to each
86
+ */
87
+ export interface KnowledgeListInstanceEachOptions {
88
+ /** The page index. This value is simply for client state. */
89
+ page?: number;
90
+ /** The maximum number of items to return per page, maximum of 1000. */
91
+ pageSize?: number;
92
+ /** The token for the page of results to retrieve. */
93
+ pageToken?: string;
94
+ /** Function to process each record. If this and a positional callback are passed, this one will be used */
95
+ callback?: (item: KnowledgeInstance, done: (err?: Error) => void) => void;
96
+ /** Function to be called upon completion of streaming */
97
+ done?: Function;
98
+ /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
99
+ limit?: number;
100
+ }
101
+ /**
102
+ * Options to pass to list
103
+ */
104
+ export interface KnowledgeListInstanceOptions {
105
+ /** The page index. This value is simply for client state. */
106
+ page?: number;
107
+ /** The maximum number of items to return per page, maximum of 1000. */
108
+ pageSize?: number;
109
+ /** The token for the page of results to retrieve. */
110
+ pageToken?: string;
111
+ /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
112
+ limit?: number;
113
+ }
114
+ /**
115
+ * Options to pass to page
116
+ */
117
+ export interface KnowledgeListInstancePageOptions {
118
+ /** The page index. This value is simply for client state. */
119
+ page?: number;
120
+ /** The maximum number of items to return per page, maximum of 1000. */
121
+ pageSize?: number;
122
+ /** The token for the page of results to retrieve. */
123
+ pageToken?: string;
124
+ }
125
+ export interface KnowledgeContext {
126
+ /**
127
+ * Remove a KnowledgeInstance
128
+ *
129
+ * @param callback - Callback to handle processed record
130
+ *
131
+ * @returns Resolves to processed boolean
132
+ */
133
+ remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
134
+ /**
135
+ * Remove a KnowledgeInstance and return HTTP info
136
+ *
137
+ * @param callback - Callback to handle processed record
138
+ *
139
+ * @returns Resolves to processed boolean with HTTP metadata
140
+ */
141
+ removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<boolean>) => any): Promise<ApiResponse<boolean>>;
142
+ /**
143
+ * Fetch a KnowledgeInstance
144
+ *
145
+ * @param callback - Callback to handle processed record
146
+ *
147
+ * @returns Resolves to processed KnowledgeInstance
148
+ */
149
+ fetch(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
150
+ /**
151
+ * Fetch a KnowledgeInstance and return HTTP info
152
+ *
153
+ * @param callback - Callback to handle processed record
154
+ *
155
+ * @returns Resolves to processed KnowledgeInstance with HTTP metadata
156
+ */
157
+ fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
158
+ /**
159
+ * Update a KnowledgeInstance
160
+ *
161
+ * @param callback - Callback to handle processed record
162
+ *
163
+ * @returns Resolves to processed KnowledgeInstance
164
+ */
165
+ update(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
166
+ /**
167
+ * Update a KnowledgeInstance
168
+ *
169
+ * @param params - Body for request
170
+ * @param headers - header params for request
171
+ * @param callback - Callback to handle processed record
172
+ *
173
+ * @returns Resolves to processed KnowledgeInstance
174
+ */
175
+ update(params: KnowledgeCore, headers?: any, callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
176
+ /**
177
+ * Update a KnowledgeInstance and return HTTP info
178
+ *
179
+ * @param callback - Callback to handle processed record
180
+ *
181
+ * @returns Resolves to processed KnowledgeInstance with HTTP metadata
182
+ */
183
+ updateWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
184
+ /**
185
+ * Update a KnowledgeInstance and return HTTP info
186
+ *
187
+ * @param params - Body for request
188
+ * @param headers - header params for request
189
+ * @param callback - Callback to handle processed record
190
+ *
191
+ * @returns Resolves to processed KnowledgeInstance with HTTP metadata
192
+ */
193
+ updateWithHttpInfo(params: KnowledgeCore, headers?: any, callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
194
+ /**
195
+ * Provide a user-friendly representation
196
+ */
197
+ toJSON(): any;
198
+ [inspect.custom](_depth: any, options: InspectOptions): any;
199
+ }
200
+ export interface KnowledgeContextSolution {
201
+ kbId: string;
202
+ knowledgeId: string;
203
+ }
204
+ export declare class KnowledgeContextImpl implements KnowledgeContext {
205
+ protected _version: V2;
206
+ protected _solution: KnowledgeContextSolution;
207
+ protected _uri: string;
208
+ constructor(_version: V2, kbId: string, knowledgeId: string);
209
+ remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
210
+ removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<boolean>) => any): Promise<ApiResponse<boolean>>;
211
+ fetch(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
212
+ fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
213
+ update(params?: KnowledgeCore | ((error: Error | null, item?: KnowledgeInstance) => any), headers?: any, callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
214
+ updateWithHttpInfo(params?: KnowledgeCore | ((error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any), headers?: any, callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
215
+ /**
216
+ * Provide a user-friendly representation
217
+ *
218
+ * @returns Object
219
+ */
220
+ toJSON(): KnowledgeContextSolution;
221
+ [inspect.custom](_depth: any, options: InspectOptions): string;
222
+ }
223
+ interface KnowledgePayload extends TokenPaginationPayload {
224
+ knowledge: KnowledgeResource[];
225
+ }
226
+ interface KnowledgeResource {
227
+ name: string;
228
+ description: string;
229
+ source: KnowledgeSourceTypes;
230
+ id: string;
231
+ status: string;
232
+ createdAt: Date;
233
+ updatedAt: Date;
234
+ }
235
+ export declare class KnowledgeInstance {
236
+ protected _version: V2;
237
+ protected _solution: KnowledgeContextSolution;
238
+ protected _context?: KnowledgeContext;
239
+ constructor(_version: V2, _payload: KnowledgeResource, kbId: string, knowledgeId?: string);
240
+ /**
241
+ * The name of the knowledge source.
242
+ */
243
+ name: string;
244
+ /**
245
+ * A detailed description of the knowledge source and when to use it. This helps provide context about the content and its intended purpose.
246
+ */
247
+ description: string;
248
+ source: KnowledgeSourceTypes;
249
+ /**
250
+ * The unique identifier of knowledge source.
251
+ */
252
+ id: string;
253
+ /**
254
+ * The status of processing the knowledge source (\'SCHEDULED\', \'QUEUED\', \'PROCESSING\', \'COMPLETED\', \'FAILED\').
255
+ */
256
+ status: string;
257
+ /**
258
+ * The date and time in GMT when the Knowledge was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
259
+ */
260
+ createdAt: Date;
261
+ /**
262
+ * The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
263
+ */
264
+ updatedAt: Date;
265
+ private get _proxy();
266
+ /**
267
+ * Remove a KnowledgeInstance
268
+ *
269
+ * @param callback - Callback to handle processed record
270
+ *
271
+ * @returns Resolves to processed boolean
272
+ */
273
+ remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
274
+ /**
275
+ * Remove a KnowledgeInstance and return HTTP info
276
+ *
277
+ * @param callback - Callback to handle processed record
278
+ *
279
+ * @returns Resolves to processed boolean with HTTP metadata
280
+ */
281
+ removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<boolean>) => any): Promise<ApiResponse<boolean>>;
282
+ /**
283
+ * Fetch a KnowledgeInstance
284
+ *
285
+ * @param callback - Callback to handle processed record
286
+ *
287
+ * @returns Resolves to processed KnowledgeInstance
288
+ */
289
+ fetch(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
290
+ /**
291
+ * Fetch a KnowledgeInstance and return HTTP info
292
+ *
293
+ * @param callback - Callback to handle processed record
294
+ *
295
+ * @returns Resolves to processed KnowledgeInstance with HTTP metadata
296
+ */
297
+ fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
298
+ /**
299
+ * Update a KnowledgeInstance
300
+ *
301
+ * @param callback - Callback to handle processed record
302
+ *
303
+ * @returns Resolves to processed KnowledgeInstance
304
+ */
305
+ update(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
306
+ /**
307
+ * Update a KnowledgeInstance
308
+ *
309
+ * @param params - Body for request
310
+ * @param headers - header params for request
311
+ * @param callback - Callback to handle processed record
312
+ *
313
+ * @returns Resolves to processed KnowledgeInstance
314
+ */
315
+ update(params: KnowledgeCore, headers?: any, callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
316
+ /**
317
+ * Update a KnowledgeInstance and return HTTP info
318
+ *
319
+ * @param callback - Callback to handle processed record
320
+ *
321
+ * @returns Resolves to processed KnowledgeInstance with HTTP metadata
322
+ */
323
+ updateWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
324
+ /**
325
+ * Update a KnowledgeInstance and return HTTP info
326
+ *
327
+ * @param params - Body for request
328
+ * @param headers - header params for request
329
+ * @param callback - Callback to handle processed record
330
+ *
331
+ * @returns Resolves to processed KnowledgeInstance with HTTP metadata
332
+ */
333
+ updateWithHttpInfo(params: KnowledgeCore, headers?: any, callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
334
+ /**
335
+ * Provide a user-friendly representation
336
+ *
337
+ * @returns Object
338
+ */
339
+ toJSON(): {
340
+ name: string;
341
+ description: string;
342
+ source: KnowledgeSourceTypes;
343
+ id: string;
344
+ status: string;
345
+ createdAt: Date;
346
+ updatedAt: Date;
347
+ };
348
+ [inspect.custom](_depth: any, options: InspectOptions): string;
349
+ }
350
+ export interface KnowledgeSolution {
351
+ kbId: string;
352
+ }
353
+ export interface KnowledgeListInstance {
354
+ _version: V2;
355
+ _solution: KnowledgeSolution;
356
+ _uri: string;
357
+ (knowledgeId: string): KnowledgeContext;
358
+ get(knowledgeId: string): KnowledgeContext;
359
+ /**
360
+ * Create a KnowledgeInstance
361
+ *
362
+ * @param params - Body for request
363
+ * @param headers - header params for request
364
+ * @param callback - Callback to handle processed record
365
+ *
366
+ * @returns Resolves to processed KnowledgeInstance
367
+ */
368
+ create(params: KnowledgeCore, headers?: any, callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
369
+ /**
370
+ * Create a KnowledgeInstance and return HTTP info
371
+ *
372
+ * @param params - Body for request
373
+ * @param headers - header params for request
374
+ * @param callback - Callback to handle processed record
375
+ *
376
+ * @returns Resolves to processed KnowledgeInstance with HTTP metadata
377
+ */
378
+ createWithHttpInfo(params: KnowledgeCore, headers?: any, callback?: (error: Error | null, item?: ApiResponse<KnowledgeInstance>) => any): Promise<ApiResponse<KnowledgeInstance>>;
379
+ /**
380
+ * Streams KnowledgeInstance records from the API.
381
+ *
382
+ * This operation lazily loads records as efficiently as possible until the limit
383
+ * is reached.
384
+ *
385
+ * The results are passed into the callback function, so this operation is memory
386
+ * efficient.
387
+ *
388
+ * If a function is passed as the first argument, it will be used as the callback
389
+ * function.
390
+ *
391
+ * @param { KnowledgeListInstanceEachOptions } [params] - Options for request
392
+ * @param { function } [callback] - Function to process each record
393
+ */
394
+ each(callback?: (item: KnowledgeInstance, done: (err?: Error) => void) => void): void;
395
+ each(params: KnowledgeListInstanceEachOptions, callback?: (item: KnowledgeInstance, done: (err?: Error) => void) => void): void;
396
+ /**
397
+ * Streams KnowledgeInstance records from the API with HTTP metadata captured per page.
398
+ *
399
+ * This operation lazily loads records as efficiently as possible until the limit
400
+ * is reached. HTTP metadata (status code, headers) is captured for each page request.
401
+ *
402
+ * The results are passed into the callback function, so this operation is memory
403
+ * efficient.
404
+ *
405
+ * If a function is passed as the first argument, it will be used as the callback
406
+ * function.
407
+ *
408
+ * @param { KnowledgeListInstanceEachOptions } [params] - Options for request
409
+ * @param { function } [callback] - Function to process each record
410
+ */
411
+ eachWithHttpInfo(callback?: (item: KnowledgeInstance, done: (err?: Error) => void) => void): void;
412
+ eachWithHttpInfo(params: KnowledgeListInstanceEachOptions, callback?: (item: KnowledgeInstance, done: (err?: Error) => void) => void): void;
413
+ /**
414
+ * Retrieve a single target page of KnowledgeInstance records from the API.
415
+ *
416
+ * The request is executed immediately.
417
+ *
418
+ * @param { string } [targetUrl] - API-generated URL for the requested results page
419
+ * @param { function } [callback] - Callback to handle list of records
420
+ */
421
+ getPage(targetUrl: string, callback?: (error: Error | null, items: KnowledgePage) => any): Promise<KnowledgePage>;
422
+ /**
423
+ * Retrieve a single target page of KnowledgeInstance records from the API with HTTP metadata.
424
+ *
425
+ * The request is executed immediately.
426
+ *
427
+ * @param { string } [targetUrl] - API-generated URL for the requested results page
428
+ * @param { function } [callback] - Callback to handle list of records with metadata
429
+ */
430
+ getPageWithHttpInfo(targetUrl: string, callback?: (error: Error | null, items: ApiResponse<KnowledgePage>) => any): Promise<ApiResponse<KnowledgePage>>;
431
+ /**
432
+ * Lists KnowledgeInstance records from the API as a list.
433
+ *
434
+ * If a function is passed as the first argument, it will be used as the callback
435
+ * function.
436
+ *
437
+ * @param { KnowledgeListInstanceOptions } [params] - Options for request
438
+ * @param { function } [callback] - Callback to handle list of records
439
+ */
440
+ list(callback?: (error: Error | null, items: KnowledgeInstance[]) => any): Promise<KnowledgeInstance[]>;
441
+ list(params: KnowledgeListInstanceOptions, callback?: (error: Error | null, items: KnowledgeInstance[]) => any): Promise<KnowledgeInstance[]>;
442
+ /**
443
+ * Lists KnowledgeInstance records from the API as a list with HTTP metadata.
444
+ *
445
+ * Returns all records along with HTTP metadata from the first page fetched.
446
+ *
447
+ * If a function is passed as the first argument, it will be used as the callback
448
+ * function.
449
+ *
450
+ * @param { KnowledgeListInstanceOptions } [params] - Options for request
451
+ * @param { function } [callback] - Callback to handle list of records with metadata
452
+ */
453
+ listWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<KnowledgeInstance[]>) => any): Promise<ApiResponse<KnowledgeInstance[]>>;
454
+ listWithHttpInfo(params: KnowledgeListInstanceOptions, callback?: (error: Error | null, items: ApiResponse<KnowledgeInstance[]>) => any): Promise<ApiResponse<KnowledgeInstance[]>>;
455
+ /**
456
+ * Retrieve a single page of KnowledgeInstance records from the API.
457
+ *
458
+ * The request is executed immediately.
459
+ *
460
+ * If a function is passed as the first argument, it will be used as the callback
461
+ * function.
462
+ *
463
+ * @param { KnowledgeListInstancePageOptions } [params] - Options for request
464
+ * @param { function } [callback] - Callback to handle list of records
465
+ */
466
+ page(callback?: (error: Error | null, items: KnowledgePage) => any): Promise<KnowledgePage>;
467
+ page(params: KnowledgeListInstancePageOptions, callback?: (error: Error | null, items: KnowledgePage) => any): Promise<KnowledgePage>;
468
+ /**
469
+ * Retrieve a single page of KnowledgeInstance records from the API with HTTP metadata.
470
+ *
471
+ * The request is executed immediately.
472
+ *
473
+ * If a function is passed as the first argument, it will be used as the callback
474
+ * function.
475
+ *
476
+ * @param { KnowledgeListInstancePageOptions } [params] - Options for request
477
+ * @param { function } [callback] - Callback to handle list of records with metadata
478
+ */
479
+ pageWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<KnowledgePage>) => any): Promise<ApiResponse<KnowledgePage>>;
480
+ pageWithHttpInfo(params: KnowledgeListInstancePageOptions, callback?: (error: Error | null, items: ApiResponse<KnowledgePage>) => any): Promise<ApiResponse<KnowledgePage>>;
481
+ /**
482
+ * Provide a user-friendly representation
483
+ */
484
+ toJSON(): any;
485
+ [inspect.custom](_depth: any, options: InspectOptions): any;
486
+ }
487
+ export declare function KnowledgeListInstance(version: V2, kbId: string): KnowledgeListInstance;
488
+ export declare class KnowledgePage extends TokenPage<V2, KnowledgePayload, KnowledgeResource, KnowledgeInstance> {
489
+ /**
490
+ * Initialize the KnowledgePage
491
+ *
492
+ * @param version - Version of the resource
493
+ * @param response - Response from the API
494
+ * @param uri - URI of the resource
495
+ * @param params - Query parameters
496
+ * @param solution - Path solution
497
+ */
498
+ constructor(version: V2, response: Response<string>, uri: string, params: any, solution: KnowledgeSolution);
499
+ /**
500
+ * Build an instance of KnowledgeInstance
501
+ *
502
+ * @param payload - Payload response from the API
503
+ */
504
+ getInstance(payload: KnowledgeResource): KnowledgeInstance;
505
+ [inspect.custom](depth: any, options: InspectOptions): string;
506
+ }
507
+ export {};