@snap/push2web 0.11.0 → 0.13.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 (40) hide show
  1. package/dist/Push2WebSDKExtension.js +1 -1
  2. package/dist/generated-api-client/camera_kit/v3/export.d.ts +0 -59
  3. package/dist/generated-api-client/camera_kit/v3/export.js +0 -10
  4. package/dist/generated-api-client/camera_kit/v3/lens.d.ts +0 -55
  5. package/dist/generated-api-client/camera_kit/v3/lens.js +0 -12
  6. package/dist/generated-api-client/camera_kit/v3/push_to_device.d.ts +0 -58
  7. package/dist/generated-api-client/camera_kit/v3/push_to_device.js +0 -16
  8. package/dist/generated-api-client/core/snap_status_code.d.ts +0 -209
  9. package/dist/generated-api-client/core/snap_status_code.js +0 -200
  10. package/dist/generated-api-client/google/protobuf/any.d.ts +0 -105
  11. package/dist/generated-api-client/google/protobuf/any.js +0 -1
  12. package/docs/html/.nojekyll +1 -0
  13. package/docs/html/assets/highlight.css +78 -0
  14. package/docs/html/assets/main.js +58 -0
  15. package/docs/html/assets/search.js +1 -0
  16. package/docs/html/assets/style.css +1367 -0
  17. package/docs/html/classes/Push2Web.html +159 -0
  18. package/docs/html/enums/Code.html +198 -0
  19. package/docs/html/enums/ListenLensPushResponse_ExcludedLens_Code.html +98 -0
  20. package/docs/html/enums/State.html +79 -0
  21. package/docs/html/index.html +89 -0
  22. package/docs/html/interfaces/Lens.html +143 -0
  23. package/docs/html/modules.html +68 -0
  24. package/docs/html/types/CommunicationErrorEvent.html +76 -0
  25. package/docs/html/types/ErrorEvent.html +50 -0
  26. package/docs/html/types/GenericErrorEvent.html +66 -0
  27. package/docs/html/types/LensExcludedErrorEvent.html +76 -0
  28. package/docs/html/types/LensReceivedEvent.html +50 -0
  29. package/docs/html/types/Push2WebEvents.html +50 -0
  30. package/docs/html/types/SubscriptionChangedEvent.html +50 -0
  31. package/docs/html/types/SubscriptionInstance.html +80 -0
  32. package/docs/md/.nojekyll +1 -0
  33. package/docs/md/README.md +68 -0
  34. package/docs/md/classes/Push2Web.md +106 -0
  35. package/docs/md/enums/Code.md +197 -0
  36. package/docs/md/enums/ListenLensPushResponse_ExcludedLens_Code.md +57 -0
  37. package/docs/md/enums/State.md +26 -0
  38. package/docs/md/interfaces/Lens.md +95 -0
  39. package/docs/md/modules.md +118 -0
  40. package/package.json +4 -3
@@ -1,230 +1,31 @@
1
1
  import _m0 from "protobufjs/minimal";
2
2
  export declare const protobufPackage = "snapchat.core";
3
- /**
4
- * These codes borrow heavily from the GRPC status codes.
5
- *
6
- * Sometimes multiple error codes may apply. Services should return
7
- * the most specific error code that applies. For example, prefer
8
- * `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
9
- * Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
10
- */
11
3
  export declare enum Code {
12
- /**
13
- * OK - Not an error; returned on success
14
- *
15
- * HTTP Mapping: 200 OK
16
- */
17
4
  OK = "OK",
18
- /**
19
- * CANCELLED - The operation was cancelled, typically by the caller.
20
- *
21
- * HTTP Mapping: 499 Client Closed Request
22
- */
23
5
  CANCELLED = "CANCELLED",
24
- /**
25
- * UNKNOWN - Unknown error. For example, this error may be returned when
26
- * a `Status` value received from another address space belongs to
27
- * an error space that is not known in this address space. Also
28
- * errors raised by APIs that do not return enough error information
29
- * may be converted to this error.
30
- *
31
- * HTTP Mapping: 500 Internal Server Error
32
- */
33
6
  UNKNOWN = "UNKNOWN",
34
- /**
35
- * INVALID_ARGUMENT - The client specified an invalid argument. Note that this differs
36
- * from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments
37
- * that are problematic regardless of the state of the system
38
- * (e.g., a malformed file name).
39
- *
40
- * HTTP Mapping: 400 Bad Request
41
- */
42
7
  INVALID_ARGUMENT = "INVALID_ARGUMENT",
43
- /**
44
- * DEADLINE_EXCEEDED - The deadline expired before the operation could complete. For operations
45
- * that change the state of the system, this error may be returned
46
- * even if the operation has completed successfully. For example, a
47
- * successful response from a server could have been delayed long
48
- * enough for the deadline to expire.
49
- *
50
- * HTTP Mapping: 504 Gateway Timeout
51
- */
52
8
  DEADLINE_EXCEEDED = "DEADLINE_EXCEEDED",
53
- /**
54
- * NOT_FOUND - Some requested entity (e.g., file or directory) was not found.
55
- *
56
- * Note to server developers: if a request is denied for an entire class
57
- * of users, such as gradual feature rollout or undocumented whitelist,
58
- * `NOT_FOUND` may be used. If a request is denied for some users within
59
- * a class of users, such as user-based access control, `PERMISSION_DENIED`
60
- * must be used.
61
- *
62
- * HTTP Mapping: 404 Not Found
63
- */
64
9
  NOT_FOUND = "NOT_FOUND",
65
- /**
66
- * ALREADY_EXISTS - The entity that a client attempted to create (e.g., file or directory)
67
- * already exists.
68
- *
69
- * HTTP Mapping: 409 Conflict
70
- */
71
10
  ALREADY_EXISTS = "ALREADY_EXISTS",
72
- /**
73
- * PERMISSION_DENIED - The caller does not have permission to execute the specified
74
- * operation. `PERMISSION_DENIED` must not be used for rejections
75
- * caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
76
- * instead for those errors). `PERMISSION_DENIED` must not be
77
- * used if the caller can not be identified (use `UNAUTHENTICATED`
78
- * instead for those errors). This error code does not imply the
79
- * request is valid or the requested entity exists or satisfies
80
- * other pre-conditions.
81
- *
82
- * HTTP Mapping: 403 Forbidden
83
- */
84
11
  PERMISSION_DENIED = "PERMISSION_DENIED",
85
- /**
86
- * UNAUTHENTICATED - The request does not have valid authentication credentials for the
87
- * operation.
88
- *
89
- * HTTP Mapping: 401 Unauthorized
90
- */
91
12
  UNAUTHENTICATED = "UNAUTHENTICATED",
92
- /**
93
- * RESOURCE_EXHAUSTED - Some resource has been exhausted, perhaps a per-user quota, or
94
- * perhaps the entire file system is out of space.
95
- *
96
- * HTTP Mapping: 429 Too Many Requests
97
- */
98
13
  RESOURCE_EXHAUSTED = "RESOURCE_EXHAUSTED",
99
- /**
100
- * FAILED_PRECONDITION - The operation was rejected because the system is not in a state
101
- * required for the operation's execution. For example, the directory
102
- * to be deleted is non-empty, an rmdir operation is applied to
103
- * a non-directory, etc.
104
- *
105
- * Service implementors can use the following guidelines to decide
106
- * between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
107
- * (a) Use `UNAVAILABLE` if the client can retry just the failing call.
108
- * (b) Use `ABORTED` if the client should retry at a higher level
109
- * (e.g., when a client-specified test-and-set fails, indicating the
110
- * client should restart a read-modify-write sequence).
111
- * (c) Use `FAILED_PRECONDITION` if the client should not retry until
112
- * the system state has been explicitly fixed. E.g., if an "rmdir"
113
- * fails because the directory is non-empty, `FAILED_PRECONDITION`
114
- * should be returned since the client should not retry unless
115
- * the files are deleted from the directory.
116
- *
117
- * HTTP Mapping: 400 Bad Request
118
- */
119
14
  FAILED_PRECONDITION = "FAILED_PRECONDITION",
120
- /**
121
- * ABORTED - The operation was aborted, typically due to a concurrency issue such as
122
- * a sequencer check failure or transaction abort.
123
- *
124
- * See the guidelines above for deciding between `FAILED_PRECONDITION`,
125
- * `ABORTED`, and `UNAVAILABLE`.
126
- *
127
- * HTTP Mapping: 409 Conflict
128
- */
129
15
  ABORTED = "ABORTED",
130
- /**
131
- * OUT_OF_RANGE - The operation was attempted past the valid range. E.g., seeking or
132
- * reading past end-of-file.
133
- *
134
- * Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
135
- * be fixed if the system state changes. For example, a 32-bit file
136
- * system will generate `INVALID_ARGUMENT` if asked to read at an
137
- * offset that is not in the range [0,2^32-1], but it will generate
138
- * `OUT_OF_RANGE` if asked to read from an offset past the current
139
- * file size.
140
- *
141
- * There is a fair bit of overlap between `FAILED_PRECONDITION` and
142
- * `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific
143
- * error) when it applies so that callers who are iterating through
144
- * a space can easily look for an `OUT_OF_RANGE` error to detect when
145
- * they are done.
146
- *
147
- * HTTP Mapping: 400 Bad Request
148
- */
149
16
  OUT_OF_RANGE = "OUT_OF_RANGE",
150
- /**
151
- * UNIMPLEMENTED - The operation is not implemented or is not supported/enabled in this
152
- * service.
153
- *
154
- * HTTP Mapping: 501 Not Implemented
155
- */
156
17
  UNIMPLEMENTED = "UNIMPLEMENTED",
157
- /**
158
- * INTERNAL - Internal errors. This means that some invariants expected by the
159
- * underlying system have been broken. This error code is reserved
160
- * for serious errors.
161
- *
162
- * HTTP Mapping: 500 Internal Server Error
163
- */
164
18
  INTERNAL = "INTERNAL",
165
- /**
166
- * UNAVAILABLE - The service is currently unavailable. This is most likely a
167
- * transient condition, which can be corrected by retrying with
168
- * a backoff.
169
- *
170
- * See the guidelines above for deciding between `FAILED_PRECONDITION`,
171
- * `ABORTED`, and `UNAVAILABLE`.
172
- *
173
- * HTTP Mapping: 503 Service Unavailable
174
- */
175
19
  UNAVAILABLE = "UNAVAILABLE",
176
- /**
177
- * DATA_LOSS - Unrecoverable data loss or corruption.
178
- *
179
- * HTTP Mapping: 500 Internal Server Error
180
- */
181
20
  DATA_LOSS = "DATA_LOSS",
182
- /** NOT_MODIFIED - Equivalent to HTTP 304 not modified */
183
21
  NOT_MODIFIED = "NOT_MODIFIED",
184
- /**
185
- * DECRYPTION_FAILED - Decryption failed. Similar to DATA_LOSS ("Unrecoverable data loss or corruption."),
186
- * but HTTP should map to 400 Bad Request, not 500 Internal Server Error.
187
- * This is not-retriable.
188
- */
189
22
  DECRYPTION_FAILED = "DECRYPTION_FAILED",
190
- /**
191
- * INVALID_MEDIA - Invalid media. For example: you request an HLS manifest on a still picture, or pngquant on non-png.
192
- * HTTP should map to 400 Bad Request. This is not-retriable.
193
- */
194
23
  INVALID_MEDIA = "INVALID_MEDIA",
195
- /**
196
- * IN_PROGRESS - Use to signal that ingestion is in progress and we don't have a result yet.
197
- * It can be used for other similar processes.
198
- */
199
24
  IN_PROGRESS = "IN_PROGRESS",
200
- /**
201
- * CONTENT_TOO_LARGE - BOLT can optionally check for content size, before ingestion.
202
- * This error code signals that the content is too large to be ingested into BOLT.
203
- * Maximum object size can be specified per use case or per ingestion request.
204
- */
205
25
  CONTENT_TOO_LARGE = "CONTENT_TOO_LARGE",
206
- /**
207
- * URL_PROTOCOL_NOT_SUPPORTED - BOLT can only download content from URL protocols HTTP and HTTPS.
208
- * This error code will be returned if the URL provided in an ingestion request has a different protocol.
209
- */
210
26
  URL_PROTOCOL_NOT_SUPPORTED = "URL_PROTOCOL_NOT_SUPPORTED",
211
- /**
212
- * URL_CONTENT_TYPE_NOT_WHITELISTED - Content downloaded from a URL has to have its content-type header whitelisted for the use case making
213
- * the ingestion request.
214
- * This error signals that the URL has a content-type not whitelisted for the use case.
215
- */
216
27
  URL_CONTENT_TYPE_NOT_WHITELISTED = "URL_CONTENT_TYPE_NOT_WHITELISTED",
217
- /**
218
- * URL_DOWNLOAD_FAILURE - This error signals that BOLT failed to download content from the URL provided in the ingestion request.
219
- * The HTTP status code is reported in error_code.
220
- */
221
28
  URL_DOWNLOAD_FAILURE = "URL_DOWNLOAD_FAILURE",
222
- /**
223
- * CLOUD_STORAGE_FAILURE - This error signals that BOLT failed to carry out a cloud storage operation.
224
- * This can happen when getting content size from the external bucket provided in the ingestion request or when
225
- * trying to do the first copy to a BOLT bucket.
226
- * The HTTP status code is reported in error code.
227
- */
228
29
  CLOUD_STORAGE_FAILURE = "CLOUD_STORAGE_FAILURE",
229
30
  UNRECOGNIZED = "UNRECOGNIZED"
230
31
  }
@@ -232,19 +33,9 @@ export declare function codeFromJSON(object: any): Code;
232
33
  export declare function codeToJSON(object: Code): string;
233
34
  export declare function codeToNumber(object: Code): number;
234
35
  export interface CodeProperties {
235
- /**
236
- * An error code, specific to a give Code, to help identifying an error condition.
237
- * For example, for Code URL_DOWNLOAD_FAILURE this indicates the HTTP response code.
238
- */
239
36
  errorCode: number;
240
- /** This might contain a description of the error condition. */
241
37
  errorDescription: string;
242
- /** A value indicating whether Code is retryable. */
243
38
  isRetryable: boolean;
244
- /**
245
- * The source reporting the error condition.
246
- * For example, Bolt/MOSS/VideoEncoding.
247
- */
248
39
  source: string;
249
40
  }
250
41
  export declare const CodeProperties: {
@@ -1,233 +1,33 @@
1
- /* eslint-disable */
2
1
  import Long from "long";
3
2
  import _m0 from "protobufjs/minimal";
4
3
  export const protobufPackage = "snapchat.core";
5
- /**
6
- * These codes borrow heavily from the GRPC status codes.
7
- *
8
- * Sometimes multiple error codes may apply. Services should return
9
- * the most specific error code that applies. For example, prefer
10
- * `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
11
- * Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
12
- */
13
4
  export var Code;
14
5
  (function (Code) {
15
- /**
16
- * OK - Not an error; returned on success
17
- *
18
- * HTTP Mapping: 200 OK
19
- */
20
6
  Code["OK"] = "OK";
21
- /**
22
- * CANCELLED - The operation was cancelled, typically by the caller.
23
- *
24
- * HTTP Mapping: 499 Client Closed Request
25
- */
26
7
  Code["CANCELLED"] = "CANCELLED";
27
- /**
28
- * UNKNOWN - Unknown error. For example, this error may be returned when
29
- * a `Status` value received from another address space belongs to
30
- * an error space that is not known in this address space. Also
31
- * errors raised by APIs that do not return enough error information
32
- * may be converted to this error.
33
- *
34
- * HTTP Mapping: 500 Internal Server Error
35
- */
36
8
  Code["UNKNOWN"] = "UNKNOWN";
37
- /**
38
- * INVALID_ARGUMENT - The client specified an invalid argument. Note that this differs
39
- * from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments
40
- * that are problematic regardless of the state of the system
41
- * (e.g., a malformed file name).
42
- *
43
- * HTTP Mapping: 400 Bad Request
44
- */
45
9
  Code["INVALID_ARGUMENT"] = "INVALID_ARGUMENT";
46
- /**
47
- * DEADLINE_EXCEEDED - The deadline expired before the operation could complete. For operations
48
- * that change the state of the system, this error may be returned
49
- * even if the operation has completed successfully. For example, a
50
- * successful response from a server could have been delayed long
51
- * enough for the deadline to expire.
52
- *
53
- * HTTP Mapping: 504 Gateway Timeout
54
- */
55
10
  Code["DEADLINE_EXCEEDED"] = "DEADLINE_EXCEEDED";
56
- /**
57
- * NOT_FOUND - Some requested entity (e.g., file or directory) was not found.
58
- *
59
- * Note to server developers: if a request is denied for an entire class
60
- * of users, such as gradual feature rollout or undocumented whitelist,
61
- * `NOT_FOUND` may be used. If a request is denied for some users within
62
- * a class of users, such as user-based access control, `PERMISSION_DENIED`
63
- * must be used.
64
- *
65
- * HTTP Mapping: 404 Not Found
66
- */
67
11
  Code["NOT_FOUND"] = "NOT_FOUND";
68
- /**
69
- * ALREADY_EXISTS - The entity that a client attempted to create (e.g., file or directory)
70
- * already exists.
71
- *
72
- * HTTP Mapping: 409 Conflict
73
- */
74
12
  Code["ALREADY_EXISTS"] = "ALREADY_EXISTS";
75
- /**
76
- * PERMISSION_DENIED - The caller does not have permission to execute the specified
77
- * operation. `PERMISSION_DENIED` must not be used for rejections
78
- * caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
79
- * instead for those errors). `PERMISSION_DENIED` must not be
80
- * used if the caller can not be identified (use `UNAUTHENTICATED`
81
- * instead for those errors). This error code does not imply the
82
- * request is valid or the requested entity exists or satisfies
83
- * other pre-conditions.
84
- *
85
- * HTTP Mapping: 403 Forbidden
86
- */
87
13
  Code["PERMISSION_DENIED"] = "PERMISSION_DENIED";
88
- /**
89
- * UNAUTHENTICATED - The request does not have valid authentication credentials for the
90
- * operation.
91
- *
92
- * HTTP Mapping: 401 Unauthorized
93
- */
94
14
  Code["UNAUTHENTICATED"] = "UNAUTHENTICATED";
95
- /**
96
- * RESOURCE_EXHAUSTED - Some resource has been exhausted, perhaps a per-user quota, or
97
- * perhaps the entire file system is out of space.
98
- *
99
- * HTTP Mapping: 429 Too Many Requests
100
- */
101
15
  Code["RESOURCE_EXHAUSTED"] = "RESOURCE_EXHAUSTED";
102
- /**
103
- * FAILED_PRECONDITION - The operation was rejected because the system is not in a state
104
- * required for the operation's execution. For example, the directory
105
- * to be deleted is non-empty, an rmdir operation is applied to
106
- * a non-directory, etc.
107
- *
108
- * Service implementors can use the following guidelines to decide
109
- * between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
110
- * (a) Use `UNAVAILABLE` if the client can retry just the failing call.
111
- * (b) Use `ABORTED` if the client should retry at a higher level
112
- * (e.g., when a client-specified test-and-set fails, indicating the
113
- * client should restart a read-modify-write sequence).
114
- * (c) Use `FAILED_PRECONDITION` if the client should not retry until
115
- * the system state has been explicitly fixed. E.g., if an "rmdir"
116
- * fails because the directory is non-empty, `FAILED_PRECONDITION`
117
- * should be returned since the client should not retry unless
118
- * the files are deleted from the directory.
119
- *
120
- * HTTP Mapping: 400 Bad Request
121
- */
122
16
  Code["FAILED_PRECONDITION"] = "FAILED_PRECONDITION";
123
- /**
124
- * ABORTED - The operation was aborted, typically due to a concurrency issue such as
125
- * a sequencer check failure or transaction abort.
126
- *
127
- * See the guidelines above for deciding between `FAILED_PRECONDITION`,
128
- * `ABORTED`, and `UNAVAILABLE`.
129
- *
130
- * HTTP Mapping: 409 Conflict
131
- */
132
17
  Code["ABORTED"] = "ABORTED";
133
- /**
134
- * OUT_OF_RANGE - The operation was attempted past the valid range. E.g., seeking or
135
- * reading past end-of-file.
136
- *
137
- * Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
138
- * be fixed if the system state changes. For example, a 32-bit file
139
- * system will generate `INVALID_ARGUMENT` if asked to read at an
140
- * offset that is not in the range [0,2^32-1], but it will generate
141
- * `OUT_OF_RANGE` if asked to read from an offset past the current
142
- * file size.
143
- *
144
- * There is a fair bit of overlap between `FAILED_PRECONDITION` and
145
- * `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific
146
- * error) when it applies so that callers who are iterating through
147
- * a space can easily look for an `OUT_OF_RANGE` error to detect when
148
- * they are done.
149
- *
150
- * HTTP Mapping: 400 Bad Request
151
- */
152
18
  Code["OUT_OF_RANGE"] = "OUT_OF_RANGE";
153
- /**
154
- * UNIMPLEMENTED - The operation is not implemented or is not supported/enabled in this
155
- * service.
156
- *
157
- * HTTP Mapping: 501 Not Implemented
158
- */
159
19
  Code["UNIMPLEMENTED"] = "UNIMPLEMENTED";
160
- /**
161
- * INTERNAL - Internal errors. This means that some invariants expected by the
162
- * underlying system have been broken. This error code is reserved
163
- * for serious errors.
164
- *
165
- * HTTP Mapping: 500 Internal Server Error
166
- */
167
20
  Code["INTERNAL"] = "INTERNAL";
168
- /**
169
- * UNAVAILABLE - The service is currently unavailable. This is most likely a
170
- * transient condition, which can be corrected by retrying with
171
- * a backoff.
172
- *
173
- * See the guidelines above for deciding between `FAILED_PRECONDITION`,
174
- * `ABORTED`, and `UNAVAILABLE`.
175
- *
176
- * HTTP Mapping: 503 Service Unavailable
177
- */
178
21
  Code["UNAVAILABLE"] = "UNAVAILABLE";
179
- /**
180
- * DATA_LOSS - Unrecoverable data loss or corruption.
181
- *
182
- * HTTP Mapping: 500 Internal Server Error
183
- */
184
22
  Code["DATA_LOSS"] = "DATA_LOSS";
185
- /** NOT_MODIFIED - Equivalent to HTTP 304 not modified */
186
23
  Code["NOT_MODIFIED"] = "NOT_MODIFIED";
187
- /**
188
- * DECRYPTION_FAILED - Decryption failed. Similar to DATA_LOSS ("Unrecoverable data loss or corruption."),
189
- * but HTTP should map to 400 Bad Request, not 500 Internal Server Error.
190
- * This is not-retriable.
191
- */
192
24
  Code["DECRYPTION_FAILED"] = "DECRYPTION_FAILED";
193
- /**
194
- * INVALID_MEDIA - Invalid media. For example: you request an HLS manifest on a still picture, or pngquant on non-png.
195
- * HTTP should map to 400 Bad Request. This is not-retriable.
196
- */
197
25
  Code["INVALID_MEDIA"] = "INVALID_MEDIA";
198
- /**
199
- * IN_PROGRESS - Use to signal that ingestion is in progress and we don't have a result yet.
200
- * It can be used for other similar processes.
201
- */
202
26
  Code["IN_PROGRESS"] = "IN_PROGRESS";
203
- /**
204
- * CONTENT_TOO_LARGE - BOLT can optionally check for content size, before ingestion.
205
- * This error code signals that the content is too large to be ingested into BOLT.
206
- * Maximum object size can be specified per use case or per ingestion request.
207
- */
208
27
  Code["CONTENT_TOO_LARGE"] = "CONTENT_TOO_LARGE";
209
- /**
210
- * URL_PROTOCOL_NOT_SUPPORTED - BOLT can only download content from URL protocols HTTP and HTTPS.
211
- * This error code will be returned if the URL provided in an ingestion request has a different protocol.
212
- */
213
28
  Code["URL_PROTOCOL_NOT_SUPPORTED"] = "URL_PROTOCOL_NOT_SUPPORTED";
214
- /**
215
- * URL_CONTENT_TYPE_NOT_WHITELISTED - Content downloaded from a URL has to have its content-type header whitelisted for the use case making
216
- * the ingestion request.
217
- * This error signals that the URL has a content-type not whitelisted for the use case.
218
- */
219
29
  Code["URL_CONTENT_TYPE_NOT_WHITELISTED"] = "URL_CONTENT_TYPE_NOT_WHITELISTED";
220
- /**
221
- * URL_DOWNLOAD_FAILURE - This error signals that BOLT failed to download content from the URL provided in the ingestion request.
222
- * The HTTP status code is reported in error_code.
223
- */
224
30
  Code["URL_DOWNLOAD_FAILURE"] = "URL_DOWNLOAD_FAILURE";
225
- /**
226
- * CLOUD_STORAGE_FAILURE - This error signals that BOLT failed to carry out a cloud storage operation.
227
- * This can happen when getting content size from the external bucket provided in the ingestion request or when
228
- * trying to do the first copy to a BOLT bucket.
229
- * The HTTP status code is reported in error code.
230
- */
231
31
  Code["CLOUD_STORAGE_FAILURE"] = "CLOUD_STORAGE_FAILURE";
232
32
  Code["UNRECOGNIZED"] = "UNRECOGNIZED";
233
33
  })(Code || (Code = {}));
@@ -1,112 +1,7 @@
1
1
  import _m0 from "protobufjs/minimal";
2
2
  export declare const protobufPackage = "google.protobuf";
3
- /**
4
- * `Any` contains an arbitrary serialized protocol buffer message along with a
5
- * URL that describes the type of the serialized message.
6
- *
7
- * Protobuf library provides support to pack/unpack Any values in the form
8
- * of utility functions or additional generated methods of the Any type.
9
- *
10
- * Example 1: Pack and unpack a message in C++.
11
- *
12
- * Foo foo = ...;
13
- * Any any;
14
- * any.PackFrom(foo);
15
- * ...
16
- * if (any.UnpackTo(&foo)) {
17
- * ...
18
- * }
19
- *
20
- * Example 2: Pack and unpack a message in Java.
21
- *
22
- * Foo foo = ...;
23
- * Any any = Any.pack(foo);
24
- * ...
25
- * if (any.is(Foo.class)) {
26
- * foo = any.unpack(Foo.class);
27
- * }
28
- *
29
- * Example 3: Pack and unpack a message in Python.
30
- *
31
- * foo = Foo(...)
32
- * any = Any()
33
- * any.Pack(foo)
34
- * ...
35
- * if any.Is(Foo.DESCRIPTOR):
36
- * any.Unpack(foo)
37
- * ...
38
- *
39
- * Example 4: Pack and unpack a message in Go
40
- *
41
- * foo := &pb.Foo{...}
42
- * any, err := ptypes.MarshalAny(foo)
43
- * ...
44
- * foo := &pb.Foo{}
45
- * if err := ptypes.UnmarshalAny(any, foo); err != nil {
46
- * ...
47
- * }
48
- *
49
- * The pack methods provided by protobuf library will by default use
50
- * 'type.googleapis.com/full.type.name' as the type URL and the unpack
51
- * methods only use the fully qualified type name after the last '/'
52
- * in the type URL, for example "foo.bar.com/x/y.z" will yield type
53
- * name "y.z".
54
- *
55
- *
56
- * JSON
57
- * ====
58
- * The JSON representation of an `Any` value uses the regular
59
- * representation of the deserialized, embedded message, with an
60
- * additional field `@type` which contains the type URL. Example:
61
- *
62
- * package google.profile;
63
- * message Person {
64
- * string first_name = 1;
65
- * string last_name = 2;
66
- * }
67
- *
68
- * {
69
- * "@type": "type.googleapis.com/google.profile.Person",
70
- * "firstName": <string>,
71
- * "lastName": <string>
72
- * }
73
- *
74
- * If the embedded message type is well-known and has a custom JSON
75
- * representation, that representation will be embedded adding a field
76
- * `value` which holds the custom JSON in addition to the `@type`
77
- * field. Example (for message [google.protobuf.Duration][]):
78
- *
79
- * {
80
- * "@type": "type.googleapis.com/google.protobuf.Duration",
81
- * "value": "1.212s"
82
- * }
83
- */
84
3
  export interface Any {
85
- /**
86
- * A URL/resource name whose content describes the type of the
87
- * serialized protocol buffer message.
88
- *
89
- * For URLs which use the scheme `http`, `https`, or no scheme, the
90
- * following restrictions and interpretations apply:
91
- *
92
- * * If no scheme is provided, `https` is assumed.
93
- * * The last segment of the URL's path must represent the fully
94
- * qualified name of the type (as in `path/google.protobuf.Duration`).
95
- * The name should be in a canonical form (e.g., leading "." is
96
- * not accepted).
97
- * * An HTTP GET on the URL must yield a [google.protobuf.Type][]
98
- * value in binary format, or produce an error.
99
- * * Applications are allowed to cache lookup results based on the
100
- * URL, or have them precompiled into a binary to avoid any
101
- * lookup. Therefore, binary compatibility needs to be preserved
102
- * on changes to types. (Use versioned type names to manage
103
- * breaking changes.)
104
- *
105
- * Schemes other than `http`, `https` (or the empty scheme) might be
106
- * used with implementation specific semantics.
107
- */
108
4
  typeUrl: string;
109
- /** Must be a valid serialized protocol buffer of the above specified type. */
110
5
  value: Uint8Array;
111
6
  }
112
7
  export declare const Any: {
@@ -1,4 +1,3 @@
1
- /* eslint-disable */
2
1
  import Long from "long";
3
2
  import _m0 from "protobufjs/minimal";
4
3
  export const protobufPackage = "google.protobuf";
@@ -0,0 +1 @@
1
+ TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
@@ -0,0 +1,78 @@
1
+ :root {
2
+ --light-hl-0: #000000;
3
+ --dark-hl-0: #D4D4D4;
4
+ --light-hl-1: #0070C1;
5
+ --dark-hl-1: #4FC1FF;
6
+ --light-hl-2: #001080;
7
+ --dark-hl-2: #9CDCFE;
8
+ --light-hl-3: #AF00DB;
9
+ --dark-hl-3: #C586C0;
10
+ --light-hl-4: #A31515;
11
+ --dark-hl-4: #CE9178;
12
+ --light-hl-5: #0000FF;
13
+ --dark-hl-5: #569CD6;
14
+ --light-hl-6: #795E26;
15
+ --dark-hl-6: #DCDCAA;
16
+ --light-hl-7: #000000FF;
17
+ --dark-hl-7: #D4D4D4;
18
+ --light-code-background: #FFFFFF;
19
+ --dark-code-background: #1E1E1E;
20
+ }
21
+
22
+ @media (prefers-color-scheme: light) { :root {
23
+ --hl-0: var(--light-hl-0);
24
+ --hl-1: var(--light-hl-1);
25
+ --hl-2: var(--light-hl-2);
26
+ --hl-3: var(--light-hl-3);
27
+ --hl-4: var(--light-hl-4);
28
+ --hl-5: var(--light-hl-5);
29
+ --hl-6: var(--light-hl-6);
30
+ --hl-7: var(--light-hl-7);
31
+ --code-background: var(--light-code-background);
32
+ } }
33
+
34
+ @media (prefers-color-scheme: dark) { :root {
35
+ --hl-0: var(--dark-hl-0);
36
+ --hl-1: var(--dark-hl-1);
37
+ --hl-2: var(--dark-hl-2);
38
+ --hl-3: var(--dark-hl-3);
39
+ --hl-4: var(--dark-hl-4);
40
+ --hl-5: var(--dark-hl-5);
41
+ --hl-6: var(--dark-hl-6);
42
+ --hl-7: var(--dark-hl-7);
43
+ --code-background: var(--dark-code-background);
44
+ } }
45
+
46
+ :root[data-theme='light'] {
47
+ --hl-0: var(--light-hl-0);
48
+ --hl-1: var(--light-hl-1);
49
+ --hl-2: var(--light-hl-2);
50
+ --hl-3: var(--light-hl-3);
51
+ --hl-4: var(--light-hl-4);
52
+ --hl-5: var(--light-hl-5);
53
+ --hl-6: var(--light-hl-6);
54
+ --hl-7: var(--light-hl-7);
55
+ --code-background: var(--light-code-background);
56
+ }
57
+
58
+ :root[data-theme='dark'] {
59
+ --hl-0: var(--dark-hl-0);
60
+ --hl-1: var(--dark-hl-1);
61
+ --hl-2: var(--dark-hl-2);
62
+ --hl-3: var(--dark-hl-3);
63
+ --hl-4: var(--dark-hl-4);
64
+ --hl-5: var(--dark-hl-5);
65
+ --hl-6: var(--dark-hl-6);
66
+ --hl-7: var(--dark-hl-7);
67
+ --code-background: var(--dark-code-background);
68
+ }
69
+
70
+ .hl-0 { color: var(--hl-0); }
71
+ .hl-1 { color: var(--hl-1); }
72
+ .hl-2 { color: var(--hl-2); }
73
+ .hl-3 { color: var(--hl-3); }
74
+ .hl-4 { color: var(--hl-4); }
75
+ .hl-5 { color: var(--hl-5); }
76
+ .hl-6 { color: var(--hl-6); }
77
+ .hl-7 { color: var(--hl-7); }
78
+ pre, code { background: var(--code-background); }