jourycms-sdk 1.0.1

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

@@ -0,0 +1,101 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Api {
+          export namespace Taxonomies {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link https://gateway.com/cm/api/taxonomy
+             * @fires TaxonomyService.create
+             * @param {Levelup.CMS.V1.Api.Taxonomies.Create.Request} body
+             * @returns {Levelup.CMS.V1.Api.Taxonomies.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request =
+                Utils.Api.Request.BuildCreateRequest<Entity.Taxonomy>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Taxonomy>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/taxonomy/:id
+             * @fires TaxonomyService.update
+             * @param {Levelup.CMS.V1.Api.Taxonomies.Update.Request} body
+             * @returns {Levelup.CMS.V1.Api.Taxonomies.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request =
+                Utils.Api.Request.BuildUpdateRequest<Entity.Taxonomy>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Taxonomy>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/taxonomy/:id
+             * @fires TaxonomyService.delete
+             * @param {Levelup.CMS.V1.Api.Taxonomies.Delete.Request} query
+             * @returns {Levelup.CMS.V1.Api.Taxonomies.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/taxonomy/:id
+             * @fires TaxonomyService.getById
+             * @link http://gateway.com/cm/api/taxonomy/by-slug/:id
+             * @fires TaxonomyService.getBySlug
+             * @param {Levelup.CMS.V1.Api.Taxonomies.GetOne.Request} query
+             * @returns {Levelup.CMS.V1.Api.Taxonomies.GetOne.Response}
+             * @method PUT
+             *
+             */
+            export namespace GetOne {
+              export type Request = Utils.Api.Request.Build<{}>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Taxonomy>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires TaxonomyService.List
+             * @param {Levelup.CMS.V1.Api.Taxonomies.List.Request} query
+             * @returns {Levelup.CMS.V1.Api.Taxonomies.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              type Scope = "listing" | "ids" | "trackings";
+
+              export type Request =
+                Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.Taxonomy>;
+              export type Response =
+                Utils.Api.Response.BuildListResponse<Entity.Taxonomy>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,101 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Api {
+          export namespace Terms {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link https://gateway.com/cm/api/tags
+             * @fires TagsService.create
+             * @param {Levelup.CMS.V1.Api.Terms.Create.Request} body
+             * @returns {Levelup.CMS.V1.Api.Terms.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request =
+                Utils.Api.Request.BuildCreateRequest<Entity.Term>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Term>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/tags/:id
+             * @fires TagsService.update
+             * @param {Levelup.CMS.V1.Api.Terms.Update.Request} body
+             * @returns {Levelup.CMS.V1.Api.Terms.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request =
+                Utils.Api.Request.BuildUpdateRequest<Entity.Term>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Term>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link http://gateway.com/cm/api/tags/:id
+             * @fires TagsService.delete
+             * @param {Levelup.CMS.V1.Api.Terms.Delete.Request} query
+             * @returns {Levelup.CMS.V1.Api.Terms.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/tags/:id
+             * @fires TagsService.getById
+             * @link http://gateway.com/cm/api/tags/by-slug/:id
+             * @fires TagsService.getBySlug
+             * @param {Levelup.CMS.V1.Api.Terms.GetOne.Request} query
+             * @returns {Levelup.CMS.V1.Api.Terms.GetOne.Response}
+             * @method PUT
+             *
+             */
+            export namespace GetOne {
+              export type Request = Utils.Api.Request.Build<{}>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.Term>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires TagsService.List
+             * @param {Levelup.CMS.V1.Api.Terms.List.Request} query
+             * @returns {Levelup.CMS.V1.Api.Terms.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              type Scope = "listing" | "ids" | "trackings";
+
+              export type Request =
+                Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.Term>;
+              export type Response =
+                Utils.Api.Response.BuildListResponse<Entity.Term>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/api/translation.item.d.ts

@@ -0,0 +1,195 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Translation {
+          /**
+           * @description Service Entity
+           */
+          export namespace Api {
+            export namespace Items {
+              /* -------------------------------------------------------------------------- */
+              /*                             InsertI18MissingKey                            */
+              /* -------------------------------------------------------------------------- */
+              export namespace InsertI18MissingKey {
+                export type Request = Utils.Api.Request.Build<
+                  Partial<{
+                    project: string;
+                    namespace: string;
+                    key: string;
+                    languages: Entity.TLanguageCode[];
+                    default_language: Entity.TLanguageCode;
+                  }>
+                >;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Item>;
+              }
+
+              /* -------------------------------------------------------------------------- */
+              /*                            GetTranslationObject                            */
+              /* -------------------------------------------------------------------------- */
+              export namespace GetTranslationObject {
+                export type Request = Utils.Api.Request.Build<
+                  Partial<{
+                    project_name: string;
+                    namespace_name: string;
+                    approved_only: boolean;
+                    language: Entity.TLanguageCode;
+                  }>
+                >;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<{
+                    [key: string]: string;
+                  }>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            Create
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ItemsService.Create
+               * @param {Levelup.CMS.V1.Translation.Api.Items.Create.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Items.Create.Response}
+               * @method POST
+               *
+               */
+              export namespace Create {
+                export type Request = Utils.Api.Request.BuildCreateRequest<
+                  Entity.Item & {
+                    translation_updates: {
+                      [Lang in Entity.TLanguageCode]?: {
+                        modified: boolean;
+                        approvement_modified: boolean;
+                        value: string;
+                        approved: boolean | null;
+                      };
+                    };
+                    comments: string;
+                  }
+                >;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Item>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            Update
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ItemsService.Update
+               * @param {Levelup.CMS.V1.Translation.Api.Items.Update.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Items.Update.Response}
+               * @method PUT
+               *
+               */
+              export namespace Update {
+                export type Request = Utils.Api.Request.BuildUpdateRequest<
+                  Entity.Item & {
+                    translation_updates: {
+                      [Lang in Entity.TLanguageCode]?: {
+                        modified: boolean;
+                        approvement_modified: boolean;
+                        value: string;
+                        approved: boolean | null;
+                      };
+                    };
+                    auto_translated: boolean;
+                    comments: string;
+                  }
+                >;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Item>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            Delete
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ItemsService.Delete
+               * @param {Levelup.CMS.V1.Translation.Api.Items.Delete.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Items.Delete.Response}
+               * @method DELETE
+               *
+               */
+              export namespace Delete {
+                export type Response = Utils.Api.Response.DefaultDeleteResponse;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            BulkDelete
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ItemsService.BulkDelete
+               * @param {Levelup.CMS.V1.Translation.Api.Items.BulkDelete.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Items.BulkDelete.Response}
+               * @method DELETE
+               *
+               */
+              export namespace BulkDelete {
+                export type Request = Utils.Api.Request.Build<{
+                  data: {
+                    id?: string[];
+                    tracking_id?: string[];
+                  };
+                }>;
+                export type Response = Utils.Api.Response.DefaultDeleteResponse;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            GetOne
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ItemsService.GetOne
+               * @param {Levelup.CMS.V1.Translation.Api.Items.GetOne.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Items.GetOne.Response}
+               * @method GET
+               *
+               */
+              export namespace GetOne {
+                type Scope = "";
+                export type Request = Utils.Api.Request.Build<
+                  Record<string, unknown>
+                >;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Item>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            List
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ItemsService.List
+               * @param {Levelup.CMS.V1.Translation.Api.Items.List.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Items.List.Response}
+               * @method GET
+               *
+               */
+              export namespace List {
+                type Scope = "listing" | "ids" | "trackings";
+
+                export type Request =
+                  Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.Item> & {
+                    updated_by?: string;
+                    created_by?: string;
+                    scope?: Scope;
+                    filters?: {
+                      /**
+                       * Here will be the custom filters
+                       */
+                    };
+                  };
+                export type Response =
+                  Utils.Api.Response.BuildListResponse<Entity.Item>;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/api/translation.namespace.d.ts

@@ -0,0 +1,135 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Translation {
+          /**
+           * @description Service Entity
+           */
+          export namespace Api {
+            export namespace Namespaces {
+              /**
+               * --------------------------------------------------------------------------
+               *                            Create
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires NamespacesService.Create
+               * @param {Levelup.CMS.V1.Translation.Api.Namespaces.Create.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Namespaces.Create.Response}
+               * @method POST
+               *
+               */
+              export namespace Create {
+                export type Request =
+                  Utils.Api.Request.BuildCreateRequest<Entity.Namespace>;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Namespace>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            Update
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires NamespacesService.Update
+               * @param {Levelup.CMS.V1.Translation.Api.Namespaces.Update.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Namespaces.Update.Response}
+               * @method PUT
+               *
+               */
+              export namespace Update {
+                export type Request =
+                  Utils.Api.Request.BuildUpdateRequest<Entity.Namespace>;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Namespace>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            Delete
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires NamespacesService.Delete
+               * @param {Levelup.CMS.V1.Translation.Api.Namespaces.Delete.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Namespaces.Delete.Response}
+               * @method DELETE
+               *
+               */
+              export namespace Delete {
+                export type Response = Utils.Api.Response.DefaultDeleteResponse;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            BulkDelete
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires NamespacesService.BulkDelete
+               * @param {Levelup.CMS.V1.Translation.Api.Namespaces.BulkDelete.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Namespaces.BulkDelete.Response}
+               * @method DELETE
+               *
+               */
+              export namespace BulkDelete {
+                export type Request = Utils.Api.Request.Build<{
+                  data: {
+                    id?: string[];
+                    tracking_id?: string[];
+                  };
+                }>;
+                export type Response = Utils.Api.Response.DefaultDeleteResponse;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            GetOne
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires NamespacesService.GetOne
+               * @param {Levelup.CMS.V1.Translation.Api.Namespaces.GetOne.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Namespaces.GetOne.Response}
+               * @method GET
+               *
+               */
+              export namespace GetOne {
+                type Scope = "";
+                export type Request = Utils.Api.Request.Build<
+                  Record<string, unknown>
+                >;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Namespace>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            List
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires NamespacesService.List
+               * @param {Levelup.CMS.V1.Translation.Api.Namespaces.List.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Namespaces.List.Response}
+               * @method GET
+               *
+               */
+              export namespace List {
+                type Scope = "listing" | "ids" | "trackings";
+
+                export type Request =
+                  Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.Namespace> & {
+                    scope?: Scope;
+                    filters?: {
+                      /**
+                       * Here will be the custom filters
+                       */
+                    };
+                  };
+                export type Response =
+                  Utils.Api.Response.BuildListResponse<Entity.Namespace>;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}