jourycms-sdk 1.0.1

package/typings/v1/services/auth/index.d.ts

@@ -0,0 +1,5 @@
+'generated by levelup';
+
+export * from "./models/index.d.ts";
+export * from "./entities/index.d.ts";
+export * from "./api/index.d.ts";

package/typings/v1/services/auth/models/api-key.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Auth {
+          /**
+           * @description service models
+           */
+          namespace Model {
+            export type ApiKeyDocument = Entity.ApiKey & Document;
+            export type ApiKey = MongooseModel<ApiKeyDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/models/api-key.model.d.ts

@@ -0,0 +1,3 @@
+/**
+ * @deprecated old file naming convention
+ */

package/typings/v1/services/auth/models/federated-credential.d.ts

@@ -0,0 +1,24 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Auth {
+          /**
+           * @description Service Model
+           */
+          export namespace Model {
+            export type FederatedCredentialDocument =
+              Entity.FederatedCredential & Document;
+            export type FederatedCredential =
+              MongooseModel<FederatedCredentialDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/models/index.d.ts

@@ -0,0 +1,9 @@
+'generated by levelup';
+
+export * from "./user.d.ts";
+export * from "./role.d.ts";
+export * from "./permission.d.ts";
+export * from "./permission-group.d.ts";
+export * from "./api-key.model.d.ts";
+export * from "./api-key.d.ts";
+export * from "./federated-credential.d.ts";

package/typings/v1/services/auth/models/permission-group.d.ts

@@ -0,0 +1,24 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Auth {
+          /**
+           * @description Service Model
+           */
+          export namespace Model {
+            export type PermissionGroupDocument = Entity.PermissionGroup &
+              Document;
+            export type PermissionGroup =
+              MongooseModel<PermissionGroupDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/models/permission.d.ts

@@ -0,0 +1,22 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Auth {
+          /**
+           * @description Service Model
+           */
+          export namespace Model {
+            export type PermissionDocument = Entity.Permission & Document;
+            export type Permission = MongooseModel<PermissionDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/models/role.d.ts

@@ -0,0 +1,22 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Auth {
+          /**
+           * @description Service Model
+           */
+          export namespace Model {
+            export type RoleDocument = Entity.Role & Document;
+            export type Role = MongooseModel<RoleDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/auth/models/user.d.ts

@@ -0,0 +1,22 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Users {
+          /**
+           * @description Service Model
+           */
+          export namespace Model {
+            export type UserDocument = Entity.User & Document;
+            export type User = MongooseModel<UserDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/api/article-type.d.ts

@@ -0,0 +1,160 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Api {
+          export namespace ArticleTypes {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link https://gateway.com/cm/api/article-types
+             * @fires TypesService.create
+             * @param {Levelup.CMS.V1.Api.ArticleTypes.Create.Request} body
+             * @returns {Levelup.CMS.V1.Api.ArticleTypes.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.ArticleType>;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ArticleType>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/article-types/:id
+             * @fires TypesService.update
+             * @param {Levelup.CMS.V1.Api.ArticleTypes.Update.Request} body
+             * @returns {Levelup.CMS.V1.Api.ArticleTypes.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.ArticleType>;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ArticleType>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/article-types/:id
+             * @fires TypesService.delete
+             * @param {Levelup.CMS.V1.Api.ArticleTypes.Delete.Request} query
+             * @returns {Levelup.CMS.V1.Api.ArticleTypes.Delete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace Delete {
+              export type Request = Utils.Api.Request.Build<never>;
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            One
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/article-types/:id
+             * @fires TypesService.getById
+             * @link http://gateway.com/cm/api/article-types/by-slug/:id
+             * @fires TypesService.getBySlug
+             * @param {Levelup.CMS.V1.Api.ArticleTypes.GetOne.Request} query
+             * @returns {Levelup.CMS.V1.Api.ArticleTypes.GetOne.Response}
+             * @method PUT
+             *
+             */
+            export namespace GetOne {
+              export type Request = Utils.Api.Request.Build<never>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ArticleType>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires TypesService.List
+             * @param {Levelup.CMS.V1.Api.ArticleTypes.List.Request} query
+             * @returns {Levelup.CMS.V1.Api.ArticleTypes.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              type Scope = "listing" | "ids" | "trackings";
+
+              export type Request =
+                Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.ArticleType>;
+              export type Response =
+                Utils.Api.Response.BuildListResponse<Entity.ArticleType>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            CreateCustomMetaField
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/article-types/:id/custom-meta-fields
+             * @fires TypesService.createCustomMetaField
+             * @param {Levelup.CMS.V1.Api.ArticleTypes.CreateCustomMetaField.Request} body
+             * @returns {Levelup.CMS.V1.Api.ArticleTypes.CreateCustomMetaField.Response}
+             * @method POST
+             *
+             */
+            export namespace CreateCustomMetaField {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.CustomMetaField>;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ArticleType>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            UpdateCustomMetaField
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/article-types/:id/custom-meta-fields
+             * @fires TypesService.updateCustomMetaField
+             * @param {Levelup.CMS.V1.Api.ArticleTypes.UpdateCustomMetaField.Request} body
+             * @returns {Levelup.CMS.V1.Api.ArticleTypes.UpdateCustomMetaField.Response}
+             * @method PUT
+             *
+             */
+            export namespace UpdateCustomMetaField {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.CustomMetaField>;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ArticleType>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            DeleteCustomMetaField
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/article-types/:id/custom-meta-fields
+             * @fires TypesService.deleteCustomMetaField
+             * @param {Levelup.CMS.V1.Api.ArticleTypes.DeleteCustomMetaField.Request} query
+             * @returns {Levelup.CMS.V1.Api.ArticleTypes.DeleteCustomMetaField.Response}
+             * @method DELETE
+             *
+             */
+            export namespace DeleteCustomMetaField {
+              export type Request = Utils.Api.Request.Build<{
+                field_key: string;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.ArticleType>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/api/article.d.ts

@@ -0,0 +1,108 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Api {
+          export namespace Articles {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link https://gateway.com/cm/api/articles
+             * @fires ArticlesService.create
+             * @param {Levelup.CMS.V1.Api.Articles.Create.Request} body
+             * @returns {Levelup.CMS.V1.Api.Articles.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.Article>;
+              }>;
+              export type Response<T extends Entity.Article = Entity.Article> =
+                Utils.Api.Response.BuildSingleItemResponse<T>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/articles/:id
+             * @fires ArticlesService.update
+             * @param {Levelup.CMS.V1.Api.Articles.Update.Request} body
+             * @returns {Levelup.CMS.V1.Api.Articles.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.Article>;
+              }>;
+              export type Response<T extends Entity.Article = Entity.Article> =
+                Utils.Api.Response.BuildSingleItemResponse<T>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/articles/:id
+             * @fires ArticlesService.delete
+             * @param {Levelup.CMS.V1.Api.Articles.Delete.Request} query
+             * @returns {Levelup.CMS.V1.Api.Articles.Delete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace Delete {
+              export type Request = Utils.Api.Request.Build<{}>;
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            One
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/articles/:id
+             * @fires ArticlesService.getById
+             * @link http://gateway.com/cm/api/articles/by-slug/:id
+             * @fires ArticlesService.getBySlug
+             * @param {Levelup.CMS.V1.Api.Articles.GetOne.Request} query
+             * @returns {Levelup.CMS.V1.Api.Articles.GetOne.Response}
+             * @method PUT
+             *
+             */
+            export namespace GetOne {
+              export type Request = Utils.Api.Request.Build<{}>;
+              export type Response<T extends Entity.Article = Entity.Article> =
+                Utils.Api.Response.BuildSingleItemResponse<T>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires ArticlesService.List
+             * @param {Levelup.CMS.V1.Api.Articles.List.Request} query
+             * @returns {Levelup.CMS.V1.Api.Articles.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              type Scope = "listing" | "ids" | "trackings";
+
+              export type Request =
+                Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<
+                  Entity.Article & {
+                    tag: any;
+                    tag_slug: any;
+                  }
+                >;
+              export type Response<T extends Entity.Article = Entity.Article> =
+                Utils.Api.Response.BuildListResponse<T>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/api/comment.d.ts

@@ -0,0 +1,106 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Api {
+          export namespace Comments {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link https://gateway.com/cm/api/comments
+             * @fires CommentsService.create
+             * @param {Levelup.CMS.V1.Api.Comments.Create.Request} body
+             * @returns {Levelup.CMS.V1.Api.Comments.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.Comment>;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Comment>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/comments/:id
+             * @fires CommentsService.update
+             * @param {Levelup.CMS.V1.Api.Comments.Update.Request} body
+             * @returns {Levelup.CMS.V1.Api.Comments.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.Comment>;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Comment>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/comments/:id
+             * @fires CommentsService.delete
+             * @param {Levelup.CMS.V1.Api.Comments.Delete.Request} query
+             * @returns {Levelup.CMS.V1.Api.Comments.Delete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace Delete {
+              export type Request = Utils.Api.Request.Build<{}>;
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            One
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/comments/:id
+             * @fires CommentsService.getById
+             * @link http://gateway.com/cm/api/comments/by-slug/:id
+             * @fires CommentsService.getBySlug
+             * @param {Levelup.CMS.V1.Api.Comments.GetOne.Request} query
+             * @returns {Levelup.CMS.V1.Api.Comments.GetOne.Response}
+             * @method PUT
+             *
+             */
+            export namespace GetOne {
+              export type Request = Utils.Api.Request.Build<{}>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Comment>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires CommentsService.List
+             * @param {Levelup.CMS.V1.Api.Comments.List.Request} query
+             * @returns {Levelup.CMS.V1.Api.Comments.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              type Scope = "listing" | "ids" | "trackings";
+
+              export type Request =
+                Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.Comment> & {
+                  scope?: Scope;
+                };
+
+              export type Response =
+                Utils.Api.Response.BuildListResponse<Entity.Comment>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/api/index.d.ts

@@ -0,0 +1,12 @@
+'generated by levelup';
+
+export * from "./translation.tools.d.ts";
+export * from "./translation.project.d.ts";
+export * from "./translation.namespace.d.ts";
+export * from "./translation.item.d.ts";
+export * from "./taxonomy.d.ts";
+export * from "./term.d.ts";
+export * from "./review.d.ts";
+export * from "./comment.d.ts";
+export * from "./article.d.ts";
+export * from "./article-type.d.ts";

package/typings/v1/services/content/api/review.d.ts

@@ -0,0 +1,105 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Api {
+          export namespace Reviews {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link https://gateway.com/cm/api/reviews
+             * @fires ReviewsService.create
+             * @param {Levelup.CMS.V1.Api.Review.Create.Request} body
+             * @returns {Levelup.CMS.V1.Api.Review.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.Review>;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Review>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/reviews/:id
+             * @fires ReviewsService.update
+             * @param {Levelup.CMS.V1.Api.Review.Update.Request} body
+             * @returns {Levelup.CMS.V1.Api.Review.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request = Utils.Api.Request.Build<{
+                data: Partial<Entity.Review>;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Review>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/reviews/:id
+             * @fires ReviewsService.delete
+             * @param {Levelup.CMS.V1.Api.Review.Delete.Request} query
+             * @returns {Levelup.CMS.V1.Api.Review.Delete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace Delete {
+              export type Request = Utils.Api.Request.Build<{}>;
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            One
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/reviews/:id
+             * @fires ReviewsService.getById
+             * @link http://gateway.com/cm/api/reviews/by-slug/:id
+             * @fires ReviewsService.getBySlug
+             * @param {Levelup.CMS.V1.Api.Review.GetOne.Request} query
+             * @returns {Levelup.CMS.V1.Api.Review.GetOne.Response}
+             * @method PUT
+             *
+             */
+            export namespace GetOne {
+              export type Request = Utils.Api.Request.Build<{}>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Review>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires ReviewsService.List
+             * @param {Levelup.CMS.V1.Api.Review.List.Request} query
+             * @returns {Levelup.CMS.V1.Api.Review.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              type Scope = "listing" | "ids" | "trackings";
+
+              export type Request =
+                Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.Review> & {
+                  scope?: Scope;
+                };
+              export type Response =
+                Utils.Api.Response.BuildListResponse<Entity.Review>;
+            }
+          }
+        }
+      }
+    }
+  }
+}