@tembo-io/sdk 0.2.2 → 0.3.0

package/dist/cjs/resources/projects/schedules.d.ts

@@ -0,0 +1,304 @@
+import { APIResource } from '../../resource';
+import { APIPromise } from '../../api-promise';
+import type { RequestOptions } from '../../internal/request-options';
+export declare class Schedules extends APIResource {
+    /**
+     * List schedules linked to a project.
+     *
+     * @param {string} projectID
+     * @param {ScheduleListParams} [query] - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleListResponse>} List project schedules
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.list('projectId', {
+     *   limit: 50,
+     * });
+     * ```
+     */
+    list(projectID: string, query?: ScheduleListParams | null | undefined, options?: RequestOptions): APIPromise<ScheduleListResponse>;
+    /**
+     * Create a recurring project build schedule.
+     *
+     * @param {string} projectID
+     * @param {ScheduleCreateParams} body - The request body to send.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleCreateResponse>} Create a project schedule
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.create('projectId', {
+     *   cron: 'x',
+     * });
+     * ```
+     */
+    create(projectID: string, body: ScheduleCreateParams, options?: RequestOptions): APIPromise<ScheduleCreateResponse>;
+    /**
+     * Retrieve one project build schedule.
+     *
+     * @param {string} scheduleID
+     * @param {ScheduleRetrieveParams} params - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleRetrieveResponse>} Retrieve a project schedule
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.retrieve('scheduleId', {
+     *   projectId: 'projectId',
+     * });
+     * ```
+     */
+    retrieve(scheduleID: string, params: ScheduleRetrieveParams, options?: RequestOptions): APIPromise<ScheduleRetrieveResponse>;
+    /**
+     * Update timing or enabled state for a project schedule.
+     *
+     * @param {string} scheduleID
+     * @param {ScheduleUpdateParams} params - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleUpdateResponse>} Update a project schedule
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.update('scheduleId', {
+     *   projectId: 'projectId',
+     * });
+     * ```
+     */
+    update(scheduleID: string, params: ScheduleUpdateParams, options?: RequestOptions): APIPromise<ScheduleUpdateResponse>;
+    /**
+     * Disable a project build schedule.
+     *
+     * @param {string} scheduleID
+     * @param {ScheduleDeleteParams} params - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleDeleteResponse>} Delete a project schedule
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.delete('scheduleId', {
+     *   projectId: 'projectId',
+     * });
+     * ```
+     */
+    delete(scheduleID: string, params: ScheduleDeleteParams, options?: RequestOptions): APIPromise<ScheduleDeleteResponse>;
+}
+export interface ScheduleListParams {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    cursor?: string;
+    /**
+     * @default 50
+     */
+    limit?: string | number;
+}
+export interface ScheduleListResponse {
+    items: Array<ScheduleListResponse.Item>;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    nextCursor: string | null;
+}
+export declare namespace ScheduleListResponse {
+    interface Item {
+        /**
+         * @format date-time
+         */
+        createdAt: string;
+        cron: string;
+        /**
+         * @format date-time
+         */
+        enabledAt: string | null;
+        /**
+         * @minLength 1
+         * @maxLength 255
+         */
+        id: string;
+        /**
+         * @format date-time
+         */
+        lastRunAt: string | null;
+        /**
+         * @format date-time
+         */
+        nextRunAt: string | null;
+        timezone: string | null;
+        /**
+         * @format date-time
+         */
+        updatedAt: string;
+        /**
+         * @minLength 1
+         * @maxLength 255
+         */
+        projectId: string;
+    }
+}
+export interface ScheduleCreateParams {
+    /**
+     * @minLength 1
+     * @maxLength 120
+     */
+    cron: string;
+    /**
+     * @minLength 1
+     * @maxLength 100
+     */
+    timezone?: string;
+}
+export interface ScheduleCreateResponse {
+    /**
+     * @format date-time
+     */
+    createdAt: string;
+    cron: string;
+    /**
+     * @format date-time
+     */
+    enabledAt: string | null;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    id: string;
+    /**
+     * @format date-time
+     */
+    lastRunAt: string | null;
+    /**
+     * @format date-time
+     */
+    nextRunAt: string | null;
+    timezone: string | null;
+    /**
+     * @format date-time
+     */
+    updatedAt: string;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    projectId: string;
+}
+export interface ScheduleRetrieveParams {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    projectId: string;
+}
+export interface ScheduleRetrieveResponse {
+    /**
+     * @format date-time
+     */
+    createdAt: string;
+    cron: string;
+    /**
+     * @format date-time
+     */
+    enabledAt: string | null;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    id: string;
+    /**
+     * @format date-time
+     */
+    lastRunAt: string | null;
+    /**
+     * @format date-time
+     */
+    nextRunAt: string | null;
+    timezone: string | null;
+    /**
+     * @format date-time
+     */
+    updatedAt: string;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    projectId: string;
+}
+export interface ScheduleUpdateParams {
+    /**
+     * Path param
+     * @minLength 1
+     * @maxLength 255
+     */
+    projectId: string;
+    /**
+     * Body param
+     * @minLength 1
+     * @maxLength 120
+     */
+    cron?: string;
+    /**
+     * Body param
+     */
+    enabled?: boolean;
+    /**
+     * Body param
+     * @minLength 1
+     * @maxLength 100
+     */
+    timezone?: string | null;
+}
+export interface ScheduleUpdateResponse {
+    /**
+     * @format date-time
+     */
+    createdAt: string;
+    cron: string;
+    /**
+     * @format date-time
+     */
+    enabledAt: string | null;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    id: string;
+    /**
+     * @format date-time
+     */
+    lastRunAt: string | null;
+    /**
+     * @format date-time
+     */
+    nextRunAt: string | null;
+    timezone: string | null;
+    /**
+     * @format date-time
+     */
+    updatedAt: string;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    projectId: string;
+}
+export interface ScheduleDeleteParams {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    projectId: string;
+}
+export interface ScheduleDeleteResponse {
+    deleted: true;
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    id: string;
+}
+export declare namespace Schedules {
+    export { type ScheduleListResponse as ScheduleListResponse, type ScheduleCreateResponse as ScheduleCreateResponse, type ScheduleRetrieveResponse as ScheduleRetrieveResponse, type ScheduleUpdateResponse as ScheduleUpdateResponse, type ScheduleDeleteResponse as ScheduleDeleteResponse, type ScheduleListParams as ScheduleListParams, type ScheduleCreateParams as ScheduleCreateParams, type ScheduleRetrieveParams as ScheduleRetrieveParams, type ScheduleUpdateParams as ScheduleUpdateParams, type ScheduleDeleteParams as ScheduleDeleteParams, };
+}
+//# sourceMappingURL=schedules.d.ts.map

package/dist/cjs/resources/projects/schedules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schedules.d.ts","sourceRoot":"","sources":["../../../../src/resources/projects/schedules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAGrE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAKvC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAQrC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAItC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACxC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAClB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,IAAI,CAAC;IACd;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AACD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/dist/cjs/resources/projects/schedules.js

@@ -0,0 +1,106 @@
+"use strict";
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schedules = void 0;
+const resource_1 = require("../../resource");
+const path_1 = require("../../internal/utils/path");
+class Schedules extends resource_1.APIResource {
+    /**
+     * List schedules linked to a project.
+     *
+     * @param {string} projectID
+     * @param {ScheduleListParams} [query] - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleListResponse>} List project schedules
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.list('projectId', {
+     *   limit: 50,
+     * });
+     * ```
+     */
+    list(projectID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/projects/${projectID}/schedules`, { query, ...options });
+    }
+    /**
+     * Create a recurring project build schedule.
+     *
+     * @param {string} projectID
+     * @param {ScheduleCreateParams} body - The request body to send.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleCreateResponse>} Create a project schedule
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.create('projectId', {
+     *   cron: 'x',
+     * });
+     * ```
+     */
+    create(projectID, body, options) {
+        return this._client.post((0, path_1.path) `/v1/projects/${projectID}/schedules`, { body, ...options });
+    }
+    /**
+     * Retrieve one project build schedule.
+     *
+     * @param {string} scheduleID
+     * @param {ScheduleRetrieveParams} params - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleRetrieveResponse>} Retrieve a project schedule
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.retrieve('scheduleId', {
+     *   projectId: 'projectId',
+     * });
+     * ```
+     */
+    retrieve(scheduleID, params, options) {
+        const { projectId } = params;
+        return this._client.get((0, path_1.path) `/v1/projects/${projectId}/schedules/${scheduleID}`, options);
+    }
+    /**
+     * Update timing or enabled state for a project schedule.
+     *
+     * @param {string} scheduleID
+     * @param {ScheduleUpdateParams} params - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleUpdateResponse>} Update a project schedule
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.update('scheduleId', {
+     *   projectId: 'projectId',
+     * });
+     * ```
+     */
+    update(scheduleID, params, options) {
+        const { projectId, ...body } = params;
+        return this._client.patch((0, path_1.path) `/v1/projects/${projectId}/schedules/${scheduleID}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Disable a project build schedule.
+     *
+     * @param {string} scheduleID
+     * @param {ScheduleDeleteParams} params - The parameters to send with the request.
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<ScheduleDeleteResponse>} Delete a project schedule
+     *
+     * @example
+     * ```ts
+     * const schedule = await client.projects.schedules.delete('scheduleId', {
+     *   projectId: 'projectId',
+     * });
+     * ```
+     */
+    delete(scheduleID, params, options) {
+        const { projectId } = params;
+        return this._client.delete((0, path_1.path) `/v1/projects/${projectId}/schedules/${scheduleID}`, options);
+    }
+}
+exports.Schedules = Schedules;
+//# sourceMappingURL=schedules.js.map

package/dist/cjs/resources/projects/schedules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schedules.js","sourceRoot":"","sources":["../../../../src/resources/projects/schedules.ts"],"names":[],"mappings":";AAAA,6EAA6E;;;AAE7E,6CAA6C;AAG7C,oDAAiE;AAEjE,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAY,EAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAY,EAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,UAAkB,EAClB,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAY,EAAA,gBAAgB,SAAS,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAkB,EAClB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAY,EAAA,gBAAgB,SAAS,cAAc,UAAU,EAAE,EAAE;YACzF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAkB,EAClB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAY,EAAA,gBAAgB,SAAS,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;CACF;AAzHD,8BAyHC"}