@fivepixels-js/lite-api 0.2.1

package/dist/community/schemas.d.ts

@@ -0,0 +1,807 @@
+export declare const communityErrorResponseSchema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+    readonly properties: {
+        readonly resultCode: {
+            readonly type: "string";
+        };
+        readonly resultMessage: {
+            readonly type: "string";
+        };
+        readonly result: {
+            readonly type: "null";
+        };
+        readonly pagination: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+            readonly properties: {
+                readonly page: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly pageSize: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly totalCount: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly totalPages: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly hasNext: {
+                    readonly type: "boolean";
+                };
+                readonly hasPrevious: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+    };
+};
+export declare const communityErrorResponses: {
+    readonly 400: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 401: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 403: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 404: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 409: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 410: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 412: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 413: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 422: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 423: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 428: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 429: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 500: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+    readonly 503: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["resultCode", "resultMessage", "result", "pagination"];
+        readonly properties: {
+            readonly resultCode: {
+                readonly type: "string";
+            };
+            readonly resultMessage: {
+                readonly type: "string";
+            };
+            readonly result: {
+                readonly type: "null";
+            };
+            readonly pagination: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+                readonly properties: {
+                    readonly page: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly pageSize: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly totalPages: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly hasNext: {
+                        readonly type: "boolean";
+                    };
+                    readonly hasPrevious: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+    };
+};
+export declare function communityResponseSchema(result: Readonly<Record<string, unknown>>): Record<string, unknown>;
+export declare const uuidSchema: {
+    readonly type: "string";
+    readonly format: "uuid";
+};
+export declare const nullableStringSchema: {
+    readonly anyOf: readonly [{
+        readonly type: "string";
+    }, {
+        readonly type: "null";
+    }];
+};
+export declare const nullableUuidSchema: {
+    readonly anyOf: readonly [{
+        readonly type: "string";
+        readonly format: "uuid";
+    }, {
+        readonly type: "null";
+    }];
+};
+export declare const jsonObjectSchema: {
+    readonly type: "object";
+    readonly additionalProperties: true;
+};
+export declare const dateTimeSchema: {
+    readonly type: "string";
+    readonly format: "date-time";
+};
+export declare const attachmentsSchema: {
+    readonly type: "array";
+    readonly maxItems: 0;
+    readonly items: {
+        readonly type: "object";
+    };
+};
+export declare const attachmentIdsSchema: {
+    readonly anyOf: readonly [{
+        readonly type: "array";
+        readonly maxItems: 10;
+        readonly items: {
+            readonly type: "string";
+            readonly format: "uuid";
+        };
+    }, {
+        readonly type: "null";
+    }];
+};
+export declare const pageQuerySchema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly page: {
+            readonly type: "integer";
+            readonly default: 1;
+        };
+        readonly pageSize: {
+            readonly type: "integer";
+            readonly default: 20;
+        };
+    };
+};
+export declare function paramsSchema(names: string[]): Record<string, unknown>;
+export declare const object: (properties: Record<string, unknown>, required?: string[]) => {
+    type: string;
+    additionalProperties: boolean;
+    properties: Record<string, unknown>;
+    required: string[];
+};
+export declare const array: (items: Record<string, unknown>) => {
+    type: string;
+    items: Record<string, unknown>;
+};
+export declare const pagination: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["page", "pageSize", "totalCount", "totalPages", "hasNext", "hasPrevious"];
+    readonly properties: {
+        readonly page: {
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+        readonly pageSize: {
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+        readonly totalCount: {
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+        readonly totalPages: {
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+        readonly hasNext: {
+            readonly type: "boolean";
+        };
+        readonly hasPrevious: {
+            readonly type: "boolean";
+        };
+    };
+};
+export declare const pageSize: {
+    type: string;
+    minimum: number;
+    maximum: number;
+    default: number;
+};
+export declare const ifMatchHeadersSchema: {
+    type: string;
+    required: string[];
+    properties: {
+        'if-match': {
+            type: string;
+            description: string;
+        };
+    };
+};
+export declare const statusBodySchema: {
+    type: string;
+    additionalProperties: boolean;
+    properties: Record<string, unknown>;
+    required: string[];
+};
+export declare const assigneeBodySchema: {
+    type: string;
+    additionalProperties: boolean;
+    properties: Record<string, unknown>;
+    required: string[];
+};
+//# sourceMappingURL=schemas.d.ts.map