@snap/push2web 0.11.0

package/dist/generated-api-client/core/snap_status_code.d.ts

@@ -0,0 +1,281 @@
+import _m0 from "protobufjs/minimal";
+export declare const protobufPackage = "snapchat.core";
+/**
+ * These codes borrow heavily from the GRPC status codes.
+ *
+ * Sometimes multiple error codes may apply.  Services should return
+ * the most specific error code that applies.  For example, prefer
+ * `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
+ * Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
+ */
+export declare enum Code {
+    /**
+     * OK - Not an error; returned on success
+     *
+     * HTTP Mapping: 200 OK
+     */
+    OK = "OK",
+    /**
+     * CANCELLED - The operation was cancelled, typically by the caller.
+     *
+     * HTTP Mapping: 499 Client Closed Request
+     */
+    CANCELLED = "CANCELLED",
+    /**
+     * UNKNOWN - Unknown error.  For example, this error may be returned when
+     * a `Status` value received from another address space belongs to
+     * an error space that is not known in this address space.  Also
+     * errors raised by APIs that do not return enough error information
+     * may be converted to this error.
+     *
+     * HTTP Mapping: 500 Internal Server Error
+     */
+    UNKNOWN = "UNKNOWN",
+    /**
+     * INVALID_ARGUMENT - The client specified an invalid argument.  Note that this differs
+     * from `FAILED_PRECONDITION`.  `INVALID_ARGUMENT` indicates arguments
+     * that are problematic regardless of the state of the system
+     * (e.g., a malformed file name).
+     *
+     * HTTP Mapping: 400 Bad Request
+     */
+    INVALID_ARGUMENT = "INVALID_ARGUMENT",
+    /**
+     * DEADLINE_EXCEEDED - The deadline expired before the operation could complete. For operations
+     * that change the state of the system, this error may be returned
+     * even if the operation has completed successfully.  For example, a
+     * successful response from a server could have been delayed long
+     * enough for the deadline to expire.
+     *
+     * HTTP Mapping: 504 Gateway Timeout
+     */
+    DEADLINE_EXCEEDED = "DEADLINE_EXCEEDED",
+    /**
+     * NOT_FOUND - Some requested entity (e.g., file or directory) was not found.
+     *
+     * Note to server developers: if a request is denied for an entire class
+     * of users, such as gradual feature rollout or undocumented whitelist,
+     * `NOT_FOUND` may be used. If a request is denied for some users within
+     * a class of users, such as user-based access control, `PERMISSION_DENIED`
+     * must be used.
+     *
+     * HTTP Mapping: 404 Not Found
+     */
+    NOT_FOUND = "NOT_FOUND",
+    /**
+     * ALREADY_EXISTS - The entity that a client attempted to create (e.g., file or directory)
+     * already exists.
+     *
+     * HTTP Mapping: 409 Conflict
+     */
+    ALREADY_EXISTS = "ALREADY_EXISTS",
+    /**
+     * PERMISSION_DENIED - The caller does not have permission to execute the specified
+     * operation. `PERMISSION_DENIED` must not be used for rejections
+     * caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
+     * instead for those errors). `PERMISSION_DENIED` must not be
+     * used if the caller can not be identified (use `UNAUTHENTICATED`
+     * instead for those errors). This error code does not imply the
+     * request is valid or the requested entity exists or satisfies
+     * other pre-conditions.
+     *
+     * HTTP Mapping: 403 Forbidden
+     */
+    PERMISSION_DENIED = "PERMISSION_DENIED",
+    /**
+     * UNAUTHENTICATED - The request does not have valid authentication credentials for the
+     * operation.
+     *
+     * HTTP Mapping: 401 Unauthorized
+     */
+    UNAUTHENTICATED = "UNAUTHENTICATED",
+    /**
+     * RESOURCE_EXHAUSTED - Some resource has been exhausted, perhaps a per-user quota, or
+     * perhaps the entire file system is out of space.
+     *
+     * HTTP Mapping: 429 Too Many Requests
+     */
+    RESOURCE_EXHAUSTED = "RESOURCE_EXHAUSTED",
+    /**
+     * FAILED_PRECONDITION - The operation was rejected because the system is not in a state
+     * required for the operation's execution.  For example, the directory
+     * to be deleted is non-empty, an rmdir operation is applied to
+     * a non-directory, etc.
+     *
+     * Service implementors can use the following guidelines to decide
+     * between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
+     *  (a) Use `UNAVAILABLE` if the client can retry just the failing call.
+     *  (b) Use `ABORTED` if the client should retry at a higher level
+     *      (e.g., when a client-specified test-and-set fails, indicating the
+     *      client should restart a read-modify-write sequence).
+     *  (c) Use `FAILED_PRECONDITION` if the client should not retry until
+     *      the system state has been explicitly fixed.  E.g., if an "rmdir"
+     *      fails because the directory is non-empty, `FAILED_PRECONDITION`
+     *      should be returned since the client should not retry unless
+     *      the files are deleted from the directory.
+     *
+     * HTTP Mapping: 400 Bad Request
+     */
+    FAILED_PRECONDITION = "FAILED_PRECONDITION",
+    /**
+     * ABORTED - The operation was aborted, typically due to a concurrency issue such as
+     * a sequencer check failure or transaction abort.
+     *
+     * See the guidelines above for deciding between `FAILED_PRECONDITION`,
+     * `ABORTED`, and `UNAVAILABLE`.
+     *
+     * HTTP Mapping: 409 Conflict
+     */
+    ABORTED = "ABORTED",
+    /**
+     * OUT_OF_RANGE - The operation was attempted past the valid range.  E.g., seeking or
+     * reading past end-of-file.
+     *
+     * Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
+     * be fixed if the system state changes. For example, a 32-bit file
+     * system will generate `INVALID_ARGUMENT` if asked to read at an
+     * offset that is not in the range [0,2^32-1], but it will generate
+     * `OUT_OF_RANGE` if asked to read from an offset past the current
+     * file size.
+     *
+     * There is a fair bit of overlap between `FAILED_PRECONDITION` and
+     * `OUT_OF_RANGE`.  We recommend using `OUT_OF_RANGE` (the more specific
+     * error) when it applies so that callers who are iterating through
+     * a space can easily look for an `OUT_OF_RANGE` error to detect when
+     * they are done.
+     *
+     * HTTP Mapping: 400 Bad Request
+     */
+    OUT_OF_RANGE = "OUT_OF_RANGE",
+    /**
+     * UNIMPLEMENTED - The operation is not implemented or is not supported/enabled in this
+     * service.
+     *
+     * HTTP Mapping: 501 Not Implemented
+     */
+    UNIMPLEMENTED = "UNIMPLEMENTED",
+    /**
+     * INTERNAL - Internal errors.  This means that some invariants expected by the
+     * underlying system have been broken.  This error code is reserved
+     * for serious errors.
+     *
+     * HTTP Mapping: 500 Internal Server Error
+     */
+    INTERNAL = "INTERNAL",
+    /**
+     * UNAVAILABLE - The service is currently unavailable.  This is most likely a
+     * transient condition, which can be corrected by retrying with
+     * a backoff.
+     *
+     * See the guidelines above for deciding between `FAILED_PRECONDITION`,
+     * `ABORTED`, and `UNAVAILABLE`.
+     *
+     * HTTP Mapping: 503 Service Unavailable
+     */
+    UNAVAILABLE = "UNAVAILABLE",
+    /**
+     * DATA_LOSS - Unrecoverable data loss or corruption.
+     *
+     * HTTP Mapping: 500 Internal Server Error
+     */
+    DATA_LOSS = "DATA_LOSS",
+    /** NOT_MODIFIED - Equivalent to HTTP 304 not modified */
+    NOT_MODIFIED = "NOT_MODIFIED",
+    /**
+     * DECRYPTION_FAILED - Decryption failed. Similar to DATA_LOSS ("Unrecoverable data loss or corruption."),
+     * but HTTP should map to 400 Bad Request, not 500 Internal Server Error.
+     * This is not-retriable.
+     */
+    DECRYPTION_FAILED = "DECRYPTION_FAILED",
+    /**
+     * INVALID_MEDIA - Invalid media. For example: you request an HLS manifest on a still picture, or pngquant on non-png.
+     * HTTP should map to 400 Bad Request. This is not-retriable.
+     */
+    INVALID_MEDIA = "INVALID_MEDIA",
+    /**
+     * IN_PROGRESS - Use to signal that ingestion is in progress and we don't have a result yet.
+     * It can be used for other similar processes.
+     */
+    IN_PROGRESS = "IN_PROGRESS",
+    /**
+     * CONTENT_TOO_LARGE - BOLT can optionally check for content size, before ingestion.
+     * This error code signals that the content is too large to be ingested into BOLT.
+     * Maximum object size can be specified per use case or per ingestion request.
+     */
+    CONTENT_TOO_LARGE = "CONTENT_TOO_LARGE",
+    /**
+     * URL_PROTOCOL_NOT_SUPPORTED - BOLT can only download content from URL protocols HTTP and HTTPS.
+     * This error code will be returned if the URL provided in an ingestion request has a different protocol.
+     */
+    URL_PROTOCOL_NOT_SUPPORTED = "URL_PROTOCOL_NOT_SUPPORTED",
+    /**
+     * URL_CONTENT_TYPE_NOT_WHITELISTED - Content downloaded from a URL has to have its content-type header whitelisted for the use case making
+     * the ingestion request.
+     * This error signals that the URL has a content-type not whitelisted for the use case.
+     */
+    URL_CONTENT_TYPE_NOT_WHITELISTED = "URL_CONTENT_TYPE_NOT_WHITELISTED",
+    /**
+     * URL_DOWNLOAD_FAILURE - This error signals that BOLT failed to download content from the URL provided in the ingestion request.
+     * The HTTP status code is reported in error_code.
+     */
+    URL_DOWNLOAD_FAILURE = "URL_DOWNLOAD_FAILURE",
+    /**
+     * CLOUD_STORAGE_FAILURE - This error signals that BOLT failed to carry out a cloud storage operation.
+     * This can happen when getting content size from the external bucket provided in the ingestion request or when
+     * trying to do the first copy to a BOLT bucket.
+     * The HTTP status code is reported in error code.
+     */
+    CLOUD_STORAGE_FAILURE = "CLOUD_STORAGE_FAILURE",
+    UNRECOGNIZED = "UNRECOGNIZED"
+}
+export declare function codeFromJSON(object: any): Code;
+export declare function codeToJSON(object: Code): string;
+export declare function codeToNumber(object: Code): number;
+export interface CodeProperties {
+    /**
+     * An error code, specific to a give Code, to help identifying an error condition.
+     * For example, for Code URL_DOWNLOAD_FAILURE this indicates the HTTP response code.
+     */
+    errorCode: number;
+    /** This might contain a description of the error condition. */
+    errorDescription: string;
+    /** A value indicating whether Code is retryable. */
+    isRetryable: boolean;
+    /**
+     * The source reporting the error condition.
+     * For example, Bolt/MOSS/VideoEncoding.
+     */
+    source: string;
+}
+export declare const CodeProperties: {
+    encode(message: CodeProperties, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): CodeProperties;
+    fromJSON(object: any): CodeProperties;
+    toJSON(message: CodeProperties): unknown;
+    fromPartial<I extends {
+        errorCode?: number | undefined;
+        errorDescription?: string | undefined;
+        isRetryable?: boolean | undefined;
+        source?: string | undefined;
+    } & {
+        errorCode?: number | undefined;
+        errorDescription?: string | undefined;
+        isRetryable?: boolean | undefined;
+        source?: string | undefined;
+    } & Record<Exclude<keyof I, keyof CodeProperties>, never>>(object: I): CodeProperties;
+};
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
+    $case: string;
+} ? {
+    [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
+} & {
+    $case: T["$case"];
+} : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & Record<Exclude<keyof I, KeysOfUnion<P>>, never>;
+export {};