@readyfor/api-client-pigeon 0.163.0 → 0.164.0-pr923.5bcb86f

package/dist/schemaType.d.mts

@@ -3,22 +3,117 @@
  * Do not make direct changes to the file.
  */
 interface paths {
-    "/api/v1/example": {
-        /** example */
-        get: operations["V1Example"];
+    "/api/campaigns": {
+        /** キャンペーン一覧を取得する */
+        get: operations["GetCampaigns"];
     };
 }
 type webhooks = Record<string, never>;
 interface components {
     schemas: {
         /**
-         * Example
+         * GetCampaigns
          * @example {
-         *   "value": "value"
+         *   "pagination": {
+         *     "nextPage": 7,
+         *     "isLastPage": true,
+         *     "totalPages": 6,
+         *     "prevPage": 2,
+         *     "totalCount": 1,
+         *     "currentPage": 5,
+         *     "isFirstPage": true,
+         *     "currentPerPage": 5
+         *   },
+         *   "campaigns": [
+         *     {
+         *       "lastEditorName": "lastEditorName",
+         *       "deliveryAt": "2000-01-23T04:56:07.000Z",
+         *       "lastEditedAt": "2000-01-23T04:56:07.000Z",
+         *       "id": 0,
+         *       "title": "title",
+         *       "type": "curationMailMagazine",
+         *       "status": "draft"
+         *     },
+         *     {
+         *       "lastEditorName": "lastEditorName",
+         *       "deliveryAt": "2000-01-23T04:56:07.000Z",
+         *       "lastEditedAt": "2000-01-23T04:56:07.000Z",
+         *       "id": 0,
+         *       "title": "title",
+         *       "type": "curationMailMagazine",
+         *       "status": "draft"
+         *     }
+         *   ]
          * }
          */
-        ExampleModel: {
-            value: string;
+        GetCampaigns: {
+            campaigns: components["schemas"]["Campaign"][];
+            pagination: components["schemas"]["Pagination"];
+        };
+        /**
+         * Campaign
+         * @example {
+         *   "lastEditorName": "lastEditorName",
+         *   "deliveryAt": "2000-01-23T04:56:07.000Z",
+         *   "lastEditedAt": "2000-01-23T04:56:07.000Z",
+         *   "id": 0,
+         *   "title": "title",
+         *   "type": "curationMailMagazine",
+         *   "status": "draft"
+         * }
+         */
+        Campaign: {
+            id: number;
+            title?: string | null;
+            status: components["schemas"]["CampaignStatus"];
+            type: components["schemas"]["CampaignType"];
+            /** Format: date-time */
+            deliveryAt: string | null;
+            lastEditorName: string;
+            /** Format: date-time */
+            lastEditedAt: string;
+        };
+        /**
+         * CampaignStatus
+         * @enum {string}
+         */
+        CampaignStatus: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
+        /**
+         * CampaignType
+         * @enum {string}
+         */
+        CampaignType: "curationMailMagazine" | "personalizedMailMagazine";
+        /**
+         * Pagination
+         * @description ページネーション
+         * @example {
+         *   "nextPage": 7,
+         *   "isLastPage": true,
+         *   "totalPages": 6,
+         *   "prevPage": 2,
+         *   "totalCount": 1,
+         *   "currentPage": 5,
+         *   "isFirstPage": true,
+         *   "currentPerPage": 5
+         * }
+         */
+        Pagination: {
+            /** @description 合計ページ */
+            totalPages: number;
+            /** @description 合計件数 */
+            totalCount: number;
+            /** @description 1ページあたりのレコード数 */
+            currentPerPage: number;
+            /** @description 現在のページ */
+            currentPage: number;
+            /** @description 前のページ */
+            prevPage: number | null;
+            /** @description 次のページ */
+            nextPage: number | null;
+            /** @description 最初のページかどうか */
+            isFirstPage: boolean;
+            /** @description 最後のページかどうか */
+            isLastPage: boolean;
         };
     };
     responses: never;
@@ -30,13 +125,23 @@ interface components {
 type $defs = Record<string, never>;
 type external = Record<string, never>;
 interface operations {
-    /** example */
-    V1Example: {
+    /** キャンペーン一覧を取得する */
+    GetCampaigns: {
+        parameters: {
+            query?: {
+                title?: string;
+                status?: components["schemas"]["CampaignStatus"];
+                type?: components["schemas"]["CampaignType"];
+                deliveryAtFrom?: string;
+                deliveryAtTo?: string;
+                page?: number;
+            };
+        };
         responses: {
             /** @description OK */
             200: {
                 content: {
-                    "application/json": components["schemas"]["ExampleModel"];
+                    "application/json": components["schemas"]["GetCampaigns"];
                 };
             };
         };

package/dist/schemaType.d.ts

@@ -3,22 +3,117 @@
  * Do not make direct changes to the file.
  */
 interface paths {
-    "/api/v1/example": {
-        /** example */
-        get: operations["V1Example"];
+    "/api/campaigns": {
+        /** キャンペーン一覧を取得する */
+        get: operations["GetCampaigns"];
     };
 }
 type webhooks = Record<string, never>;
 interface components {
     schemas: {
         /**
-         * Example
+         * GetCampaigns
          * @example {
-         *   "value": "value"
+         *   "pagination": {
+         *     "nextPage": 7,
+         *     "isLastPage": true,
+         *     "totalPages": 6,
+         *     "prevPage": 2,
+         *     "totalCount": 1,
+         *     "currentPage": 5,
+         *     "isFirstPage": true,
+         *     "currentPerPage": 5
+         *   },
+         *   "campaigns": [
+         *     {
+         *       "lastEditorName": "lastEditorName",
+         *       "deliveryAt": "2000-01-23T04:56:07.000Z",
+         *       "lastEditedAt": "2000-01-23T04:56:07.000Z",
+         *       "id": 0,
+         *       "title": "title",
+         *       "type": "curationMailMagazine",
+         *       "status": "draft"
+         *     },
+         *     {
+         *       "lastEditorName": "lastEditorName",
+         *       "deliveryAt": "2000-01-23T04:56:07.000Z",
+         *       "lastEditedAt": "2000-01-23T04:56:07.000Z",
+         *       "id": 0,
+         *       "title": "title",
+         *       "type": "curationMailMagazine",
+         *       "status": "draft"
+         *     }
+         *   ]
          * }
          */
-        ExampleModel: {
-            value: string;
+        GetCampaigns: {
+            campaigns: components["schemas"]["Campaign"][];
+            pagination: components["schemas"]["Pagination"];
+        };
+        /**
+         * Campaign
+         * @example {
+         *   "lastEditorName": "lastEditorName",
+         *   "deliveryAt": "2000-01-23T04:56:07.000Z",
+         *   "lastEditedAt": "2000-01-23T04:56:07.000Z",
+         *   "id": 0,
+         *   "title": "title",
+         *   "type": "curationMailMagazine",
+         *   "status": "draft"
+         * }
+         */
+        Campaign: {
+            id: number;
+            title?: string | null;
+            status: components["schemas"]["CampaignStatus"];
+            type: components["schemas"]["CampaignType"];
+            /** Format: date-time */
+            deliveryAt: string | null;
+            lastEditorName: string;
+            /** Format: date-time */
+            lastEditedAt: string;
+        };
+        /**
+         * CampaignStatus
+         * @enum {string}
+         */
+        CampaignStatus: "draft" | "scheduled" | "delivering" | "delivered" | "deliveryFailed";
+        /**
+         * CampaignType
+         * @enum {string}
+         */
+        CampaignType: "curationMailMagazine" | "personalizedMailMagazine";
+        /**
+         * Pagination
+         * @description ページネーション
+         * @example {
+         *   "nextPage": 7,
+         *   "isLastPage": true,
+         *   "totalPages": 6,
+         *   "prevPage": 2,
+         *   "totalCount": 1,
+         *   "currentPage": 5,
+         *   "isFirstPage": true,
+         *   "currentPerPage": 5
+         * }
+         */
+        Pagination: {
+            /** @description 合計ページ */
+            totalPages: number;
+            /** @description 合計件数 */
+            totalCount: number;
+            /** @description 1ページあたりのレコード数 */
+            currentPerPage: number;
+            /** @description 現在のページ */
+            currentPage: number;
+            /** @description 前のページ */
+            prevPage: number | null;
+            /** @description 次のページ */
+            nextPage: number | null;
+            /** @description 最初のページかどうか */
+            isFirstPage: boolean;
+            /** @description 最後のページかどうか */
+            isLastPage: boolean;
         };
     };
     responses: never;
@@ -30,13 +125,23 @@ interface components {
 type $defs = Record<string, never>;
 type external = Record<string, never>;
 interface operations {
-    /** example */
-    V1Example: {
+    /** キャンペーン一覧を取得する */
+    GetCampaigns: {
+        parameters: {
+            query?: {
+                title?: string;
+                status?: components["schemas"]["CampaignStatus"];
+                type?: components["schemas"]["CampaignType"];
+                deliveryAtFrom?: string;
+                deliveryAtTo?: string;
+                page?: number;
+            };
+        };
         responses: {
             /** @description OK */
             200: {
                 content: {
-                    "application/json": components["schemas"]["ExampleModel"];
+                    "application/json": components["schemas"]["GetCampaigns"];
                 };
             };
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readyfor/api-client-pigeon",
-  "version": "0.163.0",
+  "version": "0.164.0-pr923.5bcb86f",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -20,11 +20,7 @@
       "require": "./dist/hooks/index.js"
     }
   },
-  "scripts": {
-    "build": "tsup"
-  },
   "devDependencies": {
-    "@readyfor/api-client-base": "0.163.0",
     "@types/qs": "6.9.17",
     "@types/react": "^18.3.12",
     "@types/use-sync-external-store": "0.0.6",
@@ -32,15 +28,16 @@
     "react": "^18.3.1",
     "swr": "^2.2.5",
     "use-sync-external-store": "^1.2.2",
-    "zod": "^3.24.1"
+    "zod": "^3.24.1",
+    "@readyfor/api-client-base": "0.164.0-pr923.5bcb86f"
   },
   "peerDependencies": {
-    "@readyfor/api-client-base": "*",
     "qs": "^6",
     "react": "^18",
     "swr": "^2",
     "use-sync-external-store": "1.2.2",
-    "zod": "^3"
+    "zod": "^3",
+    "@readyfor/api-client-base": "0.164.0-pr923.5bcb86f"
   },
   "peerDependenciesMeta": {
     "react": {
@@ -65,5 +62,7 @@
       "src"
     ]
   },
-  "gitHead": "43b05563c339eb1ad167636d1a51c544652742fa"
-}
+  "scripts": {
+    "build": "tsup"
+  }
+}

package/dist/chunk-77MRBHHK.mjs

@@ -1,7 +0,0 @@
-// src/components.ts
-import { z } from "zod";
-var ExampleModel = z.object({ value: z.string() });
-
-export {
-  ExampleModel
-};

package/dist/chunk-HJ4QTN4K.mjs

@@ -1,42 +0,0 @@
-import {
-  buildV1ExampleGetFetcher
-} from "./chunk-R5STKOXL.mjs";
-
-// src/hooks/useV1Example.ts
-import useSWRImmutable from "swr/immutable";
-import useSWRInfinite from "swr/infinite";
-import useSWR from "swr";
-import { __internal__requestUrl } from "@readyfor/api-client-base";
-import { useRequestInit } from "@readyfor/api-client-base/react";
-var v1ExampleGetFetcher = buildV1ExampleGetFetcher();
-var useV1Example = (swrConfig) => {
-  const key = __internal__requestUrl("/api/v1/example");
-  const requestInit = useRequestInit();
-  const result = useSWR(
-    swrConfig?.shouldNotFetch ? null : key,
-    buildV1ExampleGetFetcher(requestInit),
-    swrConfig
-  );
-  return { key, ...result };
-};
-var useV1ExampleImmutable = (swrConfig) => {
-  const key = __internal__requestUrl("/api/v1/example");
-  const requestInit = useRequestInit();
-  const result = useSWRImmutable(
-    swrConfig?.shouldNotFetch ? null : key,
-    buildV1ExampleGetFetcher(requestInit),
-    swrConfig
-  );
-  return { key, ...result };
-};
-var useV1ExampleInfinite = (getKey, swrConfig) => useSWRInfinite(
-  getKey(() => __internal__requestUrl()),
-  v1ExampleGetFetcher,
-  swrConfig
-);
-
-export {
-  useV1Example,
-  useV1ExampleImmutable,
-  useV1ExampleInfinite
-};

package/dist/chunk-R5STKOXL.mjs

@@ -1,19 +0,0 @@
-import {
-  ExampleModel
-} from "./chunk-77MRBHHK.mjs";
-
-// src/fetch/v1Example.ts
-import {
-  createJsonFetcher,
-  __internal__requestUrl
-} from "@readyfor/api-client-base";
-var buildV1ExampleGetFetcher = (requestInit) => createJsonFetcher(ExampleModel, { ...requestInit });
-var getV1Example = (requestInit) => buildV1ExampleGetFetcher()(__internal__requestUrl("/api/v1/example"), {
-  ...requestInit,
-  method: "GET"
-});
-
-export {
-  buildV1ExampleGetFetcher,
-  getV1Example
-};

package/dist/fetch/v1Example.d.mts

@@ -1,12 +0,0 @@
-import { paths } from '../schemaType.mjs';
-
-type V1ExampleGetOperation = paths["/api/v1/example"]["get"];
-type V1ExampleGetResponse = V1ExampleGetOperation["responses"]["200"]["content"]["application/json"];
-declare const buildV1ExampleGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
-    value: string;
-}>;
-declare const getV1Example: (requestInit?: RequestInit) => Promise<{
-    value: string;
-}>;
-
-export { type V1ExampleGetResponse, buildV1ExampleGetFetcher, getV1Example };

package/dist/fetch/v1Example.d.ts

@@ -1,12 +0,0 @@
-import { paths } from '../schemaType.js';
-
-type V1ExampleGetOperation = paths["/api/v1/example"]["get"];
-type V1ExampleGetResponse = V1ExampleGetOperation["responses"]["200"]["content"]["application/json"];
-declare const buildV1ExampleGetFetcher: (requestInit?: RequestInit) => (input: RequestInfo, requestInit?: RequestInit) => Promise<{
-    value: string;
-}>;
-declare const getV1Example: (requestInit?: RequestInit) => Promise<{
-    value: string;
-}>;
-
-export { type V1ExampleGetResponse, buildV1ExampleGetFetcher, getV1Example };

package/dist/fetch/v1Example.js

@@ -1,43 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/fetch/v1Example.ts
-var v1Example_exports = {};
-__export(v1Example_exports, {
-  buildV1ExampleGetFetcher: () => buildV1ExampleGetFetcher,
-  getV1Example: () => getV1Example
-});
-module.exports = __toCommonJS(v1Example_exports);
-var import_api_client_base = require("@readyfor/api-client-base");
-
-// src/components.ts
-var import_zod = require("zod");
-var ExampleModel = import_zod.z.object({ value: import_zod.z.string() });
-
-// src/fetch/v1Example.ts
-var buildV1ExampleGetFetcher = (requestInit) => (0, import_api_client_base.createJsonFetcher)(ExampleModel, { ...requestInit });
-var getV1Example = (requestInit) => buildV1ExampleGetFetcher()((0, import_api_client_base.__internal__requestUrl)("/api/v1/example"), {
-  ...requestInit,
-  method: "GET"
-});
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  buildV1ExampleGetFetcher,
-  getV1Example
-});

package/dist/fetch/v1Example.mjs

@@ -1,9 +0,0 @@
-import {
-  buildV1ExampleGetFetcher,
-  getV1Example
-} from "../chunk-R5STKOXL.mjs";
-import "../chunk-77MRBHHK.mjs";
-export {
-  buildV1ExampleGetFetcher,
-  getV1Example
-};

package/dist/hooks/useV1Example.d.mts

@@ -1,37 +0,0 @@
-import * as swr_infinite from 'swr/infinite';
-import { SWRInfiniteKeyLoader, SWRInfiniteConfiguration } from 'swr/infinite';
-import * as swr from 'swr';
-import { Arguments } from 'swr';
-import { Configuration } from '@readyfor/api-client-base/react';
-import { V1ExampleGetResponse } from '../fetch/v1Example.mjs';
-import '../schemaType.mjs';
-
-declare const useV1Example: (swrConfig?: Configuration<V1ExampleGetResponse>) => {
-    data: {
-        value: string;
-    } | undefined;
-    error: any;
-    mutate: swr.KeyedMutator<{
-        value: string;
-    }>;
-    isValidating: boolean;
-    isLoading: boolean;
-    key: string;
-};
-declare const useV1ExampleImmutable: (swrConfig?: Configuration<V1ExampleGetResponse>) => {
-    data: {
-        value: string;
-    } | undefined;
-    error: any;
-    mutate: swr.KeyedMutator<{
-        value: string;
-    }>;
-    isValidating: boolean;
-    isLoading: boolean;
-    key: string;
-};
-declare const useV1ExampleInfinite: <Args extends Arguments>(getKey: (keyBuilder: () => string) => SWRInfiniteKeyLoader<V1ExampleGetResponse, Args>, swrConfig?: SWRInfiniteConfiguration<V1ExampleGetResponse>) => swr_infinite.SWRInfiniteResponse<{
-    value: string;
-}, any>;
-
-export { useV1Example, useV1ExampleImmutable, useV1ExampleInfinite };

package/dist/hooks/useV1Example.d.ts

@@ -1,37 +0,0 @@
-import * as swr_infinite from 'swr/infinite';
-import { SWRInfiniteKeyLoader, SWRInfiniteConfiguration } from 'swr/infinite';
-import * as swr from 'swr';
-import { Arguments } from 'swr';
-import { Configuration } from '@readyfor/api-client-base/react';
-import { V1ExampleGetResponse } from '../fetch/v1Example.js';
-import '../schemaType.js';
-
-declare const useV1Example: (swrConfig?: Configuration<V1ExampleGetResponse>) => {
-    data: {
-        value: string;
-    } | undefined;
-    error: any;
-    mutate: swr.KeyedMutator<{
-        value: string;
-    }>;
-    isValidating: boolean;
-    isLoading: boolean;
-    key: string;
-};
-declare const useV1ExampleImmutable: (swrConfig?: Configuration<V1ExampleGetResponse>) => {
-    data: {
-        value: string;
-    } | undefined;
-    error: any;
-    mutate: swr.KeyedMutator<{
-        value: string;
-    }>;
-    isValidating: boolean;
-    isLoading: boolean;
-    key: string;
-};
-declare const useV1ExampleInfinite: <Args extends Arguments>(getKey: (keyBuilder: () => string) => SWRInfiniteKeyLoader<V1ExampleGetResponse, Args>, swrConfig?: SWRInfiniteConfiguration<V1ExampleGetResponse>) => swr_infinite.SWRInfiniteResponse<{
-    value: string;
-}, any>;
-
-export { useV1Example, useV1ExampleImmutable, useV1ExampleInfinite };

package/dist/hooks/useV1Example.mjs

@@ -1,13 +0,0 @@
-import {
-  useV1Example,
-  useV1ExampleImmutable,
-  useV1ExampleInfinite
-} from "../chunk-HJ4QTN4K.mjs";
-import "../chunk-WY7GF7TX.mjs";
-import "../chunk-R5STKOXL.mjs";
-import "../chunk-77MRBHHK.mjs";
-export {
-  useV1Example,
-  useV1ExampleImmutable,
-  useV1ExampleInfinite
-};