@newfold/huapi-js 1.1.3 → 1.2.0

package/openapi.json

@@ -12,9 +12,9 @@
         "description": "A site",
         "properties": {
           "id": {
-            "type": "integer",
+            "type": "string",
             "description": "TODO",
-            "example": 1
+            "example": "1"
           },
           "name": {
             "type": "string",
@@ -67,12 +67,12 @@
             },
             "example": [
               {
-                "id": 1,
+                "id": "1",
                 "name": "Example Site 1",
                 "url": "https://example.com"
               },
               {
-                "id": 2,
+                "id": "2",
                 "name": "Example Site 2",
                 "url": "https://example2.com"
               }
@@ -87,12 +87,12 @@
           "rows": [
             [
               {
-                "id": 1,
+                "id": "1",
                 "name": "Example Site 1",
                 "url": "https://example.com"
               },
               {
-                "id": 2,
+                "id": "2",
                 "name": "Example Site 2",
                 "url": "https://example2.com"
               }
@@ -194,6 +194,47 @@
           }
         }
       }
+    },
+    "/hosting/{hosting_id}/sites/{site_id}": {
+      "get": {
+        "operationId": "get_hosting_site_by_id",
+        "tags": ["sites"],
+        "security": [{ "bearerAuth": [] }],
+        "summary": "For a hosting id, get a specific site by site id",
+        "description": "Obtain a specific site.",
+        "parameters": [
+          {
+            "name": "hosting_id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "description": "Specify the hosting id to get sites for."
+            }
+          },
+          {
+            "name": "site_id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "Specify the site id to get the site for."
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Site"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "servers": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newfold/huapi-js",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "main": "src/huapi.js",
   "license": "MIT",
   "devDependencies": {

package/src/huapi.js

@@ -20,7 +20,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 exports.__esModule = true;
-exports.getHostingUAPIMSW = exports.getGetHostingSitesMock = exports.getSiteSsoMock = exports.useGetHostingSites = exports.getGetHostingSitesQueryKey = exports.getHostingSites = exports.useSiteSso = exports.siteSso = void 0;
+exports.getHostingUAPIMSW = exports.getGetHostingSiteByIdMock = exports.getGetHostingSitesMock = exports.getSiteSsoMock = exports.useGetHostingSiteById = exports.getGetHostingSiteByIdQueryKey = exports.getHostingSiteById = exports.useGetHostingSites = exports.getGetHostingSitesQueryKey = exports.getHostingSites = exports.useSiteSso = exports.siteSso = void 0;
 /**
  * Generated by orval v6.7.1 🍺
  * Do not edit manually.
@@ -68,15 +68,38 @@ var useGetHostingSites = function (hostingId, options) {
     return __assign({ queryKey: queryKey }, query);
 };
 exports.useGetHostingSites = useGetHostingSites;
+/**
+ * Obtain a specific site.
+ * @summary For a hosting id, get a specific site by site id
+ */
+var getHostingSiteById = function (hostingId, siteId, options) {
+    return axios_1["default"].get("/hosting/".concat(hostingId, "/sites/").concat(siteId), options);
+};
+exports.getHostingSiteById = getHostingSiteById;
+var getGetHostingSiteByIdQueryKey = function (hostingId, siteId) { return ["/hosting/".concat(hostingId, "/sites/").concat(siteId)]; };
+exports.getGetHostingSiteByIdQueryKey = getGetHostingSiteByIdQueryKey;
+var useGetHostingSiteById = function (hostingId, siteId, options) {
+    var _a;
+    var _b = options || {}, queryOptions = _b.query, axiosOptions = _b.axios;
+    var queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : (0, exports.getGetHostingSiteByIdQueryKey)(hostingId, siteId);
+    var queryFn = function () { return (0, exports.getHostingSiteById)(hostingId, siteId, axiosOptions); };
+    var query = (0, react_query_1.useQuery)(queryKey, queryFn, __assign({ enabled: !!(hostingId && siteId) }, queryOptions));
+    return __assign({ queryKey: queryKey }, query);
+};
+exports.useGetHostingSiteById = useGetHostingSiteById;
 var getSiteSsoMock = function () { return ({ sso: faker_1.faker.random.word() }); };
 exports.getSiteSsoMock = getSiteSsoMock;
-var getGetHostingSitesMock = function () { return ({ limit: faker_1.faker.datatype.number(), n_pages: faker_1.faker.datatype.number(), n_rows: faker_1.faker.datatype.number(), page: faker_1.faker.datatype.number(), rows: __spreadArray([], Array(faker_1.faker.datatype.number({ min: 1, max: 10 })), true).map(function () { return ({ id: faker_1.faker.datatype.number(), name: faker_1.faker.random.word(), url: faker_1.faker.random.word() }); }) }); };
+var getGetHostingSitesMock = function () { return ({ limit: faker_1.faker.datatype.number(), n_pages: faker_1.faker.datatype.number(), n_rows: faker_1.faker.datatype.number(), page: faker_1.faker.datatype.number(), rows: __spreadArray([], Array(faker_1.faker.datatype.number({ min: 1, max: 10 })), true).map(function () { return ({ id: faker_1.faker.random.word(), name: faker_1.faker.random.word(), url: faker_1.faker.random.word() }); }) }); };
 exports.getGetHostingSitesMock = getGetHostingSitesMock;
+var getGetHostingSiteByIdMock = function () { return ({ id: faker_1.faker.random.word(), name: faker_1.faker.random.word(), url: faker_1.faker.random.word() }); };
+exports.getGetHostingSiteByIdMock = getGetHostingSiteByIdMock;
 var getHostingUAPIMSW = function () { return [
     msw_1.rest.post('*/sites/:siteid/sso', function (_req, res, ctx) {
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getSiteSsoMock)()));
     }), msw_1.rest.get('*/hosting/:hostingid/sites', function (_req, res, ctx) {
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getGetHostingSitesMock)()));
+    }), msw_1.rest.get('*/hosting/:hostingid/sites/:siteid', function (_req, res, ctx) {
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getGetHostingSiteByIdMock)()));
     }),
 ]; };
 exports.getHostingUAPIMSW = getHostingUAPIMSW;

package/src/huapi.ts

@@ -39,7 +39,7 @@ export interface SiteSso {
  */
 export interface Site {
   /** TODO */
-  id: number;
+  id: string;
   /** TODO */
   name: string;
   /** TODO */
@@ -147,11 +147,57 @@ export const useGetHostingSites = <TData = AsyncReturnType<typeof getHostingSite
 }
 
 
+/**
+ * Obtain a specific site.
+ * @summary For a hosting id, get a specific site by site id
+ */
+export const getHostingSiteById = (
+    hostingId: number,
+    siteId: string, options?: AxiosRequestConfig
+ ): Promise<AxiosResponse<Site>> => {
+    return axios.get(
+      `/hosting/${hostingId}/sites/${siteId}`,options
+    );
+  }
+
+
+export const getGetHostingSiteByIdQueryKey = (hostingId: number,
+    siteId: string,) => [`/hosting/${hostingId}/sites/${siteId}`];
+
+    
+export type GetHostingSiteByIdQueryResult = NonNullable<AsyncReturnType<typeof getHostingSiteById>>
+export type GetHostingSiteByIdQueryError = AxiosError<unknown>
+
+export const useGetHostingSiteById = <TData = AsyncReturnType<typeof getHostingSiteById>, TError = AxiosError<unknown>>(
+ hostingId: number,
+    siteId: string, options?: { query?:UseQueryOptions<AsyncReturnType<typeof getHostingSiteById>, TError, TData>, axios?: AxiosRequestConfig}
+
+  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const {query: queryOptions, axios: axiosOptions} = options || {}
+
+  const queryKey = queryOptions?.queryKey ?? getGetHostingSiteByIdQueryKey(hostingId,siteId);
+
+  
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getHostingSiteById>> = () => getHostingSiteById(hostingId,siteId, axiosOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getHostingSiteById>, TError, TData>(queryKey, queryFn, {enabled: !!(hostingId && siteId), ...queryOptions})
+
+  return {
+    queryKey,
+    ...query
+  }
+}
+
+
 
 
 export const getSiteSsoMock = () => ({sso: faker.random.word()})
 
-export const getGetHostingSitesMock = () => ({limit: faker.datatype.number(), n_pages: faker.datatype.number(), n_rows: faker.datatype.number(), page: faker.datatype.number(), rows: [...Array(faker.datatype.number({min: 1, max: 10}))].map(() => ({id: faker.datatype.number(), name: faker.random.word(), url: faker.random.word()}))})
+export const getGetHostingSitesMock = () => ({limit: faker.datatype.number(), n_pages: faker.datatype.number(), n_rows: faker.datatype.number(), page: faker.datatype.number(), rows: [...Array(faker.datatype.number({min: 1, max: 10}))].map(() => ({id: faker.random.word(), name: faker.random.word(), url: faker.random.word()}))})
+
+export const getGetHostingSiteByIdMock = () => ({id: faker.random.word(), name: faker.random.word(), url: faker.random.word()})
 
 export const getHostingUAPIMSW = () => [
 rest.post('*/sites/:siteid/sso', (_req, res, ctx) => {
@@ -166,4 +212,10 @@ ctx.json(getSiteSsoMock()),
           ctx.status(200, 'Mocked status'),
 ctx.json(getGetHostingSitesMock()),
         )
+      }),rest.get('*/hosting/:hostingid/sites/:siteid', (_req, res, ctx) => {
+        return res(
+          ctx.delay(1000),
+          ctx.status(200, 'Mocked status'),
+ctx.json(getGetHostingSiteByIdMock()),
+        )
       }),]